root/doc/xml/classlinfn.xml @ 234

Revision 187, 10.3 kB (checked in by smidl, 16 years ago)

doc

Line 
1<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
3  <compounddef id="classlinfn" kind="class" prot="public">
4    <compoundname>linfn</compoundname>
5    <basecompoundref refid="classfnc" prot="public" virt="non-virtual">fnc</basecompoundref>
6    <includes refid="libFN_8h" local="no">libFN.h</includes>
7      <sectiondef kind="private-attrib">
8      <memberdef kind="variable" id="classlinfn_1b02f3c424b0e1ff877da4ee0cc836603" prot="private" static="no" mutable="no">
9        <type><ref refid="classRV" kindref="compound">RV</ref></type>
10        <definition>RV linfn::rv</definition>
11        <argsstring></argsstring>
12        <name>rv</name>
13        <briefdescription>
14<para>Identification of <formula id="28">$x$</formula>. </para>        </briefdescription>
15        <detaileddescription>
16        </detaileddescription>
17        <inbodydescription>
18        </inbodydescription>
19        <location file="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" line="38" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" bodystart="38" bodyend="-1"/>
20      </memberdef>
21      <memberdef kind="variable" id="classlinfn_145b9c79ced4e01a50eae8342981e6be4" prot="private" static="no" mutable="no">
22        <type>mat</type>
23        <definition>mat linfn::A</definition>
24        <argsstring></argsstring>
25        <name>A</name>
26        <briefdescription>
27<para>Matrix A. </para>        </briefdescription>
28        <detaileddescription>
29        </detaileddescription>
30        <inbodydescription>
31        </inbodydescription>
32        <location file="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" line="40" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" bodystart="40" bodyend="-1"/>
33      </memberdef>
34      <memberdef kind="variable" id="classlinfn_18c40031f010f382655234d52fdbbaaea" prot="private" static="no" mutable="no">
35        <type>vec</type>
36        <definition>vec linfn::B</definition>
37        <argsstring></argsstring>
38        <name>B</name>
39        <briefdescription>
40<para>Matrix B. </para>        </briefdescription>
41        <detaileddescription>
42        </detaileddescription>
43        <inbodydescription>
44        </inbodydescription>
45        <location file="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" line="42" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" bodystart="42" bodyend="-1"/>
46      </memberdef>
47      </sectiondef>
48      <sectiondef kind="public-func">
49      <memberdef kind="function" id="classlinfn_1fac0e56701f4c7beaf1c91f9b2a55f0b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
50        <type>vec</type>
51        <definition>vec linfn::eval</definition>
52        <argsstring>(const vec &amp;cond)</argsstring>
53        <name>eval</name>
54        <reimplements refid="classfnc_17fad2e6cb35909a165ec5a53def4a18c">eval</reimplements>
55        <param>
56          <type>const vec &amp;</type>
57          <declname>cond</declname>
58        </param>
59        <briefdescription>
60<para>function evaluates numerical value of <formula id="35">$f(x)$</formula> at <formula id="37">$x=$</formula> <computeroutput>cond</computeroutput> </para>        </briefdescription>
61        <detaileddescription>
62        </detaileddescription>
63        <inbodydescription>
64        </inbodydescription>
65        <location file="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" line="44" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" bodystart="44" bodyend="44"/>
66        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="69" endline="69">RV::count</references>
67      </memberdef>
68      <memberdef kind="function" id="classlinfn_101c70122a7783ddb0d87e6a82685adcb" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
69        <type></type>
70        <definition>linfn::linfn</definition>
71        <argsstring>(const RV &amp;rv0)</argsstring>
72        <name>linfn</name>
73        <param>
74          <type>const <ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
75          <declname>rv0</declname>
76        </param>
77        <briefdescription>
78<para>default constructor </para>        </briefdescription>
79        <detaileddescription>
80        </detaileddescription>
81        <inbodydescription>
82        </inbodydescription>
83        <location file="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" line="48" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" bodystart="48" bodyend="48"/>
84      </memberdef>
85      <memberdef kind="function" id="classlinfn_115eb81f2141984a61706b7ad5b411505" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
86        <type>void</type>
87        <definition>void linfn::set_parameters</definition>
88        <argsstring>(const mat &amp;A0, const vec &amp;B0)</argsstring>
89        <name>set_parameters</name>
90        <param>
91          <type>const mat &amp;</type>
92          <declname>A0</declname>
93        </param>
94        <param>
95          <type>const vec &amp;</type>
96          <declname>B0</declname>
97        </param>
98        <briefdescription>
99<para>Set values of <computeroutput>A</computeroutput> and <computeroutput>B</computeroutput>. </para>        </briefdescription>
100        <detaileddescription>
101        </detaileddescription>
102        <inbodydescription>
103        </inbodydescription>
104        <location file="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" line="50" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" bodystart="50" bodyend="50"/>
105      </memberdef>
106      <memberdef kind="function" id="classfnc_1a8891973d0ca48ce38e1886df45ca298" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
107        <type>int</type>
108        <definition>int fnc::_dimy</definition>
109        <argsstring>() const </argsstring>
110        <name>_dimy</name>
111        <briefdescription>
112<para>access function </para>        </briefdescription>
113        <detaileddescription>
114        </detaileddescription>
115        <inbodydescription>
116        </inbodydescription>
117        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="126" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="126" bodyend="126"/>
118        <references refid="classfnc_122d51d10a7901331167f64f80d1af8e9" compoundref="libBM_8h" startline="116">fnc::dimy</references>
119        <referencedby refid="classEKFfull_1fc753106e0d4cf68e4f2160fd54458c0" compoundref="libKF_8cpp" startline="66" endline="84">EKFfull::set_parameters</referencedby>
120      </memberdef>
121      </sectiondef>
122      <sectiondef kind="protected-attrib">
123      <memberdef kind="variable" id="classfnc_122d51d10a7901331167f64f80d1af8e9" prot="protected" static="no" mutable="no">
124        <type>int</type>
125        <definition>int fnc::dimy</definition>
126        <argsstring></argsstring>
127        <name>dimy</name>
128        <briefdescription>
129<para>Length of the output vector. </para>        </briefdescription>
130        <detaileddescription>
131        </detaileddescription>
132        <inbodydescription>
133        </inbodydescription>
134        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="116" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="116" bodyend="-1"/>
135        <referencedby refid="classfnc_1a8891973d0ca48ce38e1886df45ca298" compoundref="libBM_8h" startline="126" endline="126">fnc::_dimy</referencedby>
136        <referencedby refid="classbilinfn_1c99f91d7752e131275b219df731868bd" compoundref="libFN_8cpp" startline="6" endline="18">bilinfn::bilinfn</referencedby>
137        <referencedby refid="classdiffbifn_140d8a7eee45acc55cda33d43282faa03" compoundref="libFN_8h" startline="83" endline="83">diffbifn::eval</referencedby>
138      </memberdef>
139      </sectiondef>
140    <briefdescription>
141<para>Class representing function <formula id="46">$f(x) = Ax+B$</formula>. </para>    </briefdescription>
142    <detaileddescription>
143    </detaileddescription>
144    <inheritancegraph>
145      <node id="1156">
146        <label>linfn</label>
147        <link refid="classlinfn"/>
148        <childnode refid="1157" relation="public-inheritance">
149        </childnode>
150      </node>
151      <node id="1157">
152        <label>fnc</label>
153        <link refid="classfnc"/>
154      </node>
155    </inheritancegraph>
156    <collaborationgraph>
157      <node id="1160">
158        <label>RV</label>
159        <link refid="classRV"/>
160      </node>
161      <node id="1158">
162        <label>linfn</label>
163        <link refid="classlinfn"/>
164        <childnode refid="1159" relation="public-inheritance">
165        </childnode>
166        <childnode refid="1160" relation="usage">
167          <edgelabel>rv</edgelabel>
168        </childnode>
169      </node>
170      <node id="1159">
171        <label>fnc</label>
172        <link refid="classfnc"/>
173      </node>
174    </collaborationgraph>
175    <location file="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" line="36" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libFN.h" bodystart="35" bodyend="51"/>
176    <listofallmembers>
177      <member refid="classfnc_1a8891973d0ca48ce38e1886df45ca298" prot="public" virt="non-virtual"><scope>linfn</scope><name>_dimy</name></member>
178      <member refid="classlinfn_145b9c79ced4e01a50eae8342981e6be4" prot="private" virt="non-virtual"><scope>linfn</scope><name>A</name></member>
179      <member refid="classlinfn_18c40031f010f382655234d52fdbbaaea" prot="private" virt="non-virtual"><scope>linfn</scope><name>B</name></member>
180      <member refid="classfnc_122d51d10a7901331167f64f80d1af8e9" prot="protected" virt="non-virtual"><scope>linfn</scope><name>dimy</name></member>
181      <member refid="classlinfn_1fac0e56701f4c7beaf1c91f9b2a55f0b" prot="public" virt="virtual"><scope>linfn</scope><name>eval</name></member>
182      <member refid="classfnc_18a1da32233c3006a4239cf601c413538" prot="public" virt="non-virtual"><scope>linfn</scope><name>fnc</name></member>
183      <member refid="classlinfn_101c70122a7783ddb0d87e6a82685adcb" prot="public" virt="non-virtual"><scope>linfn</scope><name>linfn</name></member>
184      <member refid="classlinfn_1b02f3c424b0e1ff877da4ee0cc836603" prot="private" virt="non-virtual"><scope>linfn</scope><name>rv</name></member>
185      <member refid="classlinfn_115eb81f2141984a61706b7ad5b411505" prot="public" virt="non-virtual"><scope>linfn</scope><name>set_parameters</name></member>
186      <member refid="classfnc_117164c202f6feee3d708b8caab6306ab" prot="public" virt="virtual"><scope>linfn</scope><name>~fnc</name></member>
187    </listofallmembers>
188  </compounddef>
189</doxygen>
Note: See TracBrowser for help on using the browser.