root/library/doc/html/classbdm_1_1discrete__support.html @ 622

Revision 621, 11.0 kB (checked in by smidl, 15 years ago)

doc - new pattern for from_setting for pdfs

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::discrete_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_1discrete__support.html">discrete_support</a>
70  </div>
71</div>
72<div class="contents">
73<h1>bdm::discrete_support Class Reference</h1><!-- doxytag: class="bdm::discrete_support" --><!-- doxytag: inherits="bdm::root" -->
74<p>Discrete support with stored support points. 
75<a href="#_details">More...</a></p>
76<hr/><a name="_details"></a><h2>Detailed Description</h2>
77<p>Discrete support with stored support points. </p>
78
79<p><code>#include &lt;<a class="el" href="discrete_8h_source.html">discrete.h</a>&gt;</code></p>
80
81<p><a href="classbdm_1_1discrete__support-members.html">List of all members.</a></p>
82<table border="0" cellpadding="0" cellspacing="0">
83<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
84<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58d652a1f149a7698f1fee9acd1a78b5"></a><!-- doxytag: member="bdm::discrete_support::discrete_support" ref="a58d652a1f149a7698f1fee9acd1a78b5" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1discrete__support.html#a58d652a1f149a7698f1fee9acd1a78b5">discrete_support</a> ()</td></tr>
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
87<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc3d175266b65168ba3f3a5f568078a1"></a><!-- doxytag: member="bdm::discrete_support::points" ref="adc3d175266b65168ba3f3a5f568078a1" args="() const " -->
88int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1discrete__support.html#adc3d175266b65168ba3f3a5f568078a1">points</a> () const </td></tr>
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access function. <br/></td></tr>
90<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26c803791b63916adf301a4a186f01ba"></a><!-- doxytag: member="bdm::discrete_support::first_vec" ref="a26c803791b63916adf301a4a186f01ba" args="()" -->
91const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1discrete__support.html#a26c803791b63916adf301a4a186f01ba">first_vec</a> ()</td></tr>
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the first vector to corner and store result in actvec <br/></td></tr>
93<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a368f10fd45443dee5296cc0febb240fb"></a><!-- doxytag: member="bdm::discrete_support::next_vec" ref="a368f10fd45443dee5296cc0febb240fb" args="()" -->
94const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1discrete__support.html#a368f10fd45443dee5296cc0febb240fb">next_vec</a> ()</td></tr>
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set next vector after calling <a class="el" href="classbdm_1_1discrete__support.html#a26c803791b63916adf301a4a186f01ba" title="set the first vector to corner and store result in actvec">first_vec()</a> <br/></td></tr>
96<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1discrete__support.html#a0c405889b7b76f0852c1b2a222f07aab">from_setting</a> (const Setting &amp;set)</td></tr>
97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e9af8da7fa2ac2c03b3cec1d4407b1d"></a><!-- doxytag: member="bdm::discrete_support::_Spoints" ref="a1e9af8da7fa2ac2c03b3cec1d4407b1d" args="()" -->
98Array&lt; vec &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1discrete__support.html#a1e9af8da7fa2ac2c03b3cec1d4407b1d">_Spoints</a> ()</td></tr>
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::discrete_support::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
101virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
103<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::discrete_support::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
104virtual 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>
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
106<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::discrete_support::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
107virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
109<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0cbdb61727406b52ca22332507a9a7c"></a><!-- doxytag: member="bdm::discrete_support::Spoints" ref="ac0cbdb61727406b52ca22332507a9a7c" args="" -->
111Array&lt; vec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1discrete__support.html#ac0cbdb61727406b52ca22332507a9a7c">Spoints</a></td></tr>
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">storage of support points <br/></td></tr>
113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a505284848af521fea33e65368de4845e"></a><!-- doxytag: member="bdm::discrete_support::idx" ref="a505284848af521fea33e65368de4845e" args="" -->
114int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1discrete__support.html#a505284848af521fea33e65368de4845e">idx</a></td></tr>
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">index in iterators <br/></td></tr>
116</table>
117<hr/><h2>Member Function Documentation</h2>
118<a class="anchor" id="a0c405889b7b76f0852c1b2a222f07aab"></a><!-- doxytag: member="bdm::discrete_support::from_setting" ref="a0c405889b7b76f0852c1b2a222f07aab" args="(const Setting &amp;set)" -->
119<div class="memitem">
120<div class="memproto">
121      <table class="memname">
122        <tr>
123          <td class="memname">void bdm::discrete_support::from_setting </td>
124          <td>(</td>
125          <td class="paramtype">const Setting &amp;&nbsp;</td>
126          <td class="paramname"> <em>set</em></td>
127          <td>&nbsp;)&nbsp;</td>
128          <td><code> [inline, virtual]</code></td>
129        </tr>
130      </table>
131</div>
132<div class="memdoc">
133<div class="fragment"><pre class="fragment">                          <span class="keyword">class </span>= &quot;<a class="code" href="classbdm_1_1discrete__support.html#a58d652a1f149a7698f1fee9acd1a78b5" title="Default constructor.">discrete_support</a>&quot;;
134                          <a class="code" href="classbdm_1_1discrete__support.html#adc3d175266b65168ba3f3a5f568078a1" title="Access function.">points</a> = ( [1,2..], [2,2..], ...); <span class="comment">// list of points</span>
135                           === OR ===
136                          epdf = {<span class="keyword">class</span>=<span class="stringliteral">&quot;epdf_offspring&quot;</span>,...}; <span class="comment">// epdf rfom which to sample</span>
137                          npoints = 100;                     <span class="comment">// number of samples</span>
138</pre></div> 
139<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
140
141<p>References <a class="el" href="user__info_8h_source.html#l00443">bdm::UI::get()</a>, <a class="el" href="discrete_8h_source.html#l00159">points()</a>, and <a class="el" href="discrete_8h_source.html#l00152">Spoints</a>.</p>
142
143</div>
144</div>
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 Wed Sep 16 22:33:34 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.