1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
*
* This help file was generated from octave_fun.sci using help_from_sci().
*
-->
<refentry version="5.0-subset Scilab" xml:id="octave_fun" 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_fun</refname>
<refpurpose>Calls an octave function with given inputs and returns the expected output</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[
// Finding the inverse of a matrix using octave
A=[1 2 3;4 5 6;7 8 0]
y = octave_fun("inv",A)
y*A
]]></programlisting>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
// Finding the roots of a polynomial using its coefficients as inputs, using octave
p = [1 2 3];
y = octave_fun("roots",p)
]]></programlisting>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
// Generating filter coefficients of a Hamming window of length M, using octave.
M = 5
y = octave_fun("hamming",M)
]]></programlisting>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
// Generating filter coefficients of a Hamming window of length M with optional arguments, using octave.
M = 5
y = octave_fun("hamming",M,"periodic")
]]></programlisting>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
// Generating an elliptic or Cauer filter with given passband ripple and stopband attenuation, using octave and its "signal" package.
// See help in octave for more information about "ellip" function.
// Note that this example requires the "signal" package to be installed in octave.
[b, a]=octave_fun("ellip","signal",5,1,90,[0.1 0.2])
]]></programlisting>
</refsection>
<refsection>
<title>Authors</title>
<simplelist type="vert">
<member>Rupak Rokade</member>
</simplelist>
</refsection>
</refentry>
|
