Mercurial > octave-antonio
diff doc/interpreter/sparse.txi @ 7330:55f35e469c43
[project @ 2007-12-20 17:53:36 by jwe]
author | jwe |
---|---|
date | Thu, 20 Dec 2007 17:53:36 +0000 |
parents | e8d953d03f6a |
children | fe332ce262b5 |
line wrap: on
line diff
--- a/doc/interpreter/sparse.txi Thu Dec 20 16:55:26 2007 +0000 +++ b/doc/interpreter/sparse.txi Thu Dec 20 17:53:36 2007 +0000 @@ -535,9 +535,12 @@ 0 0 1 @end example -returns a full matrix as can be seen. Additionally all sparse functions -test the amount of memory occupied by the sparse matrix to see if the -amount of storage used is larger than the amount used by the full +returns a full matrix as can be seen. + + +Additionally, if @code{sparse_auto_mutate} is true, all sparse functions +test the amount of memory occupied by the sparse matrix to see if the +amount of storage used is larger than the amount used by the full equivalent. Therefore @code{speye (2) * 1} will return a full matrix as the memory used is smaller for the full version than the sparse version. @@ -564,6 +567,11 @@ always returns a sparse matrix, even if the memory used will be larger than its full representation. +@DOCSTRING(sparse_auto_mutate) + +Note that the @code{sparse_auto_mutate} option is incompatible with +@sc{Matlab}, and so it is off by default. + @node MathConsiderations, , ReturnType, Operators and Functions @subsubsection Mathematical Considerations