Mercurial > octave-antonio

annotate scripts/general/subsindex.m @ 20158:7503499a252b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update docstrings to have one sentence summary as first line. Update scripts in audio, elfun, general, geometry, and image directories. * scripts/audio/@audioplayer/__get_properties__.m, scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m, scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m, scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m, scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m, scripts/audio/@audiorecorder/audiorecorder.m, scripts/audio/@audiorecorder/get.m, scripts/audio/@audiorecorder/getaudiodata.m, scripts/audio/@audiorecorder/getplayer.m, scripts/audio/@audiorecorder/isrecording.m, scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m, scripts/audio/@audiorecorder/recordblocking.m, scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m, scripts/audio/@audiorecorder/subsasgn.m, scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m, scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m, scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m, scripts/general/accumarray.m, scripts/general/accumdim.m, scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m, scripts/general/blkdiag.m, scripts/general/cart2pol.m, scripts/general/cart2sph.m, scripts/general/cell2mat.m, scripts/general/celldisp.m, scripts/general/chop.m, scripts/general/circshift.m, scripts/general/common_size.m, scripts/general/cplxpair.m, scripts/general/cumtrapz.m, scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/divergence.m, scripts/general/fieldnames.m, scripts/general/flip.m, scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m, scripts/general/gradient.m, scripts/general/interp3.m, scripts/general/interpft.m, scripts/general/interpn.m, scripts/general/loadobj.m, scripts/general/logspace.m, scripts/general/methods.m, scripts/general/nargchk.m, scripts/general/narginchk.m, scripts/general/nargoutchk.m, scripts/general/nextpow2.m, scripts/general/nthargout.m, scripts/general/num2str.m, scripts/general/pol2cart.m, scripts/general/polyarea.m, scripts/general/postpad.m, scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m, scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m, scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m, scripts/general/shiftdim.m, scripts/general/sortrows.m, scripts/general/sph2cart.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/trapz.m, scripts/general/triplequad.m, scripts/geometry/delaunayn.m, scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m, scripts/geometry/rectint.m, scripts/geometry/tsearchn.m, scripts/geometry/voronoi.m, scripts/geometry/voronoin.m, scripts/help/__unimplemented__.m, scripts/help/doc.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m, scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m, scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m, scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m, scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m, scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m, scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m, scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m, scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m, scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m, scripts/image/white.m, scripts/image/winter.m: Update docstrings to have one sentence summary as first line. Re-structure to have line lengths <= 80 chars.
author Rik <rik@octave.org>
date Sun, 03 May 2015 09:36:20 -0700
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
1 ## Copyright (C) 2008-2015 David Bateman
8154
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{idx} =} subsindex (@var{a})
20158
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
21 ## Convert an object to an index vector.
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
22 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
23 ## When @var{a} is a class object defined with a class constructor, then
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
24 ## @code{subsindex} is the overloading method that allows the conversion of
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
25 ## this class object to a valid indexing vector. It is important to note that
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
26 ## @code{subsindex} must return a zero-based real integer vector of the class
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 ## @qcode{"double"}. For example, if the class constructor
8154
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 ## @example
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ## @group
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 ## function b = myclass (a)
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
32 ## b = class (struct ("a", a), "myclass");
8154
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 ## endfunction
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 ## @end group
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 ## @end example
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 ## @noindent
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
38 ## then the @code{subsindex} function
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 ## @example
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 ## @group
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 ## function idx = subsindex (a)
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
43 ## idx = double (a.a) - 1.0;
8154
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
44 ## endfunction
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 ## @end group
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 ## @end example
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
48 ## @noindent
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
49 ## can then be used as follows
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
51 ## @example
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
52 ## @group
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
53 ## a = myclass (1:4);
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
54 ## b = 1:10;
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
55 ## b(a)
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
56 ## @result{} 1 2 3 4
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
57 ## @end group
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
58 ## @end example
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
59 ##
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
60 ## @seealso{class, subsref, subsasgn}
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 ## @end deftypefn
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
62
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
63 function idx = subsindex (a)
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
64 error ("subsindex: not defined for class \"%s\"", class (a));
8154
265a821f6555 Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
65 endfunction
11264
79b77d71d01e subsindex.m: Fix typo in doc-string.
Ben Abbott <bpabbott@mac.com>
parents: 9245
diff changeset
66