Mercurial > octave

annotate scripts/deprecated/output_max_field_width.m @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 2018-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27115
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27115
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27115
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27115
diff changeset
5 ##
26301
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
6 ##
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
7 ## This file is part of Octave.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
8 ##
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
10 ## under the terms of the GNU General Public License as published by
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
12 ## (at your option) any later version.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
13 ##
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
17 ## GNU General Public License for more details.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
18 ##
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
20 ## along with Octave; see the file COPYING. If not, see
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
21 ## <https://www.gnu.org/licenses/>.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
22
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
23 ## -*- texinfo -*-
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
24 ## @deftypefn {} {@var{val} =} output_max_field_width ()
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
25 ## @deftypefnx {} {@var{old_val} =} output_max_field_width (@var{new_val})
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
26 ## @deftypefnx {} {} output_max_field_width (@var{new_val}, "local")
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
27 ##
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
28 ## @code{output_max_field_width} is deprecated and will be removed in Octave
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
29 ## version 7. Use @code{output_precision} instead.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
30 ##
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
31 ## Query or set the internal variable that specifies the maximum width
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
32 ## of a numeric output field.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
33 ##
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
34 ## When called from inside a function with the @qcode{"local"} option, the
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
35 ## variable is changed locally for the function and any subroutines it calls.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
36 ## The original variable value is restored when exiting the function.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
37 ## @seealso{format, fixed_point_format, output_precision}
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
38 ## @end deftypefn
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
39
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
40 ## FIXME: DEPRECATED: Remove in version 7.
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
41
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
42 function retval = output_max_field_width (varargin)
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
43
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
44 persistent warned = false;
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
45 if (! warned)
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
46 warned = true;
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
47 warning ("Octave:deprecated-function",
27115
8a04f5454350 Deprecate 'runtests' function (bug #56325).
Rik <rik@octave.org>
parents: 26376
diff changeset
48 "output_max_field_width is obsolete and will be removed from a future version of Octave, please use output_precision instead\n");
26301
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
49 endif
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
50
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
51 retval = 20;
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
52
99318daeaddd Properly deprecate output_max_field_width from cset 4d945f2e5914.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
53 endfunction