diff options
Diffstat (limited to 'help/en_US/octave_functions.xml')
| -rw-r--r-- | help/en_US/octave_functions.xml | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/help/en_US/octave_functions.xml b/help/en_US/octave_functions.xml new file mode 100644 index 0000000..b50f5f6 --- /dev/null +++ b/help/en_US/octave_functions.xml @@ -0,0 +1,116 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from octave_functions.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="octave_functions" 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>octave_functions</refname> + <refpurpose>Call functions available in communications (and any other) package of Octave. The actual function call is "octave_fun" and is available as a part of "FOSSEE-Scilab-Octave-Toolbox"</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Syntax</title> + <synopsis> + [y1, y2, ...] = octave_fun("octave_function",input1,input2,...) + [y1, y2, ...] = octave_fun("octave_function",input1,input2,...,optional_input1,optional_input2,...) + [y1, y2, ...] = octave_fun("octave_function","octave_package",input1,input2,...) + [y1, y2, ...] = octave_fun("octave_function","octave_package",input1,input2,...,optional_input1,optional_input2,...) + + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry> + <term>y :</term> + <listitem><para> ouput as returned by octave. It can be a vector or matrix of doubles</para></listitem> + </varlistentry> + <varlistentry> + <term>octave_function :</term> + <listitem><para> name of the function in octave that has to be called. It has to be a string in double quotes</para></listitem> + </varlistentry> + <varlistentry> + <term>input :</term> + <listitem><para> input as expected by the octave function. It can be a vector or matrix of doubles</para></listitem> + </varlistentry> + <varlistentry> + <term>optional_input :</term> + <listitem><para> an optional argument that the given octave function can accept. It has to be a string in double quotes</para></listitem> + </varlistentry> + <varlistentry> + <term>octave_package :</term> + <listitem><para> name of the package in octave that has to be loaded as required by the octave function. It has to be a string in double quotes</para></listitem> + </varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This function accepts an octave function name with the relevant inputs and returns the output as generated. It requires Octave to be installed along with necessary packages. + </para> + <para> +<latex> +\begin{eqnarray} +&\mbox{min}_{x} +& C^T⋅x \\ +& \text{subject to}& A⋅x = b \\ +& & G⋅x \preceq_K h \\ +& & x_i \in \{0,1\}, i \in \!\, bool_vars\ +& & x_j \in \!\, \mathbb{Z}, i \in \!\, int_vars\\ +\end{eqnarray} +</latex> + </para> + <para> +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +// Reshape a given array using octave and its "communications" package. +// See help in octave for more information about "reshape" function. +// Note that this example requires the "communications" package to be installed in octave and the "FOSSEE-Scilab-Octave-Toolbox" loaded in scilab. +x = [1, 2, 3, 4]; +dim1 = 2; +dim2 = 2; +output = octave_fun("reshape", "communications", x, dim1, dim2) + + ]]></programlisting> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +// Compute the Q function using octave and its "communications" package. +// See help in octave for more information about "qfunc" function. +// Note that this example requires the "communications" package to be installed in octave and the "FOSSEE-Scilab-Octave-Toolbox" loaded in scilab. +M = [1, 2; 3, 4]; +output = octave_fun("qfunc", "communications", M) + + ]]></programlisting> +</refsection> + +<refsection> + <title>Authors</title> + <simplelist type="vert"> + <member>Rupak Rokade</member> + </simplelist> +</refsection> +</refentry> |