diff options
| author | shamikam | 2017-11-07 15:59:48 +0530 |
|---|---|---|
| committer | shamikam | 2017-11-07 15:59:48 +0530 |
| commit | c0c0582462720ed597b00e116506570577614e89 (patch) | |
| tree | 31dedd23698e5357b19c810b7d7a8464100ef44a /help/en_US/wkeep.xml | |
| download | FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.tar.gz FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.tar.bz2 FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.zip | |
initial commit
Diffstat (limited to 'help/en_US/wkeep.xml')
| -rw-r--r-- | help/en_US/wkeep.xml | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/help/en_US/wkeep.xml b/help/en_US/wkeep.xml new file mode 100644 index 0000000..3bac5e2 --- /dev/null +++ b/help/en_US/wkeep.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from wkeep.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="wkeep" 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>wkeep</refname> + <refpurpose></refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [y]=wkeep(x,l) + [y]=wkeep(x,l,opt) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> Real, complex or string type input vector or matrix</para></listitem></varlistentry> + <varlistentry><term>l:</term> + <listitem><para> Length of matrix required</para></listitem></varlistentry> + <varlistentry><term>opt:</term> + <listitem><para> Character input to determine which side to extract from</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function +[y]=wkeep(x,l) extracts a vector of length l from the centre of input vector x. +[y]=wkeep(x,l,opt) extracts vector based on opt which could be 'l','r' or 'c' (left, right or central). +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +1. [y]=wkeep([1 2 3;4 5 6],[2 2]) +y= 1 2 +2. [y]=wkeep([1 2 3 4 5 6],3,'r') +y= 4 5 6 + ]]></programlisting> +</refsection> +</refentry> |