comparison src/DLD-FUNCTIONS/sparse.cc @ 10791:3140cb7a05a1

Add spellchecker scripts for Octave and run spellcheck of documentation interpreter/doccheck: New directory for spelling/grammar scripts. interpreter/doccheck/README: Instructions for using scripts. interpreter/doccheck/spellcheck: Script to spellcheck a Texinfo file. interpreter/doccheck/aspell.conf: GNU Aspell configuration file for Octave documentation. interpreter/doccheck/aspell-octave.en.pws: Private Aspell dictionary. interpreter/doccheck/add_to_aspell_dict: Script to add new Octave-specific words to private Aspell dictionary. interpreter/octave.texi: New @nospell macro which forces Aspell to ignore the word marked by the macro. interpreter/mk_doc_cache.m: Skip new @nospell macro when building doc_cache.
author Rik <octave@nomad.inbox5.com>
date Sat, 17 Jul 2010 19:53:01 -0700
parents fbd7843974fa
children 89f4d7e294cc
comparison
equal deleted inserted replaced
10790:01f1643dfbb1 10791:3140cb7a05a1
205 } 205 }
206 206
207 DEFUN_DLD (spalloc, args, , 207 DEFUN_DLD (spalloc, args, ,
208 "-*- texinfo -*-\n\ 208 "-*- texinfo -*-\n\
209 @deftypefn {Loadable Function} {@var{s} =} spalloc (@var{m}, @var{n}, @var{nz})\n\ 209 @deftypefn {Loadable Function} {@var{s} =} spalloc (@var{m}, @var{n}, @var{nz})\n\
210 Creates a @var{m}-by-@var{n} sparse matrix with preallocated space for at most\n\ 210 Creates a @var{m}-by-@var{n} sparse matrix with pre-allocated space for at most\n\
211 @var{nz} nonzero elements. This is useful for building the matrix incrementally\n\ 211 @var{nz} nonzero elements. This is useful for building the matrix incrementally\n\
212 by a sequence of indexed assignments. Subsequent indexed assignments will reuse\n\ 212 by a sequence of indexed assignments. Subsequent indexed assignments will reuse\n\
213 the pre-allocated memory, provided they are of one of the simple forms\n\ 213 the pre-allocated memory, provided they are of one of the simple forms\n\
214 \n\ 214 \n\
215 @itemize\n\ 215 @itemize\n\
228 \n\ 228 \n\
229 Partial movement of data may still occur, but in general the assignment will be more\n\ 229 Partial movement of data may still occur, but in general the assignment will be more\n\
230 memory and time-efficient under these circumstances. In particular, it is possible\n\ 230 memory and time-efficient under these circumstances. In particular, it is possible\n\
231 to efficiently build a pre-allocated sparse matrix from contiguous block of columns.\n\ 231 to efficiently build a pre-allocated sparse matrix from contiguous block of columns.\n\
232 \n\ 232 \n\
233 The amount of preallocated memory for a given matrix may be queried using the function\n\ 233 The amount of pre-allocated memory for a given matrix may be queried using the function\n\
234 @code{nzmax}.\n\ 234 @code{nzmax}.\n\
235 @seealso{nzmax, sparse}\n\ 235 @seealso{nzmax, sparse}\n\
236 @end deftypefn") 236 @end deftypefn")
237 { 237 {
238 octave_value retval; 238 octave_value retval;