Mercurial > hg > octave-nkf
view scripts/general/deal.m @ 19344:0f9c5a15c8fa
doc: Periodic grammarcheck of documentation.
* doc/interpreter/contrib.txi, doc/interpreter/expr.txi,
doc/interpreter/func.txi, doc/interpreter/linalg.txi, doc/interpreter/plot.txi,
libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/load-save.cc, libinterp/corefcn/profiler.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc,
scripts/general/deal.m, scripts/help/__gripe_missing_component__.m,
scripts/miscellaneous/desktop.m, scripts/pkg/private/default_prefix.m,
scripts/plot/appearance/__getlegenddata__.m, scripts/plot/util/pan.m,
scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m,
scripts/plot/util/zoom.m, scripts/signal/periodogram.m,
scripts/specfun/factor.m, scripts/specfun/primes.m,
scripts/statistics/base/lscov.m, scripts/testfun/private/compare_plot_demos.m,
scripts/testfun/private/dump_demos.m,
scripts/testfun/private/html_compare_plot_demos.m, scripts/testfun/test.m:
Periodic grammarcheck of documentation.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 22 Sep 2014 20:46:54 -0700 |
parents | 4fd271cd9b37 |
children | 4197fc428c7d |
line wrap: on
line source
## Copyright (C) 1998-2013 Ariel Tankus ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a}) ## @deftypefnx {Function File} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a1}, @var{a2}, @dots{}, @var{an}) ## ## Copy the input parameters into the corresponding output parameters. ## If only one input parameter is supplied, its value is copied to each ## of the outputs. ## ## For example, ## ## @example ## [a, b, c] = deal (x, y, z); ## @end example ## ## @noindent ## is equivalent to ## ## @example ## @group ## a = x; ## b = y; ## c = z; ## @end group ## @end example ## ## @noindent ## and ## ## @example ## [a, b, c] = deal (x); ## @end example ## ## @noindent ## is equivalent to ## ## @example ## a = b = c = x; ## @end example ## ## Programming Note: @code{deal} is often used with comma separated lists ## derived from cell arrays or structures. This is unnecessary as the ## interpreter can perform the same action without the overhead of a function ## call. For example: ## ## @example ## @group ## c = @{[1 2], "Three", 4@}; ## [x, y, z ] = c@{:@} ## @result{} ## x = ## ## 1 2 ## ## y = Three ## z = 4 ## @end group ## @end example ## @seealso{cell2struct, struct2cell, repmat} ## @end deftypefn ## Author: Ariel Tankus ## Author: Paul Kienzle and Etienne Grossman ## Created: 13.11.98 ## Adapted-by: jwe function [varargout] = deal (varargin) if (nargin == 0) print_usage (); elseif (nargin == 1 || nargin == nargout) varargout(1:nargout) = varargin; else error ("deal: nargin > 1 and nargin != nargout"); endif endfunction %!test %! [a,b] = deal (1,2); %! assert (a, 1); %! assert (b, 2); %!test %! [a,b] = deal (1); %! assert (a, 1); %! assert (b, 1); %!error deal () %!error <nargin . 1 and nargin != nargout> y = deal (1, 2)