root/library/doc/html/classbdm_1_1rectangular__support.html @ 614

Revision 614, 14.7 kB (checked in by smidl, 15 years ago)

doc

Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>mixpp: bdm::rectangular_support Class Reference</title>
6<link href="tabs.css" rel="stylesheet" type="text/css"/>
7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8</head>
9<body>
10<!-- Generated by Doxygen 1.6.1 -->
11<script type="text/javascript">
12<!--
13function changeDisplayState (e){
14  var num=this.id.replace(/[^[0-9]/g,'');
15  var button=this.firstChild;
16  var sectionDiv=document.getElementById('dynsection'+num);
17  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18    sectionDiv.style.display='block';
19    button.src='open.gif';
20  }else{
21    sectionDiv.style.display='none';
22    button.src='closed.gif';
23  }
24}
25function initDynSections(){
26  var divs=document.getElementsByTagName('div');
27  var sectionCounter=1;
28  for(var i=0;i<divs.length-1;i++){
29    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30      var header=divs[i];
31      var section=divs[i+1];
32      var button=header.firstChild;
33      if (button!='IMG'){
34        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35        button=document.createElement('img');
36        divs[i].insertBefore(button,divs[i].firstChild);
37      }
38      header.style.cursor='pointer';
39      header.onclick=changeDisplayState;
40      header.id='dynheader'+sectionCounter;
41      button.src='closed.gif';
42      section.id='dynsection'+sectionCounter;
43      section.style.display='none';
44      section.style.marginLeft='14px';
45      sectionCounter++;
46    }
47  }
48}
49window.onload = initDynSections;
50-->
51</script>
52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
58      <li><a href="files.html"><span>Files</span></a></li>
59    </ul>
60  </div>
61  <div class="tabs">
62    <ul>
63      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
65      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
66      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
67    </ul>
68  </div>
69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1rectangular__support.html">rectangular_support</a>
70  </div>
71</div>
72<div class="contents">
73<h1>bdm::rectangular_support Class Reference</h1><!-- doxytag: class="bdm::rectangular_support" --><!-- doxytag: inherits="bdm::root" -->
74<p><code>#include &lt;<a class="el" href="discrete_8h_source.html">discrete.h</a>&gt;</code></p>
75
76<p><a href="classbdm_1_1rectangular__support-members.html">List of all members.</a></p>
77<table border="0" cellpadding="0" cellspacing="0">
78<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
79<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9929645efe5eff3a6b87da8b81e114c4"></a><!-- doxytag: member="bdm::rectangular_support::rectangular_support" ref="a9929645efe5eff3a6b87da8b81e114c4" args="()" -->
80&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a9929645efe5eff3a6b87da8b81e114c4">rectangular_support</a> ()</td></tr>
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br/></td></tr>
82<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa18272405534f914ee3798f1c4034e51"></a><!-- doxytag: member="bdm::rectangular_support::set_parameters" ref="aa18272405534f914ee3798f1c4034e51" args="(const Array&lt; vec &gt; &amp;ranges0, const ivec &amp;gridsize0)" -->
83void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#aa18272405534f914ee3798f1c4034e51">set_parameters</a> (const Array&lt; vec &gt; &amp;ranges0, const ivec &amp;gridsize0)</td></tr>
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set parameters <br/></td></tr>
85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adeaab6ec24371267da14de05963c5092"></a><!-- doxytag: member="bdm::rectangular_support::initialize" ref="adeaab6ec24371267da14de05963c5092" args="()" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#adeaab6ec24371267da14de05963c5092">initialize</a> ()</td></tr>
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal functio to set temporaries correctly. <br/></td></tr>
88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fd69b881ff077e6d3da3e453d7dc418"></a><!-- doxytag: member="bdm::rectangular_support::get_vec" ref="a2fd69b881ff077e6d3da3e453d7dc418" args="(const ivec &amp;inds)" -->
89vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a2fd69b881ff077e6d3da3e453d7dc418">get_vec</a> (const ivec &amp;inds)</td></tr>
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return vector at position given by vector of indeces <br/></td></tr>
91<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ae8ed78cba8e14b5dcc570b51d7d3f0"></a><!-- doxytag: member="bdm::rectangular_support::linear_index" ref="a2ae8ed78cba8e14b5dcc570b51d7d3f0" args="(const ivec inds)" -->
92long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a2ae8ed78cba8e14b5dcc570b51d7d3f0">linear_index</a> (const ivec inds)</td></tr>
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">convert dimension indeces into linear index, the indexing is in the same way as in <code><a class="el" href="classbdm_1_1rectangular__support.html#aadc4f5bdfd1b6f863cdf7961964eb23f" title="Get next active vector, call ONLY after first_vector()!">next_vec()</a></code> <br/></td></tr>
94<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e0baba7f6e7dc131e8c9131d37b4f94"></a><!-- doxytag: member="bdm::rectangular_support::first_vec" ref="a5e0baba7f6e7dc131e8c9131d37b4f94" args="()" -->
95const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a5e0baba7f6e7dc131e8c9131d37b4f94">first_vec</a> ()</td></tr>
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the first vector to corner and store result in actvec <br/></td></tr>
97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadc4f5bdfd1b6f863cdf7961964eb23f"></a><!-- doxytag: member="bdm::rectangular_support::next_vec" ref="aadc4f5bdfd1b6f863cdf7961964eb23f" args="()" -->
98const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#aadc4f5bdfd1b6f863cdf7961964eb23f">next_vec</a> ()</td></tr>
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get next active vector, call ONLY after first_vector()! <br/></td></tr>
100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ea90fd6ba65251683c04599b6d094b7"></a><!-- doxytag: member="bdm::rectangular_support::nearest_point" ref="a0ea90fd6ba65251683c04599b6d094b7" args="(const vec &amp;val)" -->
101ivec&nbsp;</td><td class="memItemRight" valign="bottom"><b>nearest_point</b> (const vec &amp;val)</td></tr>
102<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2cc3a7250b969675bc8f9034aa2a7d2"></a><!-- doxytag: member="bdm::rectangular_support::points" ref="aa2cc3a7250b969675bc8f9034aa2a7d2" args="() const " -->
103int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#aa2cc3a7250b969675bc8f9034aa2a7d2">points</a> () const </td></tr>
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access function. <br/></td></tr>
105<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acfd542382bc959fce9c117b8df5f6e9f"></a><!-- doxytag: member="bdm::rectangular_support::_steps" ref="acfd542382bc959fce9c117b8df5f6e9f" args="() const " -->
106const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#acfd542382bc959fce9c117b8df5f6e9f">_steps</a> () const </td></tr>
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
108<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8d82bd237cdd4dc50d5fbcc285d80ee"></a><!-- doxytag: member="bdm::rectangular_support::from_setting" ref="ac8d82bd237cdd4dc50d5fbcc285d80ee" args="(const Setting &amp;set)" -->
109void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#ac8d82bd237cdd4dc50d5fbcc285d80ee">from_setting</a> (const Setting &amp;set)</td></tr>
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br/></td></tr>
111<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::rectangular_support::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
112virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
114<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::rectangular_support::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
115virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
117<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::rectangular_support::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
118virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
120<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
121<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab63e1190a8a22031d110624a8fc64b14"></a><!-- doxytag: member="bdm::rectangular_support::ranges" ref="ab63e1190a8a22031d110624a8fc64b14" args="" -->
122Array&lt; vec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#ab63e1190a8a22031d110624a8fc64b14">ranges</a></td></tr>
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array of boundaries (2D vectors: [begining,end]) for each dimension. <br/></td></tr>
124<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefe08427f4bf66191e10b727b57e4b31"></a><!-- doxytag: member="bdm::rectangular_support::gridsizes" ref="aefe08427f4bf66191e10b727b57e4b31" args="" -->
125ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#aefe08427f4bf66191e10b727b57e4b31">gridsizes</a></td></tr>
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of support points in each dimension. <br/></td></tr>
127<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a442ae2e1881d6bcdccf0cabbef769e79"></a><!-- doxytag: member="bdm::rectangular_support::dim" ref="a442ae2e1881d6bcdccf0cabbef769e79" args="" -->
128int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a442ae2e1881d6bcdccf0cabbef769e79">dim</a></td></tr>
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension <br/></td></tr>
130<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e55e6243f3a3e451f8bed149d948319"></a><!-- doxytag: member="bdm::rectangular_support::Npoints" ref="a6e55e6243f3a3e451f8bed149d948319" args="" -->
131int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a6e55e6243f3a3e451f8bed149d948319">Npoints</a></td></tr>
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of data points. <br/></td></tr>
133<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1aa9a4e91c248a29e4e432f4b448197"></a><!-- doxytag: member="bdm::rectangular_support::actvec" ref="ae1aa9a4e91c248a29e4e432f4b448197" args="" -->
134vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#ae1aa9a4e91c248a29e4e432f4b448197">actvec</a></td></tr>
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">active vector for first_vec and next_vec <br/></td></tr>
136<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a744688479a1ab8cf9f80d6f3021d762b"></a><!-- doxytag: member="bdm::rectangular_support::actvec_ind" ref="a744688479a1ab8cf9f80d6f3021d762b" args="" -->
137vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a744688479a1ab8cf9f80d6f3021d762b">actvec_ind</a></td></tr>
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indeces of active vector <br/></td></tr>
139<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a967bfe2eb868409e3e0e6e41dcd63a6a"></a><!-- doxytag: member="bdm::rectangular_support::steps" ref="a967bfe2eb868409e3e0e6e41dcd63a6a" args="" -->
140vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a967bfe2eb868409e3e0e6e41dcd63a6a">steps</a></td></tr>
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">length of steps in each dimension <br/></td></tr>
142</table>
143<hr/><a name="_details"></a><h2>Detailed Description</h2>
144<p>Rectangular support Support points are located inbetween ranges! For example: For ranges=[0,1] and gridsizes=[1] the support point is 0.5 </p>
145<hr/>The documentation for this class was generated from the following file:<ul>
146<li><a class="el" href="discrete_8h_source.html">discrete.h</a></li>
147</ul>
148</div>
149<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 22:40:44 2009 for mixpp by&nbsp;
150<a href="http://www.doxygen.org/index.html">
151<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
152</body>
153</html>
Note: See TracBrowser for help on using the browser.