Mercurial > octave-nkf

comparison libinterp/corefcn/sparse.cc @ 20207:4f45eaf83908 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed libinterp/corefcn directory. * libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc, libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc, libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc, libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, scripts/polynomial/spline.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 17:19:30 -0700
parents 4197fc428c7d
children dd6345fd8a97
comparison
equal deleted inserted replaced
20206:b70f8da6dcd3 20207:4f45eaf83908
63 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n})\n\ 63 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n})\n\
64 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv})\n\ 64 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv})\n\
65 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{m}, @var{n})\n\ 65 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{m}, @var{n})\n\
66 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, \"unique\")\n\ 66 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, \"unique\")\n\
67 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n}, @var{nzmax})\n\ 67 @deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n}, @var{nzmax})\n\
68 Create a sparse matrix from a full matrix or row, column, value triplets.\n\ 68 Create a sparse matrix from a full matrix, or row, column, value triplets.\n\
69 \n\ 69 \n\
70 If @var{a} is a full matrix, convert it to a sparse matrix representation,\n\ 70 If @var{a} is a full matrix, convert it to a sparse matrix representation,\n\
71 removing all zero values in the process.\n\ 71 removing all zero values in the process.\n\
72 \n\ 72 \n\
73 Given the integer index vectors @var{i} and @var{j}, and a 1-by-@code{nnz}\n\ 73 Given the integer index vectors @var{i} and @var{j}, and a 1-by-@code{nnz}\n\
99 \n\ 99 \n\
100 @example\n\ 100 @example\n\
101 @group\n\ 101 @group\n\
102 @var{i} = [1 1 2]; @var{j} = [1 1 2]; @var{sv} = [3 4 5];\n\ 102 @var{i} = [1 1 2]; @var{j} = [1 1 2]; @var{sv} = [3 4 5];\n\
103 sparse (@var{i}, @var{j}, @var{sv}, 3, 4)\n\ 103 sparse (@var{i}, @var{j}, @var{sv}, 3, 4)\n\
104 @result{} \n\ 104 @result{}\n\
105 Compressed Column Sparse (rows = 3, cols = 4, nnz = 2 [17%])\n\ 105 Compressed Column Sparse (rows = 3, cols = 4, nnz = 2 [17%])\n\
106 \n\ 106 \n\
107 (1, 1) -> 7\n\ 107 (1, 1) -> 7\n\
108 (2, 2) -> 5\n\ 108 (2, 2) -> 5\n\
109 @end group\n\ 109 @end group\n\
113 \n\ 113 \n\
114 @example\n\ 114 @example\n\
115 @group\n\ 115 @group\n\
116 @var{i} = [1 1 2]; @var{j} = [1 1 2]; @var{sv} = [3 4 5];\n\ 116 @var{i} = [1 1 2]; @var{j} = [1 1 2]; @var{sv} = [3 4 5];\n\
117 sparse (@var{i}, @var{j}, @var{sv}, 3, 4, \"unique\")\n\ 117 sparse (@var{i}, @var{j}, @var{sv}, 3, 4, \"unique\")\n\
118 @result{} \n\ 118 @result{}\n\
119 Compressed Column Sparse (rows = 3, cols = 4, nnz = 2 [17%])\n\ 119 Compressed Column Sparse (rows = 3, cols = 4, nnz = 2 [17%])\n\
120 \n\ 120 \n\
121 (1, 1) -> 4\n\ 121 (1, 1) -> 4\n\
122 (2, 2) -> 5\n\ 122 (2, 2) -> 5\n\
123 @end group\n\ 123 @end group\n\