Mercurial > octave
changeset 31445:0924234dd747 stable
sparse_auto_mutate.m: Update documentation for deprecated function.
* NEWS.8.md: Remove unneeded newline.
* sparse_auto_mutate.m: Document that this function has no effect
whatsoever.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 15 Nov 2022 18:37:58 -0800 |
parents | 2569c40924e7 |
children | 59cb8ecf9b5c 0b03473d754f |
files | etc/NEWS.8.md scripts/deprecated/sparse_auto_mutate.m |
diffstat | 2 files changed, 10 insertions(+), 17 deletions(-) [+] |
line wrap: on
line diff
--- a/etc/NEWS.8.md Tue Nov 15 17:40:23 2022 -0500 +++ b/etc/NEWS.8.md Tue Nov 15 18:37:58 2022 -0800 @@ -135,7 +135,6 @@ storage. This setting was `false` by default for compatibility with Matlab. Now you must manually convert to full storage when desired. - - Properties The following property names are discouraged, but there is no fixed
--- a/scripts/deprecated/sparse_auto_mutate.m Tue Nov 15 17:40:23 2022 -0500 +++ b/scripts/deprecated/sparse_auto_mutate.m Tue Nov 15 18:37:58 2022 -0800 @@ -29,18 +29,15 @@ ## @deftypefnx {} {@var{old_val} =} sparse_auto_mutate (@var{new_val}, "local") ## ## @code{sparse_auto_mutate} is deprecated and will be removed in Octave -## version 9. Use @code{optimize_diagonal_matrix} instead. -## -## Query or set whether storing diagonal matrices in a special space-efficient -## format is disabled. +## version 10. ## -## The default value is false. If this option is set to true, Octave will -## store ranges as full matrices. -## -## When called from inside a function with the @qcode{"local"} option, the -## setting is changed locally for the function and any subroutines it calls. -## The original setting is restored when exiting the function. -## @seealso{sparse_auto_mutate, disable_permutation_matrix} +## The @code{sparse_auto_mutate} function no longer has any effect on Octave's +## behavior. Previously, after calling @code{sparse_auto_mutate (true)}, +## Octave would automatically convert sparse matrices to full when a sparse +## matrix required more memory than simply using full matrix storage. This +## setting was false by default for compatibility with @sc{matlab}. Now you +## must manually convert to full storage when desired (use @code{full}). +## @seealso{full} ## @end deftypefn ## FIXME: DEPRECATED: Remove in version 10. @@ -55,8 +52,7 @@ endif if (nargin == 0 || nargout > 0) - ## Always false now. - retval = false; + retval = false; # Always false now. return; endif @@ -67,9 +63,7 @@ nargin = 1; endif - ## Don't bother warning that "local" is invalid outside of a - ## function. - + ## Don't bother warning that "local" is invalid outside of a function. if (nargin > 1) print_usage (); endif