Mercurial > hg > octave-lyh

comparison scripts/general/subsindex.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents 265a821f6555
children 16f53d29049f
comparison
equal deleted inserted replaced
9044:656ad518f385 9051:1bf0ce0930be
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{idx} =} subsindex (@var{a}) 20 ## @deftypefn {Function File} {@var{idx} =} subsindex (@var{a})
21 ## Convert an object to an index vector. When @var{a} is a class object 21 ## Convert an object to an index vector. When @var{a} is a class object
22 ## defined with a class constructor, then @code{subsindex} is the 22 ## defined with a class constructor, then @code{subsindex} is the
23 ## overloading method that allows the conversion of this class object to 23 ## overloading method that allows the conversion of this class object to
24 ## a valid indexing vector. It is important to note that 24 ## a valid indexing vector. It is important to note that
25 ## @code{subsindex} must return a zero-based real integer vector of the 25 ## @code{subsindex} must return a zero-based real integer vector of the
26 ## class "double". For example, if the class constructor 26 ## class "double". For example, if the class constructor
27 ## 27 ##
28 ## @example 28 ## @example
29 ## @group 29 ## @group
30 ## function b = myclass (a) 30 ## function b = myclass (a)
31 ## b = myclass (struct ("a", a), "myclass"); 31 ## b = myclass (struct ("a", a), "myclass");