root/doc/xml/classfnc.xml @ 266

Revision 187, 8.1 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="classfnc" kind="class" prot="public">
4    <compoundname>fnc</compoundname>
5    <derivedcompoundref refid="classconstfn" prot="public" virt="non-virtual">constfn</derivedcompoundref>
6    <derivedcompoundref refid="classdiffbifn" prot="public" virt="non-virtual">diffbifn</derivedcompoundref>
7    <derivedcompoundref refid="classlinfn" prot="public" virt="non-virtual">linfn</derivedcompoundref>
8    <includes refid="libBM_8h" local="no">libBM.h</includes>
9      <sectiondef kind="protected-attrib">
10      <memberdef kind="variable" id="classfnc_122d51d10a7901331167f64f80d1af8e9" prot="protected" static="no" mutable="no">
11        <type>int</type>
12        <definition>int fnc::dimy</definition>
13        <argsstring></argsstring>
14        <name>dimy</name>
15        <briefdescription>
16<para>Length of the output vector. </para>        </briefdescription>
17        <detaileddescription>
18        </detaileddescription>
19        <inbodydescription>
20        </inbodydescription>
21        <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"/>
22        <referencedby refid="classfnc_1a8891973d0ca48ce38e1886df45ca298" compoundref="libBM_8h" startline="126" endline="126">_dimy</referencedby>
23        <referencedby refid="classbilinfn_1c99f91d7752e131275b219df731868bd" compoundref="libFN_8cpp" startline="6" endline="18">bilinfn::bilinfn</referencedby>
24        <referencedby refid="classdiffbifn_140d8a7eee45acc55cda33d43282faa03" compoundref="libFN_8h" startline="83" endline="83">diffbifn::eval</referencedby>
25      </memberdef>
26      </sectiondef>
27      <sectiondef kind="public-func">
28      <memberdef kind="function" id="classfnc_18a1da32233c3006a4239cf601c413538" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
29        <type></type>
30        <definition>fnc::fnc</definition>
31        <argsstring>(int dy)</argsstring>
32        <name>fnc</name>
33        <param>
34          <type>int</type>
35          <declname>dy</declname>
36        </param>
37        <briefdescription>
38<para>default constructor </para>        </briefdescription>
39        <detaileddescription>
40        </detaileddescription>
41        <inbodydescription>
42        </inbodydescription>
43        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="119" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="119" bodyend="119"/>
44      </memberdef>
45      <memberdef kind="function" id="classfnc_17fad2e6cb35909a165ec5a53def4a18c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
46        <type>vec</type>
47        <definition>virtual vec fnc::eval</definition>
48        <argsstring>(const vec &amp;cond)</argsstring>
49        <name>eval</name>
50        <reimplementedby refid="classdiffbifn_1ad7673e16aa1a046b131b24c731c4632">eval</reimplementedby>
51        <reimplementedby refid="classlinfn_1fac0e56701f4c7beaf1c91f9b2a55f0b">eval</reimplementedby>
52        <reimplementedby refid="classconstfn_10411f603cbf675f2bc04a8f85e4e3b52">eval</reimplementedby>
53        <param>
54          <type>const vec &amp;</type>
55          <declname>cond</declname>
56        </param>
57        <briefdescription>
58<para>function evaluates numerical value of <formula id="35">$f(x)$</formula> at <formula id="37">$x=$</formula> <computeroutput>cond</computeroutput> </para>        </briefdescription>
59        <detaileddescription>
60        </detaileddescription>
61        <inbodydescription>
62        </inbodydescription>
63        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="121" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="121" bodyend="123"/>
64      </memberdef>
65      <memberdef kind="function" id="classfnc_1a8891973d0ca48ce38e1886df45ca298" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
66        <type>int</type>
67        <definition>int fnc::_dimy</definition>
68        <argsstring>() const </argsstring>
69        <name>_dimy</name>
70        <briefdescription>
71<para>access function </para>        </briefdescription>
72        <detaileddescription>
73        </detaileddescription>
74        <inbodydescription>
75        </inbodydescription>
76        <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"/>
77        <references refid="classfnc_122d51d10a7901331167f64f80d1af8e9" compoundref="libBM_8h" startline="116">dimy</references>
78        <referencedby refid="classEKFfull_1fc753106e0d4cf68e4f2160fd54458c0" compoundref="libKF_8cpp" startline="66" endline="84">EKFfull::set_parameters</referencedby>
79      </memberdef>
80      <memberdef kind="function" id="classfnc_117164c202f6feee3d708b8caab6306ab" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
81        <type></type>
82        <definition>virtual fnc::~fnc</definition>
83        <argsstring>()</argsstring>
84        <name>~fnc</name>
85        <briefdescription>
86<para>Destructor for future use;. </para>        </briefdescription>
87        <detaileddescription>
88        </detaileddescription>
89        <inbodydescription>
90        </inbodydescription>
91        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="129" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="129" bodyend="129"/>
92      </memberdef>
93      </sectiondef>
94    <briefdescription>
95<para>Class representing function <formula id="35">$f(x)$</formula> of variable <formula id="28">$x$</formula> represented by <computeroutput>rv</computeroutput>. </para>    </briefdescription>
96    <detaileddescription>
97    </detaileddescription>
98    <inheritancegraph>
99      <node id="1031">
100        <label>constfn</label>
101        <link refid="classconstfn"/>
102        <childnode refid="1030" relation="public-inheritance">
103        </childnode>
104      </node>
105      <node id="1036">
106        <label>OMpmsm</label>
107        <link refid="classOMpmsm"/>
108        <childnode refid="1032" relation="public-inheritance">
109        </childnode>
110      </node>
111      <node id="1033">
112        <label>bilinfn</label>
113        <link refid="classbilinfn"/>
114        <childnode refid="1032" relation="public-inheritance">
115        </childnode>
116      </node>
117      <node id="1035">
118        <label>IMpmsmStat</label>
119        <link refid="classIMpmsmStat"/>
120        <childnode refid="1034" relation="public-inheritance">
121        </childnode>
122      </node>
123      <node id="1032">
124        <label>diffbifn</label>
125        <link refid="classdiffbifn"/>
126        <childnode refid="1030" relation="public-inheritance">
127        </childnode>
128      </node>
129      <node id="1037">
130        <label>linfn</label>
131        <link refid="classlinfn"/>
132        <childnode refid="1030" relation="public-inheritance">
133        </childnode>
134      </node>
135      <node id="1030">
136        <label>fnc</label>
137        <link refid="classfnc"/>
138      </node>
139      <node id="1034">
140        <label>IMpmsm</label>
141        <link refid="classIMpmsm"/>
142        <childnode refid="1032" relation="public-inheritance">
143        </childnode>
144      </node>
145    </inheritancegraph>
146    <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="113" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="113" bodyend="130"/>
147    <listofallmembers>
148      <member refid="classfnc_1a8891973d0ca48ce38e1886df45ca298" prot="public" virt="non-virtual"><scope>fnc</scope><name>_dimy</name></member>
149      <member refid="classfnc_122d51d10a7901331167f64f80d1af8e9" prot="protected" virt="non-virtual"><scope>fnc</scope><name>dimy</name></member>
150      <member refid="classfnc_17fad2e6cb35909a165ec5a53def4a18c" prot="public" virt="virtual"><scope>fnc</scope><name>eval</name></member>
151      <member refid="classfnc_18a1da32233c3006a4239cf601c413538" prot="public" virt="non-virtual"><scope>fnc</scope><name>fnc</name></member>
152      <member refid="classfnc_117164c202f6feee3d708b8caab6306ab" prot="public" virt="virtual"><scope>fnc</scope><name>~fnc</name></member>
153    </listofallmembers>
154  </compounddef>
155</doxygen>
Note: See TracBrowser for help on using the browser.