Mercurial > forge

annotate main/sparsersb/doc/sparsersb.txt @ 12639:061284acaabd octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
oops: s/correspondent/corresponding/g
author michelemartone
date Thu, 18 Jun 2015 08:23:13 +0000
parents 76d554668a8f
children a95bee17f7fd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8849
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
1
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
2 -- Loadable Function: S = sparsersb (A)
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
3 Create a sparse RSB matrix from the full matrix A.
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
4
11587
b0dc1a40bf8a error messages on invalid attempts of using library/matrix get/set options.
michelemartone
parents: 11482
diff changeset
5 -- Loadable Function: [S, NROWS, NCOLS, NNZ, REPINFO, FIELD, SYMMETRY]
11597
b3a2cfb1a0c1 fixed a bug (calling sparsersb with 1 arg caused segfault).
michelemartone
parents: 11596
diff changeset
6 = sparsersb (MTXFILENAME, MTXTYPESTRING)
8849
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
7 Create a sparse RSB matrix by loading the Matrix Market matrix
11597
b3a2cfb1a0c1 fixed a bug (calling sparsersb with 1 arg caused segfault).
michelemartone
parents: 11596
diff changeset
8 file named MTXFILENAME. The optional argument MTXTYPESTRING can
b3a2cfb1a0c1 fixed a bug (calling sparsersb with 1 arg caused segfault).
michelemartone
parents: 11596
diff changeset
9 specify either real ("D") or complex ("Z") type. Default is real.
b3a2cfb1a0c1 fixed a bug (calling sparsersb with 1 arg caused segfault).
michelemartone
parents: 11596
diff changeset
10 In the case MTXFILENAME is "?", a string listing the available
11598
e07519024b37 extendend matrix market reading support to unidimensional vectors as well.
michelemartone
parents: 11597
diff changeset
11 numerical types with BLAS-style characters will be returned. If
e07519024b37 extendend matrix market reading support to unidimensional vectors as well.
michelemartone
parents: 11597
diff changeset
12 the file turns out to contain a Matrix Market vector, this will be
e07519024b37 extendend matrix market reading support to unidimensional vectors as well.
michelemartone
parents: 11597
diff changeset
13 loaded as such.
8849
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
14
12395
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
15 -- Loadable Function: sparsersb (A,"save",MTXFILENAME)
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
16 Saves a sparse RSB matrix as a Matrix Market matrix file named
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
17 MTXFILENAME.
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
18
8849
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
19 -- Loadable Function: S = sparsersb (I, J, SV, M, N, NZMAX)
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
20 Create a sparse RSB matrix given integer index vectors I and J, a
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
21 1-by-`nnz' vector of real of complex values SV, overall dimensions
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
22 M and N of the sparse matrix. The argument `nzmax' is ignored but
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
23 accepted for compatibility with MATLAB.
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
24
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
25 *Note*: if multiple values are specified with the same I, J
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
26 indices, the corresponding values in S will be added.
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
27
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
28 The following are all equivalent:
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
29
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
30 s = sparsersb (i, j, s, m, n)
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
31 s = sparsersb (i, j, s, m, n, "summation")
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
32 s = sparsersb (i, j, s, m, n, "sum")
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
33
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
34 -- Loadable Function: S = sparsersb (I, J, S, M, N, "unique")
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
35 Same as above, except that if more than two values are specified
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
36 for the same I, J indices, the last specified value will be used.
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
37
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
38 -- Loadable Function: S = sparsersb (I, J, SV)
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
39 Uses `M = max (I)', `N = max (J)'
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
40
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
41 -- Loadable Function: S = sparsersb (M, N)
9563
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
42 If M and N are integers, equivalent to `sparsersb ([], [], [], M,
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
43 N, 0)'
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
44
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
45 -- Loadable Function: S = sparsersb ("set", OPN, OPV)
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
46 If OPN is a string representing a valid librsb option name and OPV
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
47 is a string representing a valid librsb option value, the
12639
061284acaabd oops: s/correspondent/corresponding/g
michelemartone
parents: 12538
diff changeset
48 corresponding librsb option will be set to that value.
11482
0a9d22a815fb description file update.
michelemartone
parents: 9563
diff changeset
49
0a9d22a815fb description file update.
michelemartone
parents: 9563
diff changeset
50 -- Loadable Function: S = sparsersb (A, "get", MIF)
0a9d22a815fb description file update.
michelemartone
parents: 9563
diff changeset
51 If MIF is a string specifying a valid librsb matrix info string
11587
b0dc1a40bf8a error messages on invalid attempts of using library/matrix get/set options.
michelemartone
parents: 11482
diff changeset
52 (valid for librsb's rsb_mtx_get_info_from_string()), then the
12639
061284acaabd oops: s/correspondent/corresponding/g
michelemartone
parents: 12538
diff changeset
53 corresponding value will be returned for matrix A. If MIF is the
11587
b0dc1a40bf8a error messages on invalid attempts of using library/matrix get/set options.
michelemartone
parents: 11482
diff changeset
54 an empty string (""), matrix structure information will be
b0dc1a40bf8a error messages on invalid attempts of using library/matrix get/set options.
michelemartone
parents: 11482
diff changeset
55 returned.
9563
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
56
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
57 -- Loadable Function: S = sparsersb (A, S)
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
58 If A is a sparsersb matrix and S is a string, S will be
11d06cf2fb94 sparsersb: interface to rsb_set_initopt_as_string; the sparsersbbench.m will print out the evaluated command before its speedup; doc update.
michelemartone
parents: 9094
diff changeset
59 interpreted as a query string about matrix A.
8849
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
60
12395
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
61 -- Loadable Function: S = sparsersb (A,"render", FILENAME[, RWIDTH,
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
62 RHEIGHT])
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
63 If A is a sparsersb matrix and FILENAME is a string, A will be
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
64 rendered as an Encapsulated Postcript file FILENAME. Optionally,
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
65 width and height can be specified. Defaults are 512.
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
66
12538
76d554668a8f the autotune case will accept an optional output argument (to be used for the tuned matrix).
michelemartone
parents: 12395
diff changeset
67 -- Loadable Function: [O =] sparsersb (A,"autotune"[, TRANSA, NRHS,
12395
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
68 MAXR, TMAX, TN, SF])
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
69 If A is a sparsersb matrix, autotuning of the matrix will take
12538
76d554668a8f the autotune case will accept an optional output argument (to be used for the tuned matrix).
michelemartone
parents: 12395
diff changeset
70 place, with SpMV and autotuning parameters. After the "autotune"
76d554668a8f the autotune case will accept an optional output argument (to be used for the tuned matrix).
michelemartone
parents: 12395
diff changeset
71 string, the remaining parameters are optional. If giving an output
76d554668a8f the autotune case will accept an optional output argument (to be used for the tuned matrix).
michelemartone
parents: 12395
diff changeset
72 argument O, that will be assigned to the autotuned matrix, and the
76d554668a8f the autotune case will accept an optional output argument (to be used for the tuned matrix).
michelemartone
parents: 12395
diff changeset
73 input one A will remain unchanged.
12395
ae50074dd6ff activated and documented the autotuning and plot features available with librsb-1.1.
michelemartone
parents: 11598
diff changeset
74
9094
32771bd681a0 sparsersb: added a (quite informal) benchmark script, useful for benchmarking one's sparsersb/librsb functionality against octave's. slight update to documentation (removed some url from there).
michelemartone
parents: 9023
diff changeset
75 Please note that on `sparsersb' type variables are available most,
32771bd681a0 sparsersb: added a (quite informal) benchmark script, useful for benchmarking one's sparsersb/librsb functionality against octave's. slight update to documentation (removed some url from there).
michelemartone
parents: 9023
diff changeset
76 but not all of the operators available for `full' or `sparse'
32771bd681a0 sparsersb: added a (quite informal) benchmark script, useful for benchmarking one's sparsersb/librsb functionality against octave's. slight update to documentation (removed some url from there).
michelemartone
parents: 9023
diff changeset
77 typed variables.
32771bd681a0 sparsersb: added a (quite informal) benchmark script, useful for benchmarking one's sparsersb/librsb functionality against octave's. slight update to documentation (removed some url from there).
michelemartone
parents: 9023
diff changeset
78
32771bd681a0 sparsersb: added a (quite informal) benchmark script, useful for benchmarking one's sparsersb/librsb functionality against octave's. slight update to documentation (removed some url from there).
michelemartone
parents: 9023
diff changeset
79 See also: full, sparse
8849
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
80
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
81
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
82
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
83 Additional help for built-in functions and operators is
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
84 available in the on-line version of the manual. Use the command
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
85 `doc <topic>' to search the manual index.
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
86
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
87 Help and information about Octave is also available on the WWW
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
88 at http://www.octave.org and via the help@octave.org
b995a264e374 imported the project files in main/sparsersb.
michelemartone
parents:
diff changeset
89 mailing list.