diff options
author | avinashlalotra | 2025-04-26 20:09:12 +0530 |
---|---|---|
committer | avinashlalotra | 2025-04-26 20:09:12 +0530 |
commit | ea7dcdba3b83696b97cc431ee050b58f9a0f3507 (patch) | |
tree | 49ea8ba898b88535c261546f4e3accbdf4c83bdf /macros/prepad.sci | |
parent | 725d9ee2ddb254f57a896bb47e0e727759eb5901 (diff) | |
download | FOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.tar.gz FOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.tar.bz2 FOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.zip |
formated source documentation pattern for generating docs
Diffstat (limited to 'macros/prepad.sci')
-rw-r--r-- | macros/prepad.sci | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/macros/prepad.sci b/macros/prepad.sci index d3595bf..beac6a1 100644 --- a/macros/prepad.sci +++ b/macros/prepad.sci @@ -9,19 +9,18 @@ // Last Modified on : 3 Feb 2024 // Organization: FOSSEE, IIT Bombay // Email: toolbox@scilab.in -/* -Calling Sequence : - prepad (x, l) - prepad (x, l, c) - prepad (x, l, c, dim) -Prepend the scalar value c to the vector x until it is of length l. If c is not given, a value of 0 is used. -If length (x) > l, elements from the beginning of x are removed until a vector of length l is obtained. -If x is a matrix, elements are prepended or removed from each row. -If the optional argument dim is given, operate along this dimension. -If dim is larger than the dimensions of x, the result will have dim dimensions. -*/ function res = prepad(x,l,c,dim) +// Calling Sequence : +// prepad (x, l) +// prepad (x, l, c) +// prepad (x, l, c, dim) +// Prepend the scalar value c to the vector x until it is of length l. If c is not given, a value of 0 is used. +// If length (x) > l, elements from the beginning of x are removed until a vector of length l is obtained. +// If x is a matrix, elements are prepended or removed from each row. +// If the optional argument dim is given, operate along this dimension. +// If dim is larger than the dimensions of x, the result will have dim dimensions. + if nargin < 2 then error("Usage : postpad(x,l,c(optional),dim(optional))") end |