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

Revision 590, 14.8 kB (checked in by smidl, 16 years ago)

doc

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