Mercurial > octave

annotate scripts/miscellaneous/namelengthmax.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) 2008-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
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: 26376
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: 26376
diff changeset
5 ##
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ##
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## This file is part of Octave.
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 ## (at your option) any later version.
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ##
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
18 ##
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
21 ## <https://www.gnu.org/licenses/>.
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
22
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
24 ## @deftypefn {} {} namelengthmax ()
19192
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
25 ## Return the @sc{matlab} compatible maximum variable name length.
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
26 ##
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
27 ## Octave is capable of storing strings up to @math{2^{31} - 1} in length.
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
28 ## However for @sc{matlab} compatibility all variable, function, and structure
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
29 ## field names should be shorter than the length returned by
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
30 ## @code{namelengthmax}. In particular, variables stored to a @sc{matlab} file
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
31 ## format (@file{*.mat}) will have their names truncated to this length.
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 ## @end deftypefn
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
33
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 function n = namelengthmax ()
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 n = 63;
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 endfunction
13761
2d574194718c namelengthmax.m: Consolidate docstring by using @math macro. Add %!test.
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
37
2d574194718c namelengthmax.m: Consolidate docstring by using @math macro. Add %!test.
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
38
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
39 %!assert (namelengthmax (), 63)