comparison scripts/signal/ifftshift.m @ 32910:fd75534ea60e stable

doc: Miscellaneous improvements to calling forms of several functions. * oct-parse.yy (Ffeval): Add output to function calling form. * which.m: Add second calling form of function. Use @var macro around input argument. * ifftshift.m: Reverse names of input and output arguments to match fftshift.
author Rik <rik@octave.org>
date Fri, 02 Feb 2024 11:36:26 -0800
parents 2e484f9f1f18
children
comparison
equal deleted inserted replaced
32907:92e55fcc0c30 32910:fd75534ea60e
22 ## <https://www.gnu.org/licenses/>. 22 ## <https://www.gnu.org/licenses/>.
23 ## 23 ##
24 ######################################################################## 24 ########################################################################
25 25
26 ## -*- texinfo -*- 26 ## -*- texinfo -*-
27 ## @deftypefn {} {@var{y} =} ifftshift (@var{x}) 27 ## @deftypefn {} {@var{x} =} ifftshift (@var{y})
28 ## @deftypefnx {} {@var{y} =} ifftshift (@var{x}, @var{dim}) 28 ## @deftypefnx {} {@var{x} =} ifftshift (@var{y}, @var{dim})
29 ## Undo the action of the @code{fftshift} function. 29 ## Undo the action of the @code{fftshift} function.
30 ## 30 ##
31 ## For even length @var{x}, @code{fftshift} is its own inverse, but odd lengths 31 ## For even length @var{x}, @code{fftshift} is its own inverse, but odd lengths
32 ## differ slightly. 32 ## differ slightly.
33 ## @seealso{fftshift} 33 ## @seealso{fftshift}