diff options
author | Sunil Shetye | 2018-07-25 16:27:51 +0530 |
---|---|---|
committer | Sunil Shetye | 2018-07-26 23:50:17 +0530 |
commit | 9ca7882cee16ad48b18df989e8300c697010e55a (patch) | |
tree | 59e0c6116b835ae3e5e3208bc9609ed2828069ed /help/en_US/postpad.xml | |
parent | 6bbb00d0f0128381ee95194cf7d008fb6504de7d (diff) | |
download | FOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.tar.gz FOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.tar.bz2 FOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.zip |
code changes by Sonu Sharma during FOSSEE Fellowship 2018
Diffstat (limited to 'help/en_US/postpad.xml')
-rw-r--r-- | help/en_US/postpad.xml | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/help/en_US/postpad.xml b/help/en_US/postpad.xml new file mode 100644 index 0000000..8c96bae --- /dev/null +++ b/help/en_US/postpad.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from postpad.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="postpad" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:scilab="http://www.scilab.org" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>postpad</refname> + <refpurpose></refpurpose> + </refnamediv> + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + Y = postpad (X, L) + Y = postpad (X, L, C) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>X:</term> + <listitem><para>Input vector or matrix of real numbers.</para></listitem></varlistentry> + <varlistentry><term>L:</term> + <listitem><para> The length of the final postpadded sequence.</para></listitem></varlistentry> + <varlistentry><term>C:</term> + <listitem><para>number used for postpadding.</para></listitem></varlistentry> + <varlistentry><term>Y:</term> + <listitem><para>Output</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> + Append the scalar value C to the vector X until it is of length L. + </para> + <para> + If C is not given, a value of 0 is used. + </para> + <para> + If 'length (X) > L', elements from the end of X are removed until a vector of length L is obtained. + </para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + x = [1 2 3]; + L = 6; + y = postpad(x, L) + ]]></programlisting> +</refsection> + + <refsection> + <title>Authors</title> + <simplelist type="vert"> + <member>Sonu Sharma, RGIT Mumbai (fellow at FOSSEE, IIT Bombay)</member> + </simplelist> + </refsection> + +</refentry> |