Mercurial > forge
view main/sparsersb/doc/sparsersb.txt @ 12643:dc5803650a98 octave-forge
typo fix: s/Postcript/Postscript/g
author | michelemartone |
---|---|
date | Sun, 21 Jun 2015 14:37:10 +0000 |
parents | a95bee17f7fd |
children | 0ddee23d3d82 |
line wrap: on
line source
-- Loadable Function: S = sparsersb (A) -- Loadable Function: S = sparsersb (I, J, SV, M, N) -- Loadable Function: S = sparsersb (I, J, SV, M, N, NZMAX) -- Loadable Function: S = sparsersb (I, J, SV) -- Loadable Function: S = sparsersb (M, N) -- Loadable Function: S = sparsersb (I, J, S, M, N, "unique") -- Loadable Function: S = sparsersb ("set", OPN, OPV) -- Loadable Function: S = sparsersb (A, "get", MIF) -- Loadable Function: S = sparsersb (A, QS) -- Loadable Function: sparsersb (A,"save",MTXFILENAME) -- Loadable Function: [S, NROWS, NCOLS, NNZ, REPINFO, FIELD, SYMMETRY] = sparsersb (MTXFILENAME, MTXTYPESTRING) -- Loadable Function: S = sparsersb (A,"render", FILENAME[, RWIDTH, RHEIGHT]) -- Loadable Function: [O =] sparsersb (A,"autotune"[, TRANSA, NRHS, MAXR, TMAX, TN, SF]) Create or manipulate sparse matrices using the RSB format provided by librsb, as similarly as possible to `sparse'. If A is a full matrix, convert it to a sparse matrix representation, removing all zero values in the process. Given the integer index vectors I and J, and a 1-by-`nnz' vector of real or complex values SV, construct the sparse matrix `S(I(K),J(K)) = SV(K)' with overall dimensions M and N. The argument `NZMAX' is ignored but accepted for compatibility with MATLAB and `sparsersb'. If M or N are not specified their values are derived from the maximum index in the vectors I and J as given by `M = max (I)', `N = max (J)'. Can load a matrix from a Matrix Market matrix file named MTXFILENAME. The optional argument MTXTYPESTRING can specify either real ("D") or complex ("Z") type. Default is real. In the case MTXFILENAME is "?", a string listing the available numerical types with BLAS-style characters will be returned. If the file turns out to contain a Matrix Market dense vector, this will be loaded. If "save" is specified, saves a sparse RSB matrix as a Matrix Market matrix file named MTXFILENAME. *Note*: if multiple values are specified with the same I, J indices, the corresponding values in S will be added. The following are all equivalent: s = sparsersb (i, j, s, m, n) s = sparsersb (i, j, s, m, n, "summation") s = sparsersb (i, j, s, m, n, "sum") If the optional "unique" keyword is specified, then if more than two values are specified for the same I, J indices, only the last value will be used. `sparsersb (M, N)' will create an empty MxN sparse matrix and is equivalent to `sparsersb ([], [], [], M, N)'. If M or N are not specified, then `M = max (I)', `N = max (J)'. If OPN is a string representing a valid librsb option name and OPV is a string representing a valid librsb option value, these will be passed to the `rsb_lib_set_opt_str()' function. If MIF is a string specifying a valid librsb matrix info string (valid for librsb's `rsb_mtx_get_info_from_string()'), then the corresponding value will be returned for matrix A. If MIF is the an empty string (""), matrix structure information will be returned. If A is a sparsersb matrix and QS is a string, QS will be interpreted as a query string about matrix A. If A is a sparsersb matrix and the "render" keyword is specified, and FILENAME is a string, A will be rendered as an Encapsulated Postscript file FILENAME. Optionally, width and height can be specified in `RWIDTH, RHEIGHT'. Defaults are 512. If A is a sparsersb matrix and the "autotune" keyword is specified, autotuning of the matrix will take place, with SpMV and autotuning parameters. After the "autotune" string, the remaining parameters are optional. Parameter TRANSA specifies whether to tune for untransposed ("n") or transposed ("t"); NRHS the number of right hand sides; MAXR the number of tuning rounds; TMAX the threads to use. If giving an output argument O, that will be assigned to the autotuned matrix, and the input one A will remain unchanged. See librsb documentation for `rsb_tune_spmm' to learn more. Please note that on `sparsersb' type variables are available most, but not all of the operators available for `full' or `sparse' typed variables. See also: full, sparse Additional help for built-in functions and operators is available in the on-line version of the manual. Use the command `doc <topic>' to search the manual index. Help and information about Octave is also available on the WWW at http://www.octave.org and via the help@octave.org mailing list.