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

Revision 661, 16.5 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" --><hr/><a name="_details"></a><h2>Detailed Description</h2>
74<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>
75
76<p><code>#include &lt;<a class="el" href="discrete_8h_source.html">discrete.h</a>&gt;</code></p>
77
78<p><a href="classbdm_1_1rectangular__support-members.html">List of all members.</a></p>
79<table border="0" cellpadding="0" cellspacing="0">
80<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9929645efe5eff3a6b87da8b81e114c4"></a><!-- doxytag: member="bdm::rectangular_support::rectangular_support" ref="a9929645efe5eff3a6b87da8b81e114c4" args="()" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a9929645efe5eff3a6b87da8b81e114c4">rectangular_support</a> ()</td></tr>
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br/></td></tr>
84<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)" -->
85void&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>
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set parameters <br/></td></tr>
87<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adeaab6ec24371267da14de05963c5092"></a><!-- doxytag: member="bdm::rectangular_support::initialize" ref="adeaab6ec24371267da14de05963c5092" args="()" -->
88void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#adeaab6ec24371267da14de05963c5092">initialize</a> ()</td></tr>
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal functio to set temporaries correctly. <br/></td></tr>
90<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)" -->
91vec&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>
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" align="right" valign="top"><a class="anchor" id="a2ae8ed78cba8e14b5dcc570b51d7d3f0"></a><!-- doxytag: member="bdm::rectangular_support::linear_index" ref="a2ae8ed78cba8e14b5dcc570b51d7d3f0" args="(const ivec inds)" -->
94long&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>
95<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#a80f33e406ba1799376537c39fdf7cc97" title="Get next active vector, call ONLY after first_vector()!">next_vec()</a></code> <br/></td></tr>
96<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a1d6c127b468b772fd0a7206e2880a3"></a><!-- doxytag: member="bdm::rectangular_support::first_vec" ref="a6a1d6c127b468b772fd0a7206e2880a3" args="()" -->
97const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a6a1d6c127b468b772fd0a7206e2880a3">first_vec</a> ()</td></tr>
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the first vector to corner and store result in actvec <br/></td></tr>
99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80f33e406ba1799376537c39fdf7cc97"></a><!-- doxytag: member="bdm::rectangular_support::next_vec" ref="a80f33e406ba1799376537c39fdf7cc97" args="()" -->
100const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a80f33e406ba1799376537c39fdf7cc97">next_vec</a> ()</td></tr>
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get next active vector, call ONLY after first_vector()! <br/></td></tr>
102<tr><td class="memItemLeft" align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a0ea90fd6ba65251683c04599b6d094b7">nearest_point</a> (const vec &amp;val)</td></tr>
103<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2cc3a7250b969675bc8f9034aa2a7d2"></a><!-- doxytag: member="bdm::rectangular_support::points" ref="aa2cc3a7250b969675bc8f9034aa2a7d2" args="() const " -->
104int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#aa2cc3a7250b969675bc8f9034aa2a7d2">points</a> () const </td></tr>
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access function. <br/></td></tr>
106<tr><td class="memItemLeft" align="right" valign="top">const 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="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)" -->
108void&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>
109<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>
110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::rectangular_support::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
111virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
113<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 " -->
114virtual 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>
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
116<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::rectangular_support::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
117virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
119<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
120<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab63e1190a8a22031d110624a8fc64b14"></a><!-- doxytag: member="bdm::rectangular_support::ranges" ref="ab63e1190a8a22031d110624a8fc64b14" args="" -->
121Array&lt; vec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#ab63e1190a8a22031d110624a8fc64b14">ranges</a></td></tr>
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array of boundaries (2D vectors: [begining,end]) for each dimension. <br/></td></tr>
123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefe08427f4bf66191e10b727b57e4b31"></a><!-- doxytag: member="bdm::rectangular_support::gridsizes" ref="aefe08427f4bf66191e10b727b57e4b31" args="" -->
124ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#aefe08427f4bf66191e10b727b57e4b31">gridsizes</a></td></tr>
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of support points in each dimension. <br/></td></tr>
126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a442ae2e1881d6bcdccf0cabbef769e79"></a><!-- doxytag: member="bdm::rectangular_support::dim" ref="a442ae2e1881d6bcdccf0cabbef769e79" args="" -->
127int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a442ae2e1881d6bcdccf0cabbef769e79">dim</a></td></tr>
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension <br/></td></tr>
129<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e55e6243f3a3e451f8bed149d948319"></a><!-- doxytag: member="bdm::rectangular_support::Npoints" ref="a6e55e6243f3a3e451f8bed149d948319" args="" -->
130int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a6e55e6243f3a3e451f8bed149d948319">Npoints</a></td></tr>
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of data points. <br/></td></tr>
132<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1aa9a4e91c248a29e4e432f4b448197"></a><!-- doxytag: member="bdm::rectangular_support::actvec" ref="ae1aa9a4e91c248a29e4e432f4b448197" args="" -->
133vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#ae1aa9a4e91c248a29e4e432f4b448197">actvec</a></td></tr>
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">active vector for first_vec and next_vec <br/></td></tr>
135<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a744688479a1ab8cf9f80d6f3021d762b"></a><!-- doxytag: member="bdm::rectangular_support::actvec_ind" ref="a744688479a1ab8cf9f80d6f3021d762b" args="" -->
136vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a744688479a1ab8cf9f80d6f3021d762b">actvec_ind</a></td></tr>
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indeces of active vector <br/></td></tr>
138<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a967bfe2eb868409e3e0e6e41dcd63a6a"></a><!-- doxytag: member="bdm::rectangular_support::steps" ref="a967bfe2eb868409e3e0e6e41dcd63a6a" args="" -->
139vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1rectangular__support.html#a967bfe2eb868409e3e0e6e41dcd63a6a">steps</a></td></tr>
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">length of steps in each dimension <br/></td></tr>
141</table>
142<hr/><h2>Member Function Documentation</h2>
143<a class="anchor" id="acfd542382bc959fce9c117b8df5f6e9f"></a><!-- doxytag: member="bdm::rectangular_support::_steps" ref="acfd542382bc959fce9c117b8df5f6e9f" args="() const " -->
144<div class="memitem">
145<div class="memproto">
146      <table class="memname">
147        <tr>
148          <td class="memname">const vec&amp; bdm::rectangular_support::_steps </td>
149          <td>(</td>
150          <td class="paramname"></td>
151          <td>&nbsp;)&nbsp;</td>
152          <td> const<code> [inline]</code></td>
153        </tr>
154      </table>
155</div>
156<div class="memdoc">
157<p>access function </p>
158<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>opet pouze do potomka.. </dd></dl>
159
160<p>References <a class="el" href="discrete_8h_source.html#l00041">steps</a>.</p>
161
162</div>
163</div>
164<a class="anchor" id="a0ea90fd6ba65251683c04599b6d094b7"></a><!-- doxytag: member="bdm::rectangular_support::nearest_point" ref="a0ea90fd6ba65251683c04599b6d094b7" args="(const vec &amp;val)" -->
165<div class="memitem">
166<div class="memproto">
167      <table class="memname">
168        <tr>
169          <td class="memname">ivec bdm::rectangular_support::nearest_point </td>
170          <td>(</td>
171          <td class="paramtype">const vec &amp;&nbsp;</td>
172          <td class="paramname"> <em>val</em></td>
173          <td>&nbsp;)&nbsp;</td>
174          <td></td>
175        </tr>
176      </table>
177</div>
178<div class="memdoc">
179<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>to je asi navic .. v predkovi! </dd></dl>
180
181<p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>GRIDSIZES prejmenovat.. </dd></dl>
182</p>
183
184<p>References <a class="el" href="discrete_8h_source.html#l00033">dim</a>, <a class="el" href="discrete_8h_source.html#l00031">gridsizes</a>, <a class="el" href="discrete_8h_source.html#l00029">ranges</a>, and <a class="el" href="discrete_8h_source.html#l00041">steps</a>.</p>
185
186<p>Referenced by <a class="el" href="discrete_8h_source.html#l00165">bdm::egrid::evallog()</a>, and <a class="el" href="discrete_8h_source.html#l00144">bdm::grid_fnc::nearest_val()</a>.</p>
187
188</div>
189</div>
190<hr/>The documentation for this class was generated from the following files:<ul>
191<li><a class="el" href="discrete_8h_source.html">discrete.h</a></li>
192<li>discrete.cpp</li>
193</ul>
194</div>
195<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Oct 15 00:07:50 2009 for mixpp by&nbsp;
196<a href="http://www.doxygen.org/index.html">
197<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
198</body>
199</html>
Note: See TracBrowser for help on using the browser.