125 lines
16 KiB
HTML
125 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
<meta name="generator" content="Doxygen 1.8.11"/>
|
||
<title>mlpack: src/mlpack/core/util/log.hpp Source File</title>
|
||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
<script type="text/javascript" src="jquery.js"></script>
|
||
<script type="text/javascript" src="dynsections.js"></script>
|
||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
<script type="text/javascript" src="search/search.js"></script>
|
||
<script type="text/javascript">
|
||
$(document).ready(function() { init_search(); });
|
||
</script>
|
||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
<link href="extra-stylesheet.css" rel="stylesheet" type="text/css"/>
|
||
</head>
|
||
<body>
|
||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
<div id="titlearea">
|
||
<table cellspacing="0" cellpadding="0">
|
||
<tbody>
|
||
<tr style="height: 56px;">
|
||
<td id="projectalign" style="padding-left: 0.5em;">
|
||
<div id="projectname">mlpack
|
||
 <span id="projectnumber">master</span>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- Generated by Doxygen 1.8.11 -->
|
||
<script type="text/javascript">
|
||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
</script>
|
||
<div id="navrow1" class="tabs">
|
||
<ul class="tablist">
|
||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||
<li>
|
||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
<span class="left">
|
||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
alt=""/>
|
||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
</span><span class="right">
|
||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
</span>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div id="navrow2" class="tabs2">
|
||
<ul class="tablist">
|
||
<li><a href="files.html"><span>File List</span></a></li>
|
||
<li><a href="globals.html"><span>File Members</span></a></li>
|
||
</ul>
|
||
</div>
|
||
<!-- window showing the filter options -->
|
||
<div id="MSearchSelectWindow"
|
||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
</div>
|
||
|
||
<!-- iframe showing the search results (closed by default) -->
|
||
<div id="MSearchResultsWindow">
|
||
<iframe src="javascript:void(0)" frameborder="0"
|
||
name="MSearchResults" id="MSearchResults">
|
||
</iframe>
|
||
</div>
|
||
|
||
<div id="nav-path" class="navpath">
|
||
<ul>
|
||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_44a936ef30fc126706c6284a2fc0c990.html">mlpack</a></li><li class="navelem"><a class="el" href="dir_f7ac9cdfd28b2e882eb44d163e3b98b4.html">core</a></li><li class="navelem"><a class="el" href="dir_e173a4984165953811b5143e3b27486f.html">util</a></li> </ul>
|
||
</div>
|
||
</div><!-- top -->
|
||
<div class="header">
|
||
<div class="headertitle">
|
||
<div class="title">log.hpp</div> </div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<a href="log_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef MLPACK_CORE_UTIL_LOG_HPP</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define MLPACK_CORE_UTIL_LOG_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <mlpack/mlpack_export.hpp></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="prefixedoutstream_8hpp.html">prefixedoutstream.hpp</a>"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="nulloutstream_8hpp.html">nulloutstream.hpp</a>"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classmlpack_1_1Log.html"> 56</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1Log.html">Log</a></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1Log.html#a894b6a6ce578301d1d4404416e8496d3">Assert</a>(<span class="keywordtype">bool</span> condition,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> <a class="code" href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">std::string</a>& message = <span class="stringliteral">"Assert Failed."</span>);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// We only use PrefixedOutStream if the program is compiled with debug</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// symbols.</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#ifdef DEBUG</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">static</span> MLPACK_EXPORT <a class="code" href="classmlpack_1_1util_1_1PrefixedOutStream.html">util::PrefixedOutStream</a> <a class="code" href="classmlpack_1_1Log.html#a80ba817a1abcf742c7463b1e74bf55da">Debug</a>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">static</span> MLPACK_EXPORT <a class="code" href="classmlpack_1_1util_1_1NullOutStream.html">util::NullOutStream</a> <a class="code" href="classmlpack_1_1Log.html#a80ba817a1abcf742c7463b1e74bf55da">Debug</a>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classmlpack_1_1Log.html#a403428883bc3b47cf96924abb6a40adf"> 84</a></span>  <span class="keyword">static</span> MLPACK_EXPORT <a class="code" href="classmlpack_1_1util_1_1PrefixedOutStream.html">util::PrefixedOutStream</a> <a class="code" href="classmlpack_1_1Log.html#a403428883bc3b47cf96924abb6a40adf">Info</a>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classmlpack_1_1Log.html#abbf3c5ac36654c0a8f17be3549388b38"> 87</a></span>  <span class="keyword">static</span> MLPACK_EXPORT <a class="code" href="classmlpack_1_1util_1_1PrefixedOutStream.html">util::PrefixedOutStream</a> <a class="code" href="classmlpack_1_1Log.html#abbf3c5ac36654c0a8f17be3549388b38">Warn</a>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classmlpack_1_1Log.html#a396b80849caab1ec8a856f9d06c31a1d"> 90</a></span>  <span class="keyword">static</span> MLPACK_EXPORT <a class="code" href="classmlpack_1_1util_1_1PrefixedOutStream.html">util::PrefixedOutStream</a> <a class="code" href="classmlpack_1_1Log.html#a396b80849caab1ec8a856f9d06c31a1d">Fatal</a>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classmlpack_1_1Log.html#aaae645acd77959d7754961f7292bc8c6"> 93</a></span>  <span class="keyword">static</span> std::ostream& <a class="code" href="classmlpack_1_1Log.html#aaae645acd77959d7754961f7292bc8c6">cout</a>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> }; <span class="comment">//namespace mlpack</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1Log_html"><div class="ttname"><a href="classmlpack_1_1Log.html">mlpack::Log</a></div><div class="ttdoc">Provides a convenient way to give formatted output. </div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00056">log.hpp:56</a></div></div>
|
||
<div class="ttc" id="namespacemlpack_html"><div class="ttname"><a href="namespacemlpack.html">mlpack</a></div><div class="ttdoc">Linear algebra utility functions, generally performed on matrices or vectors. </div><div class="ttdef"><b>Definition:</b> <a href="binarize_8hpp_source.html#l00018">binarize.hpp:18</a></div></div>
|
||
<div class="ttc" id="classmlpack_1_1Log_html_a894b6a6ce578301d1d4404416e8496d3"><div class="ttname"><a href="classmlpack_1_1Log.html#a894b6a6ce578301d1d4404416e8496d3">mlpack::Log::Assert</a></div><div class="ttdeci">static void Assert(bool condition, const std::string &message="Assert Failed.")</div><div class="ttdoc">Checks if the specified condition is true. </div></div>
|
||
<div class="ttc" id="classmlpack_1_1Log_html_abbf3c5ac36654c0a8f17be3549388b38"><div class="ttname"><a href="classmlpack_1_1Log.html#abbf3c5ac36654c0a8f17be3549388b38">mlpack::Log::Warn</a></div><div class="ttdeci">static MLPACK_EXPORT util::PrefixedOutStream Warn</div><div class="ttdoc">Prints warning messages prefixed with [WARN ]. </div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00087">log.hpp:87</a></div></div>
|
||
<div class="ttc" id="classmlpack_1_1Log_html_a396b80849caab1ec8a856f9d06c31a1d"><div class="ttname"><a href="classmlpack_1_1Log.html#a396b80849caab1ec8a856f9d06c31a1d">mlpack::Log::Fatal</a></div><div class="ttdeci">static MLPACK_EXPORT util::PrefixedOutStream Fatal</div><div class="ttdoc">Prints fatal messages prefixed with [FATAL], then terminates the program. </div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00090">log.hpp:90</a></div></div>
|
||
<div class="ttc" id="classmlpack_1_1Log_html_a80ba817a1abcf742c7463b1e74bf55da"><div class="ttname"><a href="classmlpack_1_1Log.html#a80ba817a1abcf742c7463b1e74bf55da">mlpack::Log::Debug</a></div><div class="ttdeci">static MLPACK_EXPORT util::NullOutStream Debug</div><div class="ttdoc">MLPACK_EXPORT is required for global variables, so that they are properly exported by the Windows com...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00079">log.hpp:79</a></div></div>
|
||
<div class="ttc" id="classmlpack_1_1Log_html_a403428883bc3b47cf96924abb6a40adf"><div class="ttname"><a href="classmlpack_1_1Log.html#a403428883bc3b47cf96924abb6a40adf">mlpack::Log::Info</a></div><div class="ttdeci">static MLPACK_EXPORT util::PrefixedOutStream Info</div><div class="ttdoc">Prints informational messages if –verbose is specified, prefixed with [INFO ]. </div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00084">log.hpp:84</a></div></div>
|
||
<div class="ttc" id="nulloutstream_8hpp_html"><div class="ttname"><a href="nulloutstream_8hpp.html">nulloutstream.hpp</a></div></div>
|
||
<div class="ttc" id="classmlpack_1_1Log_html_aaae645acd77959d7754961f7292bc8c6"><div class="ttname"><a href="classmlpack_1_1Log.html#aaae645acd77959d7754961f7292bc8c6">mlpack::Log::cout</a></div><div class="ttdeci">static std::ostream & cout</div><div class="ttdoc">Reference to cout, if necessary. </div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00093">log.hpp:93</a></div></div>
|
||
<div class="ttc" id="bindings_2matlab_2CMakeLists_8txt_html_ad3a3f86b22ab94a882506e9e614165f1"><div class="ttname"><a href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">string</a></div><div class="ttdeci">test cpp RESULT_VARIABLE MEX_RESULT_TRASH OUTPUT_VARIABLE MEX_OUTPUT ERROR_VARIABLE MEX_ERROR_TRASH string(REGEX MATCH"Warning: You are using"MEX_WARNING"${MEX_OUTPUT}") if(MEX_WARNING) string(REGEX REPLACE".*using [a-zA-Z]* version \"([0-9.]*)[^\"]*\".*""\\1"OTHER_COMPILER_VERSION"$</div><div class="ttdef"><b>Definition:</b> <a href="bindings_2matlab_2CMakeLists_8txt_source.html#l00018">CMakeLists.txt:18</a></div></div>
|
||
<div class="ttc" id="classmlpack_1_1util_1_1PrefixedOutStream_html"><div class="ttname"><a href="classmlpack_1_1util_1_1PrefixedOutStream.html">mlpack::util::PrefixedOutStream</a></div><div class="ttdoc">Allows us to output to an ostream with a prefix at the beginning of each line, in the same way we wou...</div><div class="ttdef"><b>Definition:</b> <a href="prefixedoutstream_8hpp_source.html#l00046">prefixedoutstream.hpp:46</a></div></div>
|
||
<div class="ttc" id="classmlpack_1_1util_1_1NullOutStream_html"><div class="ttname"><a href="classmlpack_1_1util_1_1NullOutStream.html">mlpack::util::NullOutStream</a></div><div class="ttdoc">Used for Log::Debug when not compiled with debugging symbols. </div><div class="ttdef"><b>Definition:</b> <a href="nulloutstream_8hpp_source.html#l00027">nulloutstream.hpp:27</a></div></div>
|
||
<div class="ttc" id="prefixedoutstream_8hpp_html"><div class="ttname"><a href="prefixedoutstream_8hpp.html">prefixedoutstream.hpp</a></div></div>
|
||
</div><!-- fragment --></div><!-- contents -->
|
||
<!-- start footer part -->
|
||
<hr class="footer"/><address class="footer"><small>
|
||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
</a> 1.8.11
|
||
</small></address>
|
||
</body>
|
||
<script type="text/javascript">
|
||
var x = document.getElementsByClassName("formulaDsp");
|
||
var i;
|
||
for (i = 0; i < x.length; i++)
|
||
{
|
||
x[i].width /= 4;
|
||
}
|
||
</script>
|
||
</html>
|