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/sawtooth.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/sawtooth.xml')
-rw-r--r-- | help/en_US/sawtooth.xml | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/help/en_US/sawtooth.xml b/help/en_US/sawtooth.xml new file mode 100644 index 0000000..aee4088 --- /dev/null +++ b/help/en_US/sawtooth.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from sawtooth.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="sawtooth" 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>sawtooth</refname> + <refpurpose></refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [y]=sawtooth(t) + [y]=sawtooth(t,width) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>t:</term> + <listitem><para> Real valued vector or matrix</para></listitem></varlistentry> + <varlistentry><term>width:</term> + <listitem><para> Real number between 0 and 1</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function +This function returns a sawtooth wave with period 2*pi with +1/-1 as the maximum and minimum values for elements of t. If width is specified, it determines where the maximum is in the interval [0,2*pi]. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +1. sawtooth([1 2 3 4 5],0.5) +ans = [-0.36338 0.27324 0.90986 0.45352 -0.18310] +2. sawtooth([1 2; 4 5]) +ans = [-0.68169 -0.36338; 0.27324 0.59155] + ]]></programlisting> +</refsection> +</refentry> |