octave_packages/m/miscellaneous/namelengthmax.m

   1 ## Copyright (C) 2008-2012 David Bateman
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} namelengthmax ()
  21 ## Return the @sc{matlab} compatible maximum variable name length.  Octave is
  22 ## capable of storing strings up to @math{2^{31} - 1} in length.
  23 ## However for @sc{matlab} compatibility all variable, function,
  24 ## and structure field names should be shorter than the length supplied by
  25 ## @code{namelengthmax}.  In particular variables stored to a @sc{matlab} file
  26 ## format will have their names truncated to this length.
  27 ## @end deftypefn
  28
  29 function n = namelengthmax ()
  30   n = 63;
  31 endfunction
  32
  33
  34 %!assert (namelengthmax, 63)