diff options
Diffstat (limited to 'help/en_US/prepad.xml')
-rw-r--r-- | help/en_US/prepad.xml | 52 |
1 files changed, 1 insertions, 51 deletions
diff --git a/help/en_US/prepad.xml b/help/en_US/prepad.xml index 81797e0..f79ba1d 100644 --- a/help/en_US/prepad.xml +++ b/help/en_US/prepad.xml @@ -17,57 +17,7 @@ <refnamediv> <refname>prepad</refname> - <refpurpose></refpurpose> + <refpurpose>Calling sequence:</refpurpose> </refnamediv> -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - y= prepad (x, l) - y= prepad (x, l, c) - y= prepad (x, l, c, dim) - </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 prepadded sequence.</para></listitem></varlistentry> - <varlistentry><term>c:</term> - <listitem><para>number used for prepadding.</para></listitem></varlistentry> - <varlistentry><term>dim:</term> - <listitem><para>The dimension along which the prepadding should happen.</para></listitem></varlistentry> - <varlistentry><term>y:</term> - <listitem><para>Output</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -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. - -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -prepad ([1,2], 4,0,2) -//Output: [0,0,1,2] - ]]></programlisting> -</refsection> </refentry> |