root/library/doc/html/mat__checks_8h-source.html @ 541

Revision 538, 14.8 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: mat_checks.h Source File</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><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<h1>mat_checks.h</h1><a href="mat__checks_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
65<a name="l00013"></a>00013 <span class="preprocessor">#ifndef MAT_CHECKS_H</span>
66<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define MAT_CHECKS_H</span>
67<a name="l00015"></a>00015 <span class="preprocessor"></span>
68<a name="l00016"></a>00016 <span class="preprocessor">#include "../bdm/itpp_ext.h"</span>
69<a name="l00017"></a>00017 <span class="preprocessor">#include "UnitTest++.h"</span>
70<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;string&gt;</span>
71<a name="l00019"></a>00019
72<a name="l00020"></a>00020 <span class="keyword">namespace </span>UnitTest {
73<a name="l00021"></a>00021
74<a name="l00022"></a>00022 <span class="keywordtype">bool</span> AreClose ( <span class="keyword">const</span> itpp::vec &amp;expected, <span class="keyword">const</span> itpp::vec &amp;actual,
75<a name="l00023"></a>00023                 <span class="keywordtype">double</span> tolerance );
76<a name="l00024"></a>00024
77<a name="l00025"></a>00025 <span class="keywordtype">bool</span> AreClose ( <span class="keyword">const</span> itpp::vec &amp;expected, <span class="keyword">const</span> itpp::vec &amp;actual,
78<a name="l00026"></a>00026                 <span class="keyword">const</span> itpp::vec &amp;tolerance );
79<a name="l00027"></a>00027
80<a name="l00028"></a>00028 <span class="keywordtype">bool</span> AreClose ( <span class="keyword">const</span> itpp::mat &amp;expected, <span class="keyword">const</span> itpp::mat &amp;actual,
81<a name="l00029"></a>00029                 <span class="keywordtype">double</span> tolerance );
82<a name="l00030"></a>00030
83<a name="l00031"></a>00031 <span class="keyword">inline</span> <span class="keywordtype">void</span> CheckClose ( TestResults &amp;results, <span class="keyword">const</span> itpp::vec &amp;expected,
84<a name="l00032"></a>00032                          <span class="keyword">const</span> itpp::vec &amp;actual, <span class="keywordtype">double</span> tolerance,
85<a name="l00033"></a>00033                          TestDetails <span class="keyword">const</span> &amp;details ) {
86<a name="l00034"></a>00034         <span class="keywordflow">if</span> ( !AreClose ( expected, actual, tolerance ) ) {
87<a name="l00035"></a>00035                 MemoryOutStream stream;
88<a name="l00036"></a>00036                 stream &lt;&lt; <span class="stringliteral">"Expected "</span> &lt;&lt; expected &lt;&lt; <span class="stringliteral">" +/- "</span> &lt;&lt; tolerance &lt;&lt; <span class="stringliteral">" but was "</span> &lt;&lt; actual;
89<a name="l00037"></a>00037
90<a name="l00038"></a>00038                 results.OnTestFailure ( details, stream.GetText() );
91<a name="l00039"></a>00039         }
92<a name="l00040"></a>00040 }
93<a name="l00041"></a>00041
94<a name="l00042"></a>00042 <span class="keyword">inline</span> <span class="keywordtype">void</span> CheckClose ( TestResults &amp;results, <span class="keyword">const</span> itpp::mat &amp;expected,
95<a name="l00043"></a>00043                          <span class="keyword">const</span> itpp::mat &amp;actual, <span class="keywordtype">double</span> tolerance,
96<a name="l00044"></a>00044                          TestDetails <span class="keyword">const</span> &amp;details ) {
97<a name="l00045"></a>00045         <span class="keywordflow">if</span> ( !AreClose ( expected, actual, tolerance ) ) {
98<a name="l00046"></a>00046                 MemoryOutStream stream;
99<a name="l00047"></a>00047                 stream &lt;&lt; <span class="stringliteral">"Expected "</span> &lt;&lt; expected &lt;&lt; <span class="stringliteral">" +/- "</span> &lt;&lt; tolerance &lt;&lt; <span class="stringliteral">" but was "</span> &lt;&lt; actual;
100<a name="l00048"></a>00048
101<a name="l00049"></a>00049                 results.OnTestFailure ( details, stream.GetText() );
102<a name="l00050"></a>00050         }
103<a name="l00051"></a>00051 }
104<a name="l00052"></a>00052
105<a name="l00053"></a>00053 }
106<a name="l00054"></a>00054
107<a name="l00057"></a><a class="code" href="mat__checks_8h.html#07a4fc41bbcce7c2914a9cf270d8f485">00057</a> <span class="keyword">inline</span> itpp::vec <a class="code" href="mat__checks_8h.html#07a4fc41bbcce7c2914a9cf270d8f485">make_close_tolerance</a> ( <span class="keyword">const</span> itpp::vec &amp; variance, <span class="keywordtype">int</span> nsamples ) {
108<a name="l00058"></a>00058         <span class="comment">// simplify overloading for Visual Studio</span>
109<a name="l00059"></a>00059         <span class="keywordflow">return</span> 2 * ( sqrt ( variance ) / sqrt ( static_cast&lt;double&gt; ( nsamples ) ) );
110<a name="l00060"></a>00060 }
111<a name="l00061"></a>00061
112<a name="l00064"></a><a class="code" href="classCurrentContext.html">00064</a> <span class="keyword">class </span><a class="code" href="classCurrentContext.html">CurrentContext</a> {
113<a name="l00065"></a>00065 <span class="keyword">public</span>:
114<a name="l00066"></a>00066         <span class="comment">// how many times to repeat a failing test before reporting</span>
115<a name="l00067"></a>00067         <span class="comment">// failure</span>
116<a name="l00068"></a>00068         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> max_trial_count = 3;
117<a name="l00069"></a>00069
118<a name="l00070"></a>00070 <span class="keyword">private</span>:
119<a name="l00071"></a>00071         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *config_name;
120<a name="l00072"></a>00072         <span class="keyword">static</span> <span class="keywordtype">int</span> index;
121<a name="l00073"></a>00073
122<a name="l00074"></a>00074 <span class="keyword">public</span>:
123<a name="l00075"></a>00075         <span class="comment">// the pointer must stay valid for the lifetime of the object</span>
124<a name="l00076"></a>00076         <a class="code" href="classCurrentContext.html">CurrentContext</a> ( <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> idx );
125<a name="l00077"></a>00077         ~<a class="code" href="classCurrentContext.html">CurrentContext</a>();
126<a name="l00078"></a>00078
127<a name="l00079"></a>00079         <span class="comment">/* Should be called only in blocks having an instance of</span>
128<a name="l00080"></a>00080 <span class="comment">           CurrentContext. The argument, when not default, should be</span>
129<a name="l00081"></a>00081 <span class="comment">           __LINE__ (and it is included in the returned string).</span>
130<a name="l00082"></a>00082 <span class="comment">        */</span>
131<a name="l00083"></a>00083         <span class="keyword">static</span> std::string format_context( <span class="keywordtype">int</span> ln = -1 );
132<a name="l00084"></a>00084
133<a name="l00085"></a>00085         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Expected, <span class="keyword">typename</span> Actual&gt;
134<a name="l00086"></a>00086         <span class="keyword">static</span> <span class="keywordtype">void</span> CheckEqualEx ( UnitTest::TestResults&amp; results,
135<a name="l00087"></a>00087                                    Expected <span class="keyword">const</span>&amp; expected,
136<a name="l00088"></a>00088                                    Actual <span class="keyword">const</span>&amp; actual,
137<a name="l00089"></a>00089                                    UnitTest::TestDetails <span class="keyword">const</span>&amp; details ) {
138<a name="l00090"></a>00090                 <span class="keywordflow">if</span> ( ! ( expected == actual ) ) {
139<a name="l00091"></a>00091                         UnitTest::MemoryOutStream stream;
140<a name="l00092"></a>00092                         stream &lt;&lt; format_context() &lt;&lt; <span class="stringliteral">"expected "</span> &lt;&lt; expected &lt;&lt; <span class="stringliteral">" but was "</span> &lt;&lt; actual;
141<a name="l00093"></a>00093
142<a name="l00094"></a>00094                         results.OnTestFailure ( details, stream.GetText() );
143<a name="l00095"></a>00095                 }
144<a name="l00096"></a>00096         }
145<a name="l00097"></a>00097
146<a name="l00098"></a>00098         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Expected, <span class="keyword">typename</span> Actual, <span class="keyword">typename</span> Tolerance&gt;
147<a name="l00099"></a>00099         <span class="keyword">static</span> <span class="keywordtype">void</span> CheckCloseEx ( UnitTest::TestResults&amp; results,
148<a name="l00100"></a>00100                                    Expected <span class="keyword">const</span>&amp; expected,
149<a name="l00101"></a>00101                                    Actual <span class="keyword">const</span>&amp; actual,
150<a name="l00102"></a>00102                                    Tolerance <span class="keyword">const</span>&amp; tolerance,
151<a name="l00103"></a>00103                                    UnitTest::TestDetails <span class="keyword">const</span>&amp; details ) {
152<a name="l00104"></a>00104                 <span class="keywordflow">if</span> ( !UnitTest::AreClose ( expected, actual, tolerance ) ) {
153<a name="l00105"></a>00105                         UnitTest::MemoryOutStream stream;
154<a name="l00106"></a>00106                         stream &lt;&lt; format_context() &lt;&lt; <span class="stringliteral">"expected "</span> &lt;&lt; expected &lt;&lt; <span class="stringliteral">" +/- "</span> &lt;&lt; tolerance &lt;&lt; <span class="stringliteral">" but was "</span> &lt;&lt; actual;
155<a name="l00107"></a>00107
156<a name="l00108"></a>00108                         results.OnTestFailure ( details, stream.GetText() );
157<a name="l00109"></a>00109                 }
158<a name="l00110"></a>00110         }
159<a name="l00111"></a>00111 };
160<a name="l00112"></a>00112
161<a name="l00113"></a>00113 <span class="preprocessor">#define CHECK_EQUAL_EX(expected, actual) \</span>
162<a name="l00114"></a>00114 <span class="preprocessor">    do \</span>
163<a name="l00115"></a>00115 <span class="preprocessor">    { \</span>
164<a name="l00116"></a>00116 <span class="preprocessor">        try { \</span>
165<a name="l00117"></a>00117 <span class="preprocessor">            CurrentContext::CheckEqualEx(*UnitTest::CurrentTest::Results(), expected, actual, UnitTest::TestDetails(*UnitTest::CurrentTest::Details(), 0, false)); \</span>
166<a name="l00118"></a>00118 <span class="preprocessor">        } \</span>
167<a name="l00119"></a>00119 <span class="preprocessor">        catch (...) { \</span>
168<a name="l00120"></a>00120 <span class="preprocessor">            UnitTest::CurrentTest::Results()-&gt;OnTestFailure(UnitTest::TestDetails(*UnitTest::CurrentTest::Details(), __LINE__), \</span>
169<a name="l00121"></a>00121 <span class="preprocessor">                    "Unhandled exception in CHECK_EQUAL_EX(" #expected ", " #actual ")"); \</span>
170<a name="l00122"></a>00122 <span class="preprocessor">        } \</span>
171<a name="l00123"></a>00123 <span class="preprocessor">    } while (0)</span>
172<a name="l00124"></a>00124 <span class="preprocessor"></span>
173<a name="l00125"></a>00125
174<a name="l00126"></a>00126 <span class="preprocessor">#define CHECK_CLOSE_EX(expected, actual, tolerance) \</span>
175<a name="l00127"></a>00127 <span class="preprocessor">    do \</span>
176<a name="l00128"></a>00128 <span class="preprocessor">    { \</span>
177<a name="l00129"></a>00129 <span class="preprocessor">        try { \</span>
178<a name="l00130"></a>00130 <span class="preprocessor">            CurrentContext::CheckCloseEx(*UnitTest::CurrentTest::Results(), expected, actual, tolerance, UnitTest::TestDetails(*UnitTest::CurrentTest::Details(), 0, false)); \</span>
179<a name="l00131"></a>00131 <span class="preprocessor">        } \</span>
180<a name="l00132"></a>00132 <span class="preprocessor">        catch (...) { \</span>
181<a name="l00133"></a>00133 <span class="preprocessor">            UnitTest::CurrentTest::Results()-&gt;OnTestFailure(UnitTest::TestDetails(*UnitTest::CurrentTest::Details(), __LINE__), \</span>
182<a name="l00134"></a>00134 <span class="preprocessor">                    "Unhandled exception in CHECK_CLOSE_EX(" #expected ", " #actual ")"); \</span>
183<a name="l00135"></a>00135 <span class="preprocessor">        } \</span>
184<a name="l00136"></a>00136 <span class="preprocessor">    } while (0)</span>
185<a name="l00137"></a>00137 <span class="preprocessor"></span>
186<a name="l00138"></a>00138 <span class="preprocessor">#endif</span>
187</pre></div></div>
188<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 15 17:40:58 2009 for mixpp by&nbsp;
189<a href="http://www.doxygen.org/index.html">
190<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
191</body>
192</html>
Note: See TracBrowser for help on using the browser.