annotate scripts/general/deal.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 81a73cdd87c0
children a1dbe9d80eee
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6714
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6714
diff changeset
8 ## your option) any later version.
4818
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6714
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6714
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4818
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
18
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
6714
81a73cdd87c0 [project @ 2007-06-13 10:49:28 by dbateman]
dbateman
parents: 6046
diff changeset
20 ## @deftypefn {Function File} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a})
81a73cdd87c0 [project @ 2007-06-13 10:49:28 by dbateman]
dbateman
parents: 6046
diff changeset
21 ## @deftypefnx {Function File} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a1}, @var{a2}, @dots{}, @var{an})
4818
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
22 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
23 ## Copy the input parameters into the corresponding output parameters.
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
24 ## 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
25 ## of the outputs.
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
26 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
27 ## For example,
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
28 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
29 ## @example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
30 ## [a, b, c] = deal (x, y, z);
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
31 ## @end example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
32 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
33 ## @noindent
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
34 ## is equivalent to
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
35 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
36 ## @example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
37 ## @group
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
38 ## a = x;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
39 ## b = y;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
40 ## c = z;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
41 ## @end group
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
42 ## @end example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
43 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
44 ## @noindent
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
45 ## and
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
46 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
47 ## @example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
48 ## [a, b, c] = deal (x);
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
49 ## @end example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
50 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
51 ## @noindent
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
52 ## is equivalent to
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
53 ##
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
54 ## @example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
55 ## a = b = c = x;
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
56 ## @end example
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
57 ## @end deftypefn
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
58
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
59 ## Author: Ariel Tankus
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
60 ## Author: Paul Kienzle and Etienne Grossman
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
61 ## Created: 13.11.98
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
62 ## Adapted-by: jwe
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
63
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
64 function [varargout] = deal (varargin)
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
65
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
66 if (nargin == 0)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
67 print_usage ();
4819
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
68 elseif (nargin == 1 || nargin == nargout)
4820
a436d388b041 [project @ 2004-03-05 05:58:37 by jwe]
jwe
parents: 4819
diff changeset
69 varargout(1:nargout) = varargin;
4818
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
70 else
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
71 error ("deal: nargin > 1 and nargin != nargout");
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
72 endif
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
73
ef6ae7349d59 [project @ 2004-03-04 22:10:45 by jwe]
jwe
parents:
diff changeset
74 endfunction
4819
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
75
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
76 %!test
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
77 %! [a,b]=deal(1,2);
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
78 %! assert(a,1);
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
79 %! assert(b,2);
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
80 %!test
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
81 %! [a,b]=deal(1);
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
82 %! assert(a,1);
de3b34644549 [project @ 2004-03-05 04:57:07 by jwe]
jwe
parents: 4818
diff changeset
83 %! assert(b,1);