Mercurial > octave
view scripts/general/deal.m @ 30893:e1788b1a315f
maint: Use "fcn" as preferred abbreviation for "function" in m-files.
* accumarray.m, accumdim.m, quadl.m, quadv.m, randi.m, structfun.m,
__is_function__.m, uigetfile.m, uimenu.m, uiputfile.m, doc_cache_create.m,
colorspace_conversion_input_check.m, imageIO.m, argnames.m, vectorize.m,
vectorize.m, normest1.m, inputname.m, nthargout.m, display_info_file.m,
decic.m, ode15i.m, ode15s.m, ode23.m, ode23s.m, ode45.m, odeset.m,
check_default_input.m, integrate_adaptive.m, ode_event_handler.m,
runge_kutta_23.m, runge_kutta_23s.m, runge_kutta_45_dorpri.m,
runge_kutta_interpolate.m, starting_stepsize.m, __all_opts__.m, fminbnd.m,
fminsearch.m, fminunc.m, fsolve.m, fzero.m, sqp.m, fplot.m, plotyy.m,
__bar__.m, __ezplot__.m, flat_entry.html, profexport.m, movfun.m, bicg.m,
bicgstab.m, cgs.m, eigs.m, gmres.m, pcg.m, __alltohandles__.m, __sprand__.m,
qmr.m, tfqmr.m, dump_demos.m:
Replace "func", "fun", "fn" in documentation and variable names with "fcn".
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 Apr 2022 18:14:56 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 1998-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a}) ## @deftypefnx {} {[@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 a single 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 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); ## Test input validation %!error <Invalid call> deal () %!error <nargin . 1 and nargin != nargout> y = deal (1, 2)