Mercurial > hg > octave-nkf

annotate scripts/deprecated/nfields.m @ 18606:fcd87f68af4f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Deprecate nfields and replace with numfields. * NEWS: Announce deprecation of nfields and addition of new function numfields. * container.txi: Add numfields to the manual. * oct-map.cc (octave_map::cat): Change %!tests to use numfields. * ov-struct.cc (Fnumfields): Function renamed from nfields. * scripts/deprecated/nfields.m: Add m-file which warns about nfields deprecation. * scripts/deprecated/module.mk: Add nfields.m to build system. * fieldnames.m: Change seealso link to point to numfields. * __isequal__.m: Use numfields to simplify code. * imwrite.m: Replace 'isempty (fieldnames (fmt))' with 'numfields (fmt) > 0' for clarity. * imageIO.m: Replace 'isempty (fieldnames (fmt))' with 'numfields (fmt) > 0' for clarity. * importdata.m: Use numfields to simplify code. * assert.m: Use numfields to simplify code.
author Rik <rik@octave.org>
date Sun, 02 Mar 2014 12:56:11 -0800
parents
children ebd27d8c63fd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18606
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
1 ## Copyright (C) 2014 Rik Wehbring
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
18
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Function File} {} nfields (@var{s})
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
21 ## Return the number of fields of the structure @var{s}.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
22 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
23 ## @strong{Warning:} @code{nfields} is scheduled for removal in version 4.6.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
24 ## Use @code{numfields} instead.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
25 ## @seealso{numfields, fieldnames}
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
26 ## @end deftypefn
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
27
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
28 function retval = nfields (varargin)
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
29
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
30 persistent warned = false;
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
31 if (! warned)
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
32 warned = true;
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
33 warning ("Octave:deprecated-function",
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
34 "nfields is obsolete and will be removed from a future version of Octave; please use numfields instead");
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
35 endif
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
36
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
37 if (nargin < 1)
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
38 print_usage ();
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
39 endif
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
40
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
41 retval = numfields (varargin{:});
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
42
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
43 endfunction
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
44