root/library/doc/html/classbdm_1_1elognorm.html @ 651

Revision 651, 24.6 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

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::elognorm 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.9 -->
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_1elognorm.html">elognorm</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::elognorm Class Reference</h1><!-- doxytag: class="bdm::elognorm" --><!-- doxytag: inherits="enorm&lt; ldmat &gt;" --><code>#include &lt;<a class="el" href="exp__family_8h_source.html">exp_family.h</a>&gt;</code>
71<p>
72
73<p>
74<a href="classbdm_1_1elognorm-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="8b948e2bce1253765a2542199913aaba"></a><!-- doxytag: member="bdm::elognorm::sample" ref="8b948e2bce1253765a2542199913aaba" args="() const " -->
78vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1elognorm.html#8b948e2bce1253765a2542199913aaba">sample</a> () const </td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$ x $" src="form_3.png"> from density <img class="formulaInl" alt="$ f_x()$" src="form_13.png">. <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adb41e4f4d6600dec6f8c1dbc5ed9eea"></a><!-- doxytag: member="bdm::elognorm::mean" ref="adb41e4f4d6600dec6f8c1dbc5ed9eea" args="() const " -->
82vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1elognorm.html#adb41e4f4d6600dec6f8c1dbc5ed9eea">mean</a> () const </td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a36d06ecdd6f4c79dc122510eaccc692"></a><!-- doxytag: member="bdm::elognorm::evallog" ref="a36d06ecdd6f4c79dc122510eaccc692" args="(const vec &amp;val) const " -->
86virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#a36d06ecdd6f4c79dc122510eaccc692">evallog</a> (const vec &amp;val) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6886c60b6b690e503913240db5de0c6f"></a><!-- doxytag: member="bdm::elognorm::evallog_m" ref="6886c60b6b690e503913240db5de0c6f" args="(const mat &amp;Val) const " -->
90virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#6886c60b6b690e503913240db5de0c6f">evallog_m</a> (const mat &amp;Val) const </td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d793f4fd6d0dcec5f16bff0ae45fc7d5"></a><!-- doxytag: member="bdm::elognorm::evallog_m" ref="d793f4fd6d0dcec5f16bff0ae45fc7d5" args="(const Array&lt; vec &gt; &amp;Val) const " -->
94virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#d793f4fd6d0dcec5f16bff0ae45fc7d5">evallog_m</a> (const Array&lt; vec &gt; &amp;Val) const </td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf38af29e8e3d650c640509a52396053"></a><!-- doxytag: member="bdm::elognorm::pow" ref="cf38af29e8e3d650c640509a52396053" args="(double p)" -->
98virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#cf38af29e8e3d650c640509a52396053">pow</a> (double p)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::elognorm::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
102virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::elognorm::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
106virtual 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>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
109<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b8322f2c11560871dd922c660f4771bb"></a><!-- doxytag: member="bdm::elognorm::set_parameters" ref="b8322f2c11560871dd922c660f4771bb" args="(const vec &amp;mu, const ldmat &amp;R)" -->
111void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (const vec &amp;<a class="el" href="classbdm_1_1enorm.html#c702a194720853570d08b65482f842c7">mu</a>, const <a class="el" href="classbdm_1_1ldmat.html">ldmat</a> &amp;<a class="el" href="classbdm_1_1enorm.html#2d92dde696b2a7a5b10ddef5d22ba2c2">R</a>)</td></tr>
112
113<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#61bd470764020bea6e1ed35000f259e6">from_setting</a> (const Setting &amp;<a class="el" href="classbdm_1_1root.html">root</a>)</td></tr>
114
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38eb17ecb75d94a50b6782fcf735cfea"></a><!-- doxytag: member="bdm::elognorm::validate" ref="38eb17ecb75d94a50b6782fcf735cfea" args="()" -->
116void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#38eb17ecb75d94a50b6782fcf735cfea">validate</a> ()</td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
119<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
120<tr><td colspan="2"><div class="groupText">Construction of each <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> should support two types of constructors: <ul>
121<li>empty constructor, </li>
122<li>copy constructor,</li>
123</ul>
124The following constructors should be supported for convenience: <ul>
125<li>constructor followed by calling <code>set_parameters()</code> </li>
126<li>constructor accepting random variables calling <code><a class="el" href="classbdm_1_1epdf.html#f423e28448dbb69ef4905295ec8de8ff" title="Name its rv.">set_rv()</a></code> </li>
127</ul>
128All internal data structures are constructed as empty. Their values (including sizes) will be set by method <code>set_parameters()</code>. This way references can be initialized in constructors. <br><br></div></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="840de94aa33cf4f2ebd2427f45a165d8"></a><!-- doxytag: member="bdm::elognorm::set_parameters" ref="840de94aa33cf4f2ebd2427f45a165d8" args="(int dim0)" -->
130void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (int dim0)</td></tr>
131
132<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d2e0d3a1e30ab3ab04df2d0c43ae74a2"></a><!-- doxytag: member="bdm::elognorm::dupdate" ref="d2e0d3a1e30ab3ab04df2d0c43ae74a2" args="(mat &amp;v, double nu=1.0)" -->
134void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#d2e0d3a1e30ab3ab04df2d0c43ae74a2">dupdate</a> (mat &amp;v, double nu=1.0)</td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dupdate in exponential form (not really handy) <br></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e13aeed5b543b2179bacdc4fa2ae47a3"></a><!-- doxytag: member="bdm::elognorm::evallog_nn" ref="e13aeed5b543b2179bacdc4fa2ae47a3" args="(const vec &amp;val) const" -->
138double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#e13aeed5b543b2179bacdc4fa2ae47a3">evallog_nn</a> (const vec &amp;val) const</td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="25785343aff102cc5df1cab08ba16d32"></a><!-- doxytag: member="bdm::elognorm::lognc" ref="25785343aff102cc5df1cab08ba16d32" args="() const" -->
142double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#25785343aff102cc5df1cab08ba16d32">lognc</a> () const</td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">logarithm of the normalizing constant, <img class="formulaInl" alt="$\mathcal{I}$" src="form_97.png"> <br></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="729c75ef0fa8abae03d58ad1f81e6773"></a><!-- doxytag: member="bdm::elognorm::variance" ref="729c75ef0fa8abae03d58ad1f81e6773" args="() const" -->
146vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#729c75ef0fa8abae03d58ad1f81e6773">variance</a> () const</td></tr>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected variance (not covariance!) <br></td></tr>
149<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="40201ca12c6900f7aeb493bb7c582e20"></a><!-- doxytag: member="bdm::elognorm::condition" ref="40201ca12c6900f7aeb493bb7c582e20" args="(const RV &amp;rvn) const" -->
150<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#40201ca12c6900f7aeb493bb7c582e20">condition</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvn) const</td></tr>
151
152<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return conditional density on the given RV, the remaining rvs will be in conditioning. <br></td></tr>
153<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c583763021f98255452925da3d5c4c3"></a><!-- doxytag: member="bdm::elognorm::condition" ref="7c583763021f98255452925da3d5c4c3" args="(const RV &amp;rvn, mpdf &amp;target) const" -->
154void&nbsp;</td><td class="memItemRight" valign="bottom"><b>condition</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvn, <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> &amp;target) const</td></tr>
155
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dcb739443669ba0a8faf634196284c08"></a><!-- doxytag: member="bdm::elognorm::marginal" ref="dcb739443669ba0a8faf634196284c08" args="(const RV &amp;rvn) const" -->
157<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1epdf.html">epdf</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#dcb739443669ba0a8faf634196284c08">marginal</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvn) const</td></tr>
158
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return marginal density on the given RV, the remainig rvs are intergrated out. <br></td></tr>
160<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0db188559ded204e8c081ad7b782b6c9"></a><!-- doxytag: member="bdm::elognorm::marginal" ref="0db188559ded204e8c081ad7b782b6c9" args="(const RV &amp;rvn, enorm&lt; ldmat &gt; &amp;target) const" -->
161void&nbsp;</td><td class="memItemRight" valign="bottom"><b>marginal</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvn, <a class="el" href="classbdm_1_1enorm.html">enorm</a>&lt; <a class="el" href="classbdm_1_1ldmat.html">ldmat</a> &gt; &amp;target) const</td></tr>
162
163<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
164<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="766127847e9482aea9226ea157295ea2"></a><!-- doxytag: member="bdm::elognorm::_mu" ref="766127847e9482aea9226ea157295ea2" args="()" -->
165vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_mu</b> ()</td></tr>
166
167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dd81fdb83c7ff4d790bb9ebc76be8ee"></a><!-- doxytag: member="bdm::elognorm::_mu" ref="9dd81fdb83c7ff4d790bb9ebc76be8ee" args="() const" -->
168const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_mu</b> () const</td></tr>
169
170<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8915d68ae76ad185c8c314f960a63f0c"></a><!-- doxytag: member="bdm::elognorm::set_mu" ref="8915d68ae76ad185c8c314f960a63f0c" args="(const vec mu0)" -->
171void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_mu</b> (const vec mu0)</td></tr>
172
173<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81d81e35e57c9f194bde248e3affcf1f"></a><!-- doxytag: member="bdm::elognorm::_R" ref="81d81e35e57c9f194bde248e3affcf1f" args="()" -->
174<a class="el" href="classbdm_1_1ldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_R</b> ()</td></tr>
175
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c664b024e79f18ca3f8e8cc81af2103"></a><!-- doxytag: member="bdm::elognorm::_R" ref="8c664b024e79f18ca3f8e8cc81af2103" args="() const" -->
177const <a class="el" href="classbdm_1_1ldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_R</b> () const</td></tr>
178
179<tr><td colspan="2"><div class="groupHeader">Matematical Operations</div></td></tr>
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4cf45fd83cc7573ede9fe1215256058"></a><!-- doxytag: member="bdm::elognorm::sample_m" ref="b4cf45fd83cc7573ede9fe1215256058" args="(int N) const " -->
181virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#b4cf45fd83cc7573ede9fe1215256058">sample_m</a> (int N) const </td></tr>
182
183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples, <img class="formulaInl" alt="$ [x_1 , x_2 , \ldots \ $" src="form_14.png"> from density <img class="formulaInl" alt="$ f_x(rv)$" src="form_15.png">. <br></td></tr>
184<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a7705e80601957f7226d333a0a6d539"></a><!-- doxytag: member="bdm::elognorm::qbounds" ref="0a7705e80601957f7226d333a0a6d539" args="(vec &amp;lb, vec &amp;ub, double percentage=0.95) const " -->
185virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#0a7705e80601957f7226d333a0a6d539">qbounds</a> (vec &amp;lb, vec &amp;ub, double percentage=0.95) const </td></tr>
186
187<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lower and upper bounds of <code>percentage</code> % quantile, returns mean-2*sigma as default. <br></td></tr>
188<tr><td colspan="2"><div class="groupHeader">Connection to other classes</div></td></tr>
189<tr><td colspan="2"><div class="groupText">Description of the random quantity via attribute <code>rv</code> is optional. For operations such as sampling <code>rv</code> does not need to be set. However, for <code>marginalization</code> and <code>conditioning</code> <code>rv</code> has to be set. NB: <br><br></div></td></tr>
190<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f423e28448dbb69ef4905295ec8de8ff"></a><!-- doxytag: member="bdm::elognorm::set_rv" ref="f423e28448dbb69ef4905295ec8de8ff" args="(const RV &amp;rv0)" -->
191void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#f423e28448dbb69ef4905295ec8de8ff">set_rv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
192
193<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name its rv. <br></td></tr>
194<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4b863ff84c7a4882fb3ad18556027f9"></a><!-- doxytag: member="bdm::elognorm::isnamed" ref="c4b863ff84c7a4882fb3ad18556027f9" args="() const " -->
195bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#c4b863ff84c7a4882fb3ad18556027f9">isnamed</a> () const </td></tr>
196
197<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if rv is assigned. <br></td></tr>
198<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4ab378d5e004c3ff3e2d4e64f7bba21"></a><!-- doxytag: member="bdm::elognorm::_rv" ref="a4ab378d5e004c3ff3e2d4e64f7bba21" args="() const " -->
199const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a4ab378d5e004c3ff3e2d4e64f7bba21">_rv</a> () const </td></tr>
200
201<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return name (fails when isnamed is false). <br></td></tr>
202<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
203<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7083a65f7b7a0d0d13b2c516bd2ec29c"></a><!-- doxytag: member="bdm::elognorm::dimension" ref="7083a65f7b7a0d0d13b2c516bd2ec29c" args="() const " -->
204int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#7083a65f7b7a0d0d13b2c516bd2ec29c">dimension</a> () const </td></tr>
205
206<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the random variable. <br></td></tr>
207<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
208<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c702a194720853570d08b65482f842c7"></a><!-- doxytag: member="bdm::elognorm::mu" ref="c702a194720853570d08b65482f842c7" args="" -->
209vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#c702a194720853570d08b65482f842c7">mu</a></td></tr>
210
211<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mean value <br></td></tr>
212<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d92dde696b2a7a5b10ddef5d22ba2c2"></a><!-- doxytag: member="bdm::elognorm::R" ref="2d92dde696b2a7a5b10ddef5d22ba2c2" args="" -->
213<a class="el" href="classbdm_1_1ldmat.html">ldmat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#2d92dde696b2a7a5b10ddef5d22ba2c2">R</a></td></tr>
214
215<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Covariance matrix in decomposed form. <br></td></tr>
216<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::elognorm::dim" ref="16adac20ec7fe07e1ea0b27d917788ce" args="" -->
217int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#16adac20ec7fe07e1ea0b27d917788ce">dim</a></td></tr>
218
219<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the random variable <br></td></tr>
220<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c5b8ff71d9ebe6cd58d3c342eb1dc8"></a><!-- doxytag: member="bdm::elognorm::rv" ref="62c5b8ff71d9ebe6cd58d3c342eb1dc8" args="" -->
221<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a></td></tr>
222
223<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the random variable. <br></td></tr>
224</table>
225<hr><a name="_details"></a><h2>Detailed Description</h2>
226Log-Normal probability density only allow diagonal covariances!<p>
227Density of the form <img class="formulaInl" alt="$ \log(x)\sim \mathcal{N}(\mu,\sigma^2) $" src="form_95.png"> , i.e. <p class="formulaDsp">
228<img class="formulaDsp" alt="\[ x \sim \frac{1}{x\sigma\sqrt{2\pi}}\exp{-\frac{1}{2\sigma^2}(\log(x)-\mu)} \]" src="form_96.png">
229<p>
230<p>
231Function from_setting loads mu and R in the same way as it does for enorm&lt;&gt;! <hr><h2>Member Function Documentation</h2>
232<a class="anchor" name="61bd470764020bea6e1ed35000f259e6"></a><!-- doxytag: member="bdm::elognorm::from_setting" ref="61bd470764020bea6e1ed35000f259e6" args="(const Setting &amp;root)" -->
233<div class="memitem">
234<div class="memproto">
235      <table class="memname">
236        <tr>
237          <td class="memname">void <a class="el" href="classbdm_1_1enorm.html">bdm::enorm</a>&lt; <a class="el" href="classbdm_1_1ldmat.html">ldmat</a>  &gt;::from_setting           </td>
238          <td>(</td>
239          <td class="paramtype">const Setting &amp;&nbsp;</td>
240          <td class="paramname"> <em>root</em>          </td>
241          <td>&nbsp;)&nbsp;</td>
242          <td><code> [virtual, inherited]</code></td>
243        </tr>
244      </table>
245</div>
246<div class="memdoc">
247
248<p>
249Create Normal density <p class="formulaDsp">
250<img class="formulaDsp" alt="\[ f(rv) = N(\mu, R) \]" src="form_164.png">
251<p>
252 from structure <div class="fragment"><pre class="fragment">                <span class="keyword">class </span>= 'enorm&lt;ldmat&gt;', (OR) 'enorm&lt;chmat&gt;', (OR) 'enorm&lt;fsqmat&gt;';
253                mu    = [];                  <span class="comment">// mean value</span>
254                R     = [];                  <span class="comment">// variance, square matrix of appropriate dimension</span>
255</pre></div> 
256<p>Reimplemented from <a class="el" href="classbdm_1_1epdf.html#fa9efc98a065b31c630fe18cc418f725">bdm::epdf</a>.</p>
257
258</div>
259</div><p>
260<hr>The documentation for this class was generated from the following file:<ul>
261<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a></ul>
262</div>
263<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:49 2009 for mixpp by&nbsp;
264<a href="http://www.doxygen.org/index.html">
265<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
266</body>
267</html>
Note: See TracBrowser for help on using the browser.