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

Revision 591, 25.2 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::elognorm 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_1elognorm.html">elognorm</a>
70  </div>
71</div>
72<div class="contents">
73<h1>bdm::elognorm Class Reference</h1><!-- doxytag: class="bdm::elognorm" --><!-- doxytag: inherits="enorm&lt; ldmat &gt;" -->
74<p><code>#include &lt;<a class="el" href="exp__family_8h_source.html">exp_family.h</a>&gt;</code></p>
75
76<p><a href="classbdm_1_1elognorm-members.html">List of all members.</a></p>
77<table border="0" cellpadding="0" cellspacing="0">
78<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
79<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b948e2bce1253765a2542199913aaba"></a><!-- doxytag: member="bdm::elognorm::sample" ref="a8b948e2bce1253765a2542199913aaba" args="() const " -->
80vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1elognorm.html#a8b948e2bce1253765a2542199913aaba">sample</a> () const </td></tr>
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$ x $" src="form_7.png"/> from density <img class="formulaInl" alt="$ f_x()$" src="form_8.png"/>. <br/></td></tr>
82<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadb41e4f4d6600dec6f8c1dbc5ed9eea"></a><!-- doxytag: member="bdm::elognorm::mean" ref="aadb41e4f4d6600dec6f8c1dbc5ed9eea" args="() const " -->
83vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1elognorm.html#aadb41e4f4d6600dec6f8c1dbc5ed9eea">mean</a> () const </td></tr>
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br/></td></tr>
85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa36d06ecdd6f4c79dc122510eaccc692"></a><!-- doxytag: member="bdm::elognorm::evallog" ref="aa36d06ecdd6f4c79dc122510eaccc692" args="(const vec &amp;val) const " -->
86virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#aa36d06ecdd6f4c79dc122510eaccc692">evallog</a> (const vec &amp;val) const </td></tr>
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br/></td></tr>
88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6886c60b6b690e503913240db5de0c6f"></a><!-- doxytag: member="bdm::elognorm::evallog_m" ref="a6886c60b6b690e503913240db5de0c6f" args="(const mat &amp;Val) const " -->
89virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#a6886c60b6b690e503913240db5de0c6f">evallog_m</a> (const mat &amp;Val) const </td></tr>
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br/></td></tr>
91<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad793f4fd6d0dcec5f16bff0ae45fc7d5"></a><!-- doxytag: member="bdm::elognorm::evallog_m" ref="ad793f4fd6d0dcec5f16bff0ae45fc7d5" args="(const Array&lt; vec &gt; &amp;Val) const " -->
92virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#ad793f4fd6d0dcec5f16bff0ae45fc7d5">evallog_m</a> (const Array&lt; vec &gt; &amp;Val) const </td></tr>
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br/></td></tr>
94<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf38af29e8e3d650c640509a52396053"></a><!-- doxytag: member="bdm::elognorm::pow" ref="acf38af29e8e3d650c640509a52396053" args="(double p)" -->
95virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#acf38af29e8e3d650c640509a52396053">pow</a> (double p)</td></tr>
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br/></td></tr>
97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::elognorm::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
98virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::elognorm::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
101virtual 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>
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
103<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
104<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp559a25fdb98a7d1fd1c3771ac568d5e9"></a> </p>
105<br/><br/></div></td></tr>
106<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8322f2c11560871dd922c660f4771bb"></a><!-- doxytag: member="bdm::elognorm::set_parameters" ref="ab8322f2c11560871dd922c660f4771bb" args="(const vec &amp;mu, const ldmat &amp;R)" -->
107void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (const vec &amp;<a class="el" href="classbdm_1_1enorm.html#ac702a194720853570d08b65482f842c7">mu</a>, const <a class="el" href="classbdm_1_1ldmat.html">ldmat</a> &amp;<a class="el" href="classbdm_1_1enorm.html#a2d92dde696b2a7a5b10ddef5d22ba2c2">R</a>)</td></tr>
108<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#a61bd470764020bea6e1ed35000f259e6">from_setting</a> (const Setting &amp;<a class="el" href="classbdm_1_1root.html">root</a>)</td></tr>
109<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38eb17ecb75d94a50b6782fcf735cfea"></a><!-- doxytag: member="bdm::elognorm::validate" ref="a38eb17ecb75d94a50b6782fcf735cfea" args="()" -->
110void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#a38eb17ecb75d94a50b6782fcf735cfea">validate</a> ()</td></tr>
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
112<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
113<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp559a25fdb98a7d1fd1c3771ac568d5e9"></a> 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: </p>
114<ul>
115<li>empty constructor, </li>
116<li>copy constructor,</li>
117</ul>
118<p>The following constructors should be supported for convenience: </p>
119<ul>
120<li>constructor followed by calling <code>set_parameters()</code> </li>
121<li>constructor accepting random variables calling <code><a class="el" href="classbdm_1_1epdf.html#af423e28448dbb69ef4905295ec8de8ff" title="Name its rv.">set_rv()</a></code> </li>
122</ul>
123<p>All 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. </p>
124<br/><br/></div></td></tr>
125<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a840de94aa33cf4f2ebd2427f45a165d8"></a><!-- doxytag: member="bdm::elognorm::set_parameters" ref="a840de94aa33cf4f2ebd2427f45a165d8" args="(int dim0)" -->
126void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (int dim0)</td></tr>
127<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
128<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpfb3595af27ed8bd142c95323c0dab340"></a> </p>
129<br/><br/></div></td></tr>
130<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2e0d3a1e30ab3ab04df2d0c43ae74a2"></a><!-- doxytag: member="bdm::elognorm::dupdate" ref="ad2e0d3a1e30ab3ab04df2d0c43ae74a2" args="(mat &amp;v, double nu=1.0)" -->
131void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#ad2e0d3a1e30ab3ab04df2d0c43ae74a2">dupdate</a> (mat &amp;v, double nu=1.0)</td></tr>
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dupdate in exponential form (not really handy) <br/></td></tr>
133<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae13aeed5b543b2179bacdc4fa2ae47a3"></a><!-- doxytag: member="bdm::elognorm::evallog_nn" ref="ae13aeed5b543b2179bacdc4fa2ae47a3" args="(const vec &amp;val) const" -->
134double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#ae13aeed5b543b2179bacdc4fa2ae47a3">evallog_nn</a> (const vec &amp;val) const</td></tr>
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br/></td></tr>
136<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25785343aff102cc5df1cab08ba16d32"></a><!-- doxytag: member="bdm::elognorm::lognc" ref="a25785343aff102cc5df1cab08ba16d32" args="() const" -->
137double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#a25785343aff102cc5df1cab08ba16d32">lognc</a> () const</td></tr>
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">logarithm of the normalizing constant, <img class="formulaInl" alt="$\mathcal{I}$" src="form_89.png"/> <br/></td></tr>
139<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a729c75ef0fa8abae03d58ad1f81e6773"></a><!-- doxytag: member="bdm::elognorm::variance" ref="a729c75ef0fa8abae03d58ad1f81e6773" args="() const" -->
140vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#a729c75ef0fa8abae03d58ad1f81e6773">variance</a> () const</td></tr>
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected variance (not covariance!) <br/></td></tr>
142<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40201ca12c6900f7aeb493bb7c582e20"></a><!-- doxytag: member="bdm::elognorm::condition" ref="a40201ca12c6900f7aeb493bb7c582e20" args="(const RV &amp;rvn) const" -->
143<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#a40201ca12c6900f7aeb493bb7c582e20">condition</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvn) const</td></tr>
144<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>
145<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c583763021f98255452925da3d5c4c3"></a><!-- doxytag: member="bdm::elognorm::condition" ref="a7c583763021f98255452925da3d5c4c3" args="(const RV &amp;rvn, mpdf &amp;target) const" -->
146void&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>
147<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcb739443669ba0a8faf634196284c08"></a><!-- doxytag: member="bdm::elognorm::marginal" ref="adcb739443669ba0a8faf634196284c08" args="(const RV &amp;rvn) const" -->
148<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#adcb739443669ba0a8faf634196284c08">marginal</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvn) const</td></tr>
149<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>
150<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0db188559ded204e8c081ad7b782b6c9"></a><!-- doxytag: member="bdm::elognorm::marginal" ref="a0db188559ded204e8c081ad7b782b6c9" args="(const RV &amp;rvn, enorm&lt; ldmat &gt; &amp;target) const" -->
151void&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>
152<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
153<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb6eb094f9e6af11f8a7d9efa9d8e3623"></a> </p>
154<br/><br/></div></td></tr>
155<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a766127847e9482aea9226ea157295ea2"></a><!-- doxytag: member="bdm::elognorm::_mu" ref="a766127847e9482aea9226ea157295ea2" args="()" -->
156vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_mu</b> ()</td></tr>
157<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dd81fdb83c7ff4d790bb9ebc76be8ee"></a><!-- doxytag: member="bdm::elognorm::_mu" ref="a9dd81fdb83c7ff4d790bb9ebc76be8ee" args="() const" -->
158const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_mu</b> () const</td></tr>
159<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8915d68ae76ad185c8c314f960a63f0c"></a><!-- doxytag: member="bdm::elognorm::set_mu" ref="a8915d68ae76ad185c8c314f960a63f0c" args="(const vec mu0)" -->
160void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_mu</b> (const vec mu0)</td></tr>
161<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81d81e35e57c9f194bde248e3affcf1f"></a><!-- doxytag: member="bdm::elognorm::_R" ref="a81d81e35e57c9f194bde248e3affcf1f" args="()" -->
162<a class="el" href="classbdm_1_1ldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_R</b> ()</td></tr>
163<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c664b024e79f18ca3f8e8cc81af2103"></a><!-- doxytag: member="bdm::elognorm::_R" ref="a8c664b024e79f18ca3f8e8cc81af2103" args="() const" -->
164const <a class="el" href="classbdm_1_1ldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_R</b> () const</td></tr>
165<tr><td colspan="2"><div class="groupHeader">Matematical Operations</div></td></tr>
166<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp96552c993870a5dd6bb0ea321f1ceb78"></a> </p>
167<br/><br/></div></td></tr>
168<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4cf45fd83cc7573ede9fe1215256058"></a><!-- doxytag: member="bdm::elognorm::sample_m" ref="ab4cf45fd83cc7573ede9fe1215256058" args="(int N) const " -->
169virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#ab4cf45fd83cc7573ede9fe1215256058">sample_m</a> (int N) const </td></tr>
170<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples, <img class="formulaInl" alt="$ [x_1 , x_2 , \ldots \ $" src="form_9.png"/> from density <img class="formulaInl" alt="$ f_x(rv)$" src="form_10.png"/>. <br/></td></tr>
171<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a7705e80601957f7226d333a0a6d539"></a><!-- doxytag: member="bdm::elognorm::qbounds" ref="a0a7705e80601957f7226d333a0a6d539" args="(vec &amp;lb, vec &amp;ub, double percentage=0.95) const " -->
172virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a0a7705e80601957f7226d333a0a6d539">qbounds</a> (vec &amp;lb, vec &amp;ub, double percentage=0.95) const </td></tr>
173<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>
174<tr><td colspan="2"><div class="groupHeader">Connection to other classes</div></td></tr>
175<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp14fc6e1cb822e9dfc5edc16c20fabe11"></a> 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: </p>
176<br/><br/></div></td></tr>
177<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af423e28448dbb69ef4905295ec8de8ff"></a><!-- doxytag: member="bdm::elognorm::set_rv" ref="af423e28448dbb69ef4905295ec8de8ff" args="(const RV &amp;rv0)" -->
178void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#af423e28448dbb69ef4905295ec8de8ff">set_rv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
179<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name its rv. <br/></td></tr>
180<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4b863ff84c7a4882fb3ad18556027f9"></a><!-- doxytag: member="bdm::elognorm::isnamed" ref="ac4b863ff84c7a4882fb3ad18556027f9" args="() const " -->
181bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#ac4b863ff84c7a4882fb3ad18556027f9">isnamed</a> () const </td></tr>
182<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if rv is assigned. <br/></td></tr>
183<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4ab378d5e004c3ff3e2d4e64f7bba21"></a><!-- doxytag: member="bdm::elognorm::_rv" ref="aa4ab378d5e004c3ff3e2d4e64f7bba21" args="() const " -->
184const <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#aa4ab378d5e004c3ff3e2d4e64f7bba21">_rv</a> () const </td></tr>
185<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return name (fails when isnamed is false). <br/></td></tr>
186<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
187<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb6eb094f9e6af11f8a7d9efa9d8e3623"></a> </p>
188<br/><br/></div></td></tr>
189<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7083a65f7b7a0d0d13b2c516bd2ec29c"></a><!-- doxytag: member="bdm::elognorm::dimension" ref="a7083a65f7b7a0d0d13b2c516bd2ec29c" args="() const " -->
190int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a7083a65f7b7a0d0d13b2c516bd2ec29c">dimension</a> () const </td></tr>
191<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the random variable. <br/></td></tr>
192<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
193<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac702a194720853570d08b65482f842c7"></a><!-- doxytag: member="bdm::elognorm::mu" ref="ac702a194720853570d08b65482f842c7" args="" -->
194vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#ac702a194720853570d08b65482f842c7">mu</a></td></tr>
195<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mean value <br/></td></tr>
196<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d92dde696b2a7a5b10ddef5d22ba2c2"></a><!-- doxytag: member="bdm::elognorm::R" ref="a2d92dde696b2a7a5b10ddef5d22ba2c2" args="" -->
197<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#a2d92dde696b2a7a5b10ddef5d22ba2c2">R</a></td></tr>
198<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Covariance matrix in decomposed form. <br/></td></tr>
199<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::elognorm::dim" ref="a16adac20ec7fe07e1ea0b27d917788ce" args="" -->
200int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a16adac20ec7fe07e1ea0b27d917788ce">dim</a></td></tr>
201<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the random variable <br/></td></tr>
202<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62c5b8ff71d9ebe6cd58d3c342eb1dc8"></a><!-- doxytag: member="bdm::elognorm::rv" ref="a62c5b8ff71d9ebe6cd58d3c342eb1dc8" args="" -->
203<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#a62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a></td></tr>
204<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the random variable. <br/></td></tr>
205</table>
206<hr/><a name="_details"></a><h2>Detailed Description</h2>
207<p>Log-Normal probability density only allow diagonal covariances!</p>
208<p>Density of the form <img class="formulaInl" alt="$ \log(x)\sim \mathcal{N}(\mu,\sigma^2) $" src="form_87.png"/> , i.e. </p>
209<p class="formulaDsp">
210<img class="formulaDsp" alt="\[ x \sim \frac{1}{x\sigma\sqrt{2\pi}}\exp{-\frac{1}{2\sigma^2}(\log(x)-\mu)} \]" src="form_88.png"/>
211</p>
212 <hr/><h2>Member Function Documentation</h2>
213<a class="anchor" id="a61bd470764020bea6e1ed35000f259e6"></a><!-- doxytag: member="bdm::elognorm::from_setting" ref="a61bd470764020bea6e1ed35000f259e6" args="(const Setting &amp;root)" -->
214<div class="memitem">
215<div class="memproto">
216      <table class="memname">
217        <tr>
218          <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>
219          <td>(</td>
220          <td class="paramtype">const Setting &amp;&nbsp;</td>
221          <td class="paramname"> <em>set</em></td>
222          <td>&nbsp;)&nbsp;</td>
223          <td><code> [virtual, inherited]</code></td>
224        </tr>
225      </table>
226</div>
227<div class="memdoc">
228<p>Load from structure with elements: </p>
229<div class="fragment"><pre class="fragment"> { <a class="code" href="classbdm_1_1epdf.html#a62c5b8ff71d9ebe6cd58d3c342eb1dc8" title="Description of the random variable.">rv</a> = {<span class="keyword">class</span>=<span class="stringliteral">&quot;RV&quot;</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable</span>
230   <span class="comment">// elements of offsprings</span>
231 }
232</pre></div> 
233<p>Reimplemented from <a class="el" href="classbdm_1_1epdf.html#afa9efc98a065b31c630fe18cc418f725">bdm::epdf</a>.</p>
234
235</div>
236</div>
237<hr/>The documentation for this class was generated from the following file:<ul>
238<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a></li>
239</ul>
240</div>
241<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:51 2009 for mixpp by&nbsp;
242<a href="http://www.doxygen.org/index.html">
243<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
244</body>
245</html>
Note: See TracBrowser for help on using the browser.