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

Revision 651, 16.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: bdmerror.h File 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><a href="annotated.html"><span>Classes</span></a></li>
55      <li class="current"><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
61      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
62    </ul>
63  </div>
64</div>
65<div class="contents">
66<h1>bdmerror.h File Reference</h1>BDM's exception-throwing macros. 
67<a href="#_details">More...</a>
68<p>
69<code>#include &lt;sstream&gt;</code><br>
70<code>#include &lt;string&gt;</code><br>
71
72<p>
73<a href="bdmerror_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
74<tr><td></td></tr>
75<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdmerror_8h.html#7a3399d182b8e3065532596e76f84849">bdm_assert</a>(t, s)</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Throw std::runtime_exception if <code>t</code> is not true.  <a href="#7a3399d182b8e3065532596e76f84849"></a><br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89a0f906b242b79c5d3d342291b2cab4"></a><!-- doxytag: member="bdmerror.h::bdm_assert_debug" ref="89a0f906b242b79c5d3d342291b2cab4" args="(t, s)" -->
80#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdmerror_8h.html#89a0f906b242b79c5d3d342291b2cab4">bdm_assert_debug</a>(t, s)&nbsp;&nbsp;&nbsp;bdm_assert(t, s)</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Throw std::runtime_exception if <code>t</code> is not true and NDEBUG is not defined. <br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdmerror_8h.html#7c43f3a72afe68ab0c85663a1bb3521a">bdm_error</a>(s)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unconditionally throw std::runtime_error.  <a href="#7c43f3a72afe68ab0c85663a1bb3521a"></a><br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdmerror_8h.html#59c5a63b3878ebcd6cc952fc2b47191c">bdm_warning</a>(s)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Display a warning message.  <a href="#59c5a63b3878ebcd6cc952fc2b47191c"></a><br></td></tr>
89<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="390920d0fe065ba8f3b5dc294bc6b8ef"></a><!-- doxytag: member="bdmerror.h::bdm_assert_f" ref="390920d0fe065ba8f3b5dc294bc6b8ef" args="(const std::string &amp;ass, const std::string &amp;msg, const std::string &amp;file, int line)" -->
91void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebdm.html#390920d0fe065ba8f3b5dc294bc6b8ef">bdm::bdm_assert_f</a> (const std::string &amp;ass, const std::string &amp;msg, const std::string &amp;file, int line)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function for the <code>bdm_assert</code> and <code>bdm_assert_debug</code> macros. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c957bac1f6a211cd4880f6230e40fcf9"></a><!-- doxytag: member="bdmerror.h::bdm_error_f" ref="c957bac1f6a211cd4880f6230e40fcf9" args="(const std::string &amp;msg, const std::string &amp;file, int line)" -->
95void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebdm.html#c957bac1f6a211cd4880f6230e40fcf9">bdm::bdm_error_f</a> (const std::string &amp;msg, const std::string &amp;file, int line)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function for the <code>bdm_error</code> macro. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bce5d74b6efd46263ad2acc488ae961"></a><!-- doxytag: member="bdmerror.h::bdm_warning_f" ref="3bce5d74b6efd46263ad2acc488ae961" args="(const std::string &amp;msg, const std::string &amp;file, int line)" -->
99void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebdm.html#3bce5d74b6efd46263ad2acc488ae961">bdm::bdm_warning_f</a> (const std::string &amp;msg, const std::string &amp;file, int line)</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function for the <code>bdm_warning</code> macro. <br></td></tr>
102</table>
103<hr><h2>Detailed Description</h2>
104BDM's exception-throwing macros.
105<p>
106<dl class="author" compact><dt><b>Author:</b></dt><dd>Vaclav Barta.</dd></dl>
107----------------------------------- BDM++ - C++ library for Bayesian Decision Making under Uncertainty<p>
108Using IT++ for numerical operations ----------------------------------- <hr><h2>Define Documentation</h2>
109<a class="anchor" name="7a3399d182b8e3065532596e76f84849"></a><!-- doxytag: member="bdmerror.h::bdm_assert" ref="7a3399d182b8e3065532596e76f84849" args="(t, s)" -->
110<div class="memitem">
111<div class="memproto">
112      <table class="memname">
113        <tr>
114          <td class="memname">#define bdm_assert          </td>
115          <td>(</td>
116          <td class="paramtype">t,         <tr>
117          <td class="paramkey"></td>
118          <td></td>
119          <td class="paramtype">s&nbsp;</td>
120          <td class="paramname">          </td>
121          <td>&nbsp;)&nbsp;</td>
122          <td></td>
123        </tr>
124      </table>
125</div>
126<div class="memdoc">
127
128<p>
129<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">if</span> (!(t)) { \
130                std::ostringstream bdm_out; \
131                bdm_out &lt;&lt; s; \
132                bdm::bdm_assert_f(#t, bdm_out.str(), __FILE__, __LINE__); \
133        } <span class="keywordflow">else</span> ((<span class="keywordtype">void</span>) 0)
134</pre></div>Throw std::runtime_exception if <code>t</code> is not true.
135<p>
136
137<p>Referenced by <a class="el" href="emix_8cpp_source.html#l00056">bdm::emix::condition()</a>, <a class="el" href="kalman_8h_source.html#l00380">bdm::StateCanonical::connect_mlnorm()</a>, <a class="el" href="datasources_8h_source.html#l00127">bdm::EpdfDS::from_setting()</a>, <a class="el" href="bdmbase_8h_source.html#l00998">bdm::DS::log_add()</a>, <a class="el" href="loggers_8h_source.html#l00050">bdm::memlog::logit()</a>, <a class="el" href="emix_8cpp_source.html#l00045">bdm::emix::marginal()</a>, <a class="el" href="bdmbase_8h_source.html#l00184">bdm::RV::scalarname()</a>, <a class="el" href="bdmbase_8h_source.html#l00754">bdm::datalink_buffered::set_history()</a>, <a class="el" href="functions_8h_source.html#l00125">bdm::bilinfn::set_parameters()</a>, <a class="el" href="exp__family_8h_source.html#l01247">bdm::eEmp::set_parameters()</a>, <a class="el" href="emix_8cpp_source.html#l00005">bdm::emix::set_parameters()</a>, <a class="el" href="bdmbase_8h_source.html#l00036">bdm::str::str()</a>, <a class="el" href="particles_8h_source.html#l00181">bdm::PF::validate()</a>, <a class="el" href="merger_8h_source.html#l00283">bdm::merger_base::validate()</a>, <a class="el" href="exp__family_8h_source.html#l00811">bdm::mlstudent::validate()</a>, <a class="el" href="exp__family_8h_source.html#l00762">bdm::mgnorm&lt; sq_T &gt;::validate()</a>, <a class="el" href="exp__family_8h_source.html#l00701">bdm::mlnorm&lt; ldmat, enorm &gt;::validate()</a>, <a class="el" href="exp__family_8h_source.html#l00626">bdm::euni::validate()</a>, <a class="el" href="exp__family_8h_source.html#l00512">bdm::egamma::validate()</a>, <a class="el" href="exp__family_8h_source.html#l00398">bdm::mDirich::validate()</a>, <a class="el" href="exp__family_8h_source.html#l00146">bdm::enorm&lt; fsqmat &gt;::validate()</a>, and <a class="el" href="arx_8h_source.html#l00176">bdm::ARX::validate()</a>.</p>
138
139</div>
140</div><p>
141<a class="anchor" name="7c43f3a72afe68ab0c85663a1bb3521a"></a><!-- doxytag: member="bdmerror.h::bdm_error" ref="7c43f3a72afe68ab0c85663a1bb3521a" args="(s)" -->
142<div class="memitem">
143<div class="memproto">
144      <table class="memname">
145        <tr>
146          <td class="memname">#define bdm_error          </td>
147          <td>(</td>
148          <td class="paramtype">s&nbsp;</td>
149          <td class="paramname">          </td>
150          <td>&nbsp;)&nbsp;</td>
151          <td></td>
152        </tr>
153      </table>
154</div>
155<div class="memdoc">
156
157<p>
158<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">if</span> (<span class="keyword">true</span>) { \
159                std::ostringstream bdm_out; \
160                bdm_out &lt;&lt; s; \
161                bdm::bdm_error_f(bdm_out.str(), __FILE__, __LINE__); \
162        } <span class="keywordflow">else</span> ((<span class="keywordtype">void</span>) 0)
163</pre></div>Unconditionally throw std::runtime_error.
164<p>
165
166<p>Referenced by <a class="el" href="exp__family_8h_source.html#l00107">bdm::BMEF::_copy_()</a>, <a class="el" href="ctrlbase_8h_source.html#l00028">bdm::Designer::apply()</a>, <a class="el" href="kalman_8h_source.html#l00313">bdm::MultiModel::bayes()</a>, <a class="el" href="particles_8cpp_source.html#l00015">bdm::PF::bayes_weights()</a>, <a class="el" href="chmat_8h_source.html#l00085">bdm::chmat::chmat()</a>, <a class="el" href="square__mat_8h_source.html#l00092">bdm::sqmat::clear()</a>, <a class="el" href="bdmbase_8h_source.html#l01131">bdm::BM::condition()</a>, <a class="el" href="bdmbase_8h_source.html#l00576">bdm::mpdf_internal&lt; eDirich &gt;::condition()</a>, <a class="el" href="bdmbase_8h_source.html#l01107">bdm::BM::epredictor()</a>, <a class="el" href="exp__family_8cpp_source.html#l00090">bdm::egiw::est_theta()</a>, <a class="el" href="exp__family_8cpp_source.html#l00106">bdm::egiw::est_theta_cov()</a>, <a class="el" href="exp__family_8h_source.html#l01278">bdm::eEmp::evallog()</a>, <a class="el" href="bdmbase_8h_source.html#l00369">bdm::epdf::evallog()</a>, <a class="el" href="exp__family_8h_source.html#l00048">bdm::eEF::evallog_nn()</a>, <a class="el" href="bdmbase_8h_source.html#l00498">bdm::mpdf::evallogcond()</a>, <a class="el" href="bdmbase_8h_source.html#l00513">bdm::mpdf::evallogcond_m()</a>, <a class="el" href="exp__family_8h_source.html#l00103">bdm::BMEF::flatten()</a>, <a class="el" href="datasources_8h_source.html#l00186">bdm::MpdfDS::from_setting()</a>, <a class="el" href="square__mat_8h_source.html#l00146">bdm::fsqmat::fsqmat()</a>, <a class="el" href="bdmbase_8h_source.html#l00973">bdm::DS::getdata()</a>, <a class="el" href="square__mat_8h_source.html#l00086">bdm::sqmat::invqform()</a>, <a class="el" href="square__mat_8h_source.html#l00067">bdm::sqmat::logdet()</a>, <a class="el" href="bdmbase_8h_source.html#l00875">bdm::logger::logit()</a>, <a class="el" href="bdmbase_8h_source.html#l01092">bdm::BM::logpred()</a>, <a class="el" href="bdmbase_8h_source.html#l00387">bdm::epdf::mean()</a>, <a class="el" href="merger_8h_source.html#l00182">bdm::merger_base::merge()</a>, <a class="el" href="emix_8h_source.html#l00054">bdm::mratio::mratio()</a>, <a class="el" href="square__mat_8h_source.html#l00055">bdm::sqmat::mult_sym()</a>, <a class="el" href="square__mat_8h_source.html#l00060">bdm::sqmat::mult_sym_t()</a>, <a class="el" href="square__mat_8h_source.html#l00045">bdm::sqmat::opupdt()</a>, <a class="el" href="exp__family_8h_source.html#l00073">bdm::eEF::pow()</a>, <a class="el" href="bdmbase_8h_source.html#l01112">bdm::BM::predictor()</a>, <a class="el" href="square__mat_8h_source.html#l00080">bdm::sqmat::qform()</a>, <a class="el" href="ctrlbase_8h_source.html#l00023">bdm::Designer::redesign()</a>, <a class="el" href="exp__family_8cpp_source.html#l00265">bdm::eEmp::resample()</a>, <a class="el" href="particles_8h_source.html#l00142">bdm::PF::resmethod_from_set()</a>, <a class="el" href="exp__family_8h_source.html#l01272">bdm::eEmp::sample()</a>, <a class="el" href="bdmbase_8h_source.html#l00359">bdm::epdf::sample()</a>, <a class="el" href="bdmbase_8h_source.html#l00489">bdm::mpdf::samplecond()</a>, <a class="el" href="user__info_8cpp_source.html#l00047">bdm::UIFile::save()</a>, <a class="el" href="emix_8cpp_source.html#l00062">bdm::egiwmix::set_parameters()</a>, <a class="el" href="exp__family_8h_source.html#l00093">bdm::BMEF::set_statistics()</a>, <a class="el" href="square__mat_8h_source.html#l00074">bdm::sqmat::sqrt_mult()</a>, <a class="el" href="loggers_8h_source.html#l00045">bdm::memlog::step()</a>, <a class="el" href="bdmbase_8h_source.html#l00992">bdm::DS::step()</a>, <a class="el" href="bdmbase_8h_source.html#l00884">bdm::logger::step()</a>, <a class="el" href="square__mat_8h_source.html#l00050">bdm::sqmat::to_mat()</a>, <a class="el" href="user__info_8cpp_source.html#l00029">bdm::UIFile::UIFile()</a>, <a class="el" href="bdmbase_8h_source.html#l00393">bdm::epdf::variance()</a>, <a class="el" href="datasources_8h_source.html#l00044">bdm::MemDS::write()</a>, and <a class="el" href="bdmbase_8h_source.html#l00982">bdm::DS::write()</a>.</p>
167
168</div>
169</div><p>
170<a class="anchor" name="59c5a63b3878ebcd6cc952fc2b47191c"></a><!-- doxytag: member="bdmerror.h::bdm_warning" ref="59c5a63b3878ebcd6cc952fc2b47191c" args="(s)" -->
171<div class="memitem">
172<div class="memproto">
173      <table class="memname">
174        <tr>
175          <td class="memname">#define bdm_warning          </td>
176          <td>(</td>
177          <td class="paramtype">s&nbsp;</td>
178          <td class="paramname">          </td>
179          <td>&nbsp;)&nbsp;</td>
180          <td></td>
181        </tr>
182      </table>
183</div>
184<div class="memdoc">
185
186<p>
187<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">if</span> (<span class="keyword">true</span>) { \
188                std::ostringstream bdm_out; \
189                bdm_out &lt;&lt; s; \
190                bdm::bdm_warning_f(bdm_out.str(), __FILE__, __LINE__); \
191        } <span class="keywordflow">else</span> ((<span class="keywordtype">void</span>) 0)
192</pre></div>Display a warning message.
193<p>
194
195<p>Referenced by <a class="el" href="chmat_8h_source.html#l00045">bdm::chmat::add()</a>, <a class="el" href="kalman_8cpp_source.html#l00182">bdm::EKFCh::bayes()</a>, <a class="el" href="kalman_8cpp_source.html#l00105">bdm::KalmanCh::bayes()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00148">bdm::epdf::condition()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00153">bdm::epdf::marginal()</a>, <a class="el" href="chmat_8cpp_source.html#l00025">bdm::chmat::mult_sym()</a>, <a class="el" href="chmat_8cpp_source.html#l00039">bdm::chmat::mult_sym_t()</a>, <a class="el" href="ctrlbase_8h_source.html#l00095">bdm::LQG::ricatti_step()</a>, and <a class="el" href="exp__family_8cpp_source.html#l00034">bdm::egiw::sample()</a>.</p>
196
197</div>
198</div><p>
199</div>
200<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:44 2009 for mixpp by&nbsp;
201<a href="http://www.doxygen.org/index.html">
202<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
203</body>
204</html>
Note: See TracBrowser for help on using the browser.