Mercurial > octave

annotate scripts/miscellaneous/namelengthmax.m @ 31706:597f3ee61a48 stable

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
author John W. Eaton <jwe@octave.org>
date Fri, 06 Jan 2023 13:11:27 -0500
parents 5d3faba0342e
children 2e484f9f1f18
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
31706
597f3ee61a48 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 30875
diff changeset
3 ## Copyright (C) 2008-2023 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
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ##
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## This file is part of Octave.
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
10 ## 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
11 ## 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
12 ## 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
13 ## (at your option) any later version.
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## 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
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
18 ## GNU General Public License for more details.
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ##
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## 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
21 ## 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
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
7628
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
25
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ## -*- texinfo -*-
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
27 ## @deftypefn {} {@var{n} =} namelengthmax ()
19192
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
28 ## 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
29 ##
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
30 ## 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
31 ## 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
32 ## 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
33 ## @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
34 ## 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
35 ## @end deftypefn
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
36
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 function n = namelengthmax ()
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
38 n = 63;
acca752a3b96 Add the namelengthmax function
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 endfunction
13761
2d574194718c namelengthmax.m: Consolidate docstring by using @math macro. Add %!test.
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
40
2d574194718c namelengthmax.m: Consolidate docstring by using @math macro. Add %!test.
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
41
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
42 %!assert (namelengthmax (), 63)