Mercurial > octave

changeset 29929:a3ac00db296b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: disable_diagonal_matrix, disable_diagonal_matrix, and disable_range (patch #10089). * libinterp/octave-value/ov.cc (Fdisable_diagonal_matrix, Fdisable_diagonal_matrix, Fdisable_range): Clarify that the input and output arguments specify whether the corresponding special matrix types are disabled.
author José Luis García Pallero <jgpallero@gmail.com>
date Fri, 30 Jul 2021 16:54:22 +0200
parents 09b36aa7088a
children aa98b5fdfbbb 9ec1715a9aae
files libinterp/octave-value/ov.cc
diffstat 1 files changed, 21 insertions(+), 21 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/octave-value/ov.cc	Sun Jul 25 20:17:08 2021 +0200
+++ b/libinterp/octave-value/ov.cc	Fri Jul 30 16:54:22 2021 +0200
@@ -3309,15 +3309,15 @@
 @deftypefn  {} {@var{val} =} disable_permutation_matrix ()
 @deftypefnx {} {@var{old_val} =} disable_permutation_matrix (@var{new_val})
 @deftypefnx {} {} disable_permutation_matrix (@var{new_val}, "local")
-Query or set the internal variable that controls whether permutation
-matrices are stored in a special space-efficient format.
-
-The default value is true.  If this option is disabled Octave will store
+Query or set whether storing permutation matrices in a special space-efficient
+format is disabled.
+
+The default value is false.  If this option is set to true, Octave will store
 permutation matrices as full matrices.
 
-When called from inside a function with the @qcode{"local"} option, the
-variable is changed locally for the function and any subroutines it calls.
-The original variable value is restored when exiting the function.
+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{disable_range, disable_diagonal_matrix}
 @end deftypefn */)
 {
@@ -3339,15 +3339,15 @@
 @deftypefn  {} {@var{val} =} disable_diagonal_matrix ()
 @deftypefnx {} {@var{old_val} =} disable_diagonal_matrix (@var{new_val})
 @deftypefnx {} {} disable_diagonal_matrix (@var{new_val}, "local")
-Query or set the internal variable that controls whether diagonal
-matrices are stored in a special space-efficient format.
-
-The default value is true.  If this option is disabled Octave will store
+Query or set whether storing diagonal matrices in a special space-efficient
+format is disabled.
+
+The default value is false.  If this option is set to true, Octave will store
 diagonal matrices as full matrices.
 
-When called from inside a function with the @qcode{"local"} option, the
-variable is changed locally for the function and any subroutines it calls.
-The original variable value is restored when exiting the function.
+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{disable_range, disable_permutation_matrix}
 @end deftypefn */)
 {
@@ -3383,15 +3383,15 @@
 @deftypefn  {} {@var{val} =} disable_range ()
 @deftypefnx {} {@var{old_val} =} disable_range (@var{new_val})
 @deftypefnx {} {} disable_range (@var{new_val}, "local")
-Query or set the internal variable that controls whether ranges are stored
-in a special space-efficient format.
-
-The default value is true.  If this option is disabled Octave will store
+Query or set whether storing ranges in a special space-efficient format is
+disabled.
+
+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
-variable is changed locally for the function and any subroutines it calls.
-The original variable value is restored when exiting the function.
+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{disable_diagonal_matrix, disable_permutation_matrix}
 @end deftypefn */)
 {