annotate scripts/general/deal.m @ 4818:ef6ae7349d59

[project @ 2004-03-04 22:10:45 by jwe]
author jwe
date Thu, 04 Mar 2004 22:10:45 +0000
parents
children de3b34644549
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4818
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1998 Ariel Tankus
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
2 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
4 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
9 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
14 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
18 ## 02111-1307, USA.
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
19
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Mapping Function} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a})
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Mapping Function} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a1}, @var{a2}, @dots{}, @var{an})
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
23 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
24 ## Copy the input parameters into the corresponding output parameters.
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
25 ## If only one input parameter is supplied, its value is copied to each
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
26 ## of the outputs.
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
27 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
28 ## For example,
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
29 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
30 ## @example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
31 ## [a, b, c] = deal (x, y, z);
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
32 ## @end example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
33 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
34 ## @noindent
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
35 ## is equivalent to
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
36 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
37 ## @example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
38 ## @group
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
39 ## a = x;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
40 ## b = y;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
41 ## c = z;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
42 ## @end group
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
43 ## @end example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
44 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
45 ## @noindent
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
46 ## and
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
47 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
48 ## @example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
49 ## [a, b, c] = deal (x);
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
50 ## @end example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
51 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
52 ## @noindent
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
53 ## is equivalent to
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
54 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
55 ## @example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
56 ## a = b = c = x;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
57 ## @end example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
58 ## @end deftypefn
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
59
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
60 ## Author: Ariel Tankus
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
61 ## Author: Paul Kienzle and Etienne Grossman
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
62 ## Created: 13.11.98
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
63 ## Adapted-by: jwe
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
64
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
65 function [varargout] = deal (varargin)
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
66
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
67 if (nargin == 0)
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
68 usage ("[a, b, c, d] = deal (x, y, z, a)");
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
69 elseif (nargin == 1)
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
70 v = varargin{1};
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
71 for i = 1:nargout
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
72 varargout{i} = v;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
73 endfor
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
74 elseif (nargin == nargout)
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
75 varargout = varargin;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
76 else
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
77 error ("deal: nargin > 1 and nargin != nargout");
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
78 endif
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
79
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
80 endfunction