root/library/doc/html/classadditive__generator.html @ 538

Revision 538, 7.3 kB (checked in by smidl, 15 years ago)

Documentation regenerated

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: additive_generator 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>
67<div class="contents">
68<h1>additive_generator Class Reference</h1><!-- doxytag: class="additive_generator" --><!-- doxytag: inherits="generator" --><code>#include &lt;<a class="el" href="additive__generator_8h-source.html">additive_generator.h</a>&gt;</code>
69<p>
70
71<p>
72<a href="classadditive__generator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
73<tr><td></td></tr>
74<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top">itpp::mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classadditive__generator.html#1a1328a7cc93176661c511a08bf278e5">next</a> ()</td></tr>
76
77<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classadditive__generator.html#f21cb51f0f44f1ee1b49c49681b173f1">from_setting</a> (const Setting &amp;set)</td></tr>
78
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="additive_generator::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
80virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="additive_generator::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
84virtual 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>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="additive_generator::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
88virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
91</table>
92<hr><a name="_details"></a><h2>Detailed Description</h2>
93Iteratively adds squared random vector to a random matrix. <hr><h2>Member Function Documentation</h2>
94<a class="anchor" name="f21cb51f0f44f1ee1b49c49681b173f1"></a><!-- doxytag: member="additive_generator::from_setting" ref="f21cb51f0f44f1ee1b49c49681b173f1" args="(const Setting &amp;set)" -->
95<div class="memitem">
96<div class="memproto">
97      <table class="memname">
98        <tr>
99          <td class="memname">void additive_generator::from_setting           </td>
100          <td>(</td>
101          <td class="paramtype">const Setting &amp;&nbsp;</td>
102          <td class="paramname"> <em>set</em>          </td>
103          <td>&nbsp;)&nbsp;</td>
104          <td><code> [virtual]</code></td>
105        </tr>
106      </table>
107</div>
108<div class="memdoc">
109
110<p>
111Load from structure with elements: <div class="fragment"><pre class="fragment"> { size = 7; <span class="comment">// size (rows == cols) of the generated matrix</span>
112   lambda = 0.5; <span class="comment">// weight of the added vector</span>
113 }
114</pre></div> size is mandatory, lambda optional (with default as shown).
115<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
116
117</div>
118</div><p>
119<a class="anchor" name="1a1328a7cc93176661c511a08bf278e5"></a><!-- doxytag: member="additive_generator::next" ref="1a1328a7cc93176661c511a08bf278e5" args="()" -->
120<div class="memitem">
121<div class="memproto">
122      <table class="memname">
123        <tr>
124          <td class="memname">mat additive_generator::next           </td>
125          <td>(</td>
126          <td class="paramname">          </td>
127          <td>&nbsp;)&nbsp;</td>
128          <td><code> [virtual]</code></td>
129        </tr>
130      </table>
131</div>
132<div class="memdoc">
133
134<p>
135Generates a matrix. Returned matrices should become progressively more complicated.
136<p>Implements <a class="el" href="classgenerator.html#e26773c2a508a2ee44cec4657b9088b4">generator</a>.</p>
137
138</div>
139</div><p>
140<hr>The documentation for this class was generated from the following files:<ul>
141<li><a class="el" href="additive__generator_8h-source.html">additive_generator.h</a><li>additive_generator.cpp</ul>
142</div>
143<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 15 17:40:59 2009 for mixpp by&nbsp;
144<a href="http://www.doxygen.org/index.html">
145<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
146</body>
147</html>
Note: See TracBrowser for help on using the browser.