Mercurial > octave
view scripts/deprecated/disable_diagonal_matrix.m @ 30602:916e13929773
maint: merge stable to default.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 06 Jan 2022 14:23:03 -0800 |
parents | ed17822e7662 824c67e2bd66 |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2021-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{val} =} disable_diagonal_matrix () ## @deftypefnx {} {@var{old_val} =} disable_diagonal_matrix (@var{new_val}) ## @deftypefnx {} {@var{old_val} =} disable_diagonal_matrix (@var{new_val}, "local") ## ## @code{disable_diagonal_matrix} 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. ## ## 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{disable_diagonal_matrix, disable_permutation_matrix} ## @end deftypefn ## FIXME: DEPRECATED: Remove in version 9. function retval = disable_diagonal_matrix (varargin) persistent warned = false; if (! warned) warned = true; warning ("Octave:deprecated-function", "disable_diagonal_matrix is obsolete and will be removed from a future version of Octave, please use optimize_diagonal_matrix instead\n"); endif if (nargin == 0) retval = ! optimize_diagonal_matrix (); elseif (nargout == 0) optimize_diagonal_matrix (! varargin{1}, varargin{2:end}); else retval = ! optimize_diagonal_matrix (! varargin{1}, varargin{2:end}); endif endfunction