octave_packages/m/general/colon.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} {@var{r} =} colon (@var{a}, @var{b})
  21 ## @deftypefnx {Function File} {@var{r} =} colon (@var{a}, @var{b}, @var{c})
  22 ## Method of a class to construct a range with the @code{:} operator.  For
  23 ## example:
  24 ##
  25 ## @example
  26 ## @group
  27 ## a = myclass (@dots{});
  28 ## b = myclass (@dots{});
  29 ## c = a : b
  30 ## @end group
  31 ## @end example
  32 ##
  33 ## @seealso{class, subsref, subsasgn}
  34 ## @end deftypefn
  35
  36 function r = colon (varargin)
  37   if (nargin != 0)
  38     error ("colon: not defined for class \"%s\"", class(varargin{1}));
  39   endif
  40 endfunction
  41
  42 %!error colon (1)
  43
  44 ## FIXME -- what does colon () mean since it doesn't set a return value?