350 lines
18 KiB
HTML
350 lines
18 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: mlpack::Backtrace Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><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="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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="namespacemlpack.html">mlpack</a></li><li class="navelem"><a class="el" href="classmlpack_1_1Backtrace.html">Backtrace</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#pri-static-attribs">Static Private Attributes</a> |
|
|
<a href="classmlpack_1_1Backtrace-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mlpack::Backtrace Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Provides a backtrace.
|
|
<a href="classmlpack_1_1Backtrace.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmlpack_1_1Backtrace_1_1Frames.html">Frames</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmlpack_1_1Backtrace.html" title="Provides a backtrace. ">Backtrace</a> datastructure. <a href="structmlpack_1_1Backtrace_1_1Frames.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aafd8c5b38d705fe30a95a77cf4cd4733"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1Backtrace.html#aafd8c5b38d705fe30a95a77cf4cd4733">Backtrace</a> ()</td></tr>
|
|
<tr class="memdesc:aafd8c5b38d705fe30a95a77cf4cd4733"><td class="mdescLeft"> </td><td class="mdescRight">Constructor initialize fields and call GetAddress to retrieve addresses for each frame of backtrace. <a href="#aafd8c5b38d705fe30a95a77cf4cd4733">More...</a><br /></td></tr>
|
|
<tr class="separator:aafd8c5b38d705fe30a95a77cf4cd4733"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08aceaae4ac2faae9c27d7d9b557f7c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="bindings_2matlab_2CMakeLists_8txt.html#acb14fd14ddd837abe9630e0d8a43703b">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1Backtrace.html#a08aceaae4ac2faae9c27d7d9b557f7c0">ToString</a> ()</td></tr>
|
|
<tr class="memdesc:a08aceaae4ac2faae9c27d7d9b557f7c0"><td class="mdescLeft"> </td><td class="mdescRight">Returns string of backtrace. <a href="#a08aceaae4ac2faae9c27d7d9b557f7c0">More...</a><br /></td></tr>
|
|
<tr class="separator:a08aceaae4ac2faae9c27d7d9b557f7c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a6a7072146260e6c518c869dac2f533dc"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1Backtrace.html#a6a7072146260e6c518c869dac2f533dc">DecodeAddress</a> (long address)</td></tr>
|
|
<tr class="memdesc:a6a7072146260e6c518c869dac2f533dc"><td class="mdescLeft"> </td><td class="mdescRight">Decodes file name, function & line number. <a href="#a6a7072146260e6c518c869dac2f533dc">More...</a><br /></td></tr>
|
|
<tr class="separator:a6a7072146260e6c518c869dac2f533dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adaf7b82d759203c53b86dc5f1e577854"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1Backtrace.html#adaf7b82d759203c53b86dc5f1e577854">DemangleFunction</a> ()</td></tr>
|
|
<tr class="memdesc:adaf7b82d759203c53b86dc5f1e577854"><td class="mdescLeft"> </td><td class="mdescRight">Demangles function name. <a href="#adaf7b82d759203c53b86dc5f1e577854">More...</a><br /></td></tr>
|
|
<tr class="separator:adaf7b82d759203c53b86dc5f1e577854"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3a35e77ea697f8856b1b7cf79734df1"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1Backtrace.html#ad3a35e77ea697f8856b1b7cf79734df1">GetAddress</a> (int maxDepth)</td></tr>
|
|
<tr class="memdesc:ad3a35e77ea697f8856b1b7cf79734df1"><td class="mdescLeft"> </td><td class="mdescRight">Gets addresses of each called function from the stack. <a href="#ad3a35e77ea697f8856b1b7cf79734df1">More...</a><br /></td></tr>
|
|
<tr class="separator:ad3a35e77ea697f8856b1b7cf79734df1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:adb74af1e0158315968c249ba566eb70a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmlpack_1_1Backtrace_1_1Frames.html">mlpack::Backtrace::Frames</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1Backtrace.html#adb74af1e0158315968c249ba566eb70a">frame</a></td></tr>
|
|
<tr class="separator:adb74af1e0158315968c249ba566eb70a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
|
|
Static Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a939d55982282b38a4aa32304300238ac"><td class="memItemLeft" align="right" valign="top">static std::vector< <a class="el" href="structmlpack_1_1Backtrace_1_1Frames.html">Frames</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1Backtrace.html#a939d55982282b38a4aa32304300238ac">stack</a></td></tr>
|
|
<tr class="memdesc:a939d55982282b38a4aa32304300238ac"><td class="mdescLeft"> </td><td class="mdescRight">A vector for all the backtrace information. <a href="#a939d55982282b38a4aa32304300238ac">More...</a><br /></td></tr>
|
|
<tr class="separator:a939d55982282b38a4aa32304300238ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Provides a backtrace. </p>
|
|
<p>The <a class="el" href="classmlpack_1_1Backtrace.html" title="Provides a backtrace. ">Backtrace</a> class retrieve addresses of each called function from the stack and decode file name, function & line number. Retrieved information can be printed in form:</p>
|
|
<div class="fragment"><div class="line">[b]: (count) /directory/to/<a class="code" href="CMakeLists_8txt.html#adea3fe14b4bcd7b759ab67e9930e6e9c">file</a>.cpp:<span class="keyword">function</span>(args):line_number</div></div><!-- fragment --><p><a class="el" href="classmlpack_1_1Backtrace.html" title="Provides a backtrace. ">Backtrace</a> is printed always when <a class="el" href="classmlpack_1_1Log.html#a894b6a6ce578301d1d4404416e8496d3" title="Checks if the specified condition is true. ">Log::Assert</a> failed. An example is given below.</p>
|
|
<div class="fragment"><div class="line"><span class="keywordflow">if</span> (!someImportantCondition())</div><div class="line">{</div><div class="line"> <a class="code" href="classmlpack_1_1Log.html#a396b80849caab1ec8a856f9d06c31a1d">Log::Fatal</a> << <span class="stringliteral">"someImportantCondition() is not satisfied! Terminating."</span>;</div><div class="line"> <a class="code" href="classmlpack_1_1Log.html#a396b80849caab1ec8a856f9d06c31a1d">Log::Fatal</a> << std::endl;</div><div class="line">}</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd><a class="el" href="classmlpack_1_1Log.html#a894b6a6ce578301d1d4404416e8496d3" title="Checks if the specified condition is true. ">Log::Assert</a> will not be shown when compiling in non-debug mode.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>PrefixedOutStream, <a class="el" href="classmlpack_1_1Log.html" title="Provides a convenient way to give formatted output. ">Log</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="backtrace_8hpp_source.html#l00046">46</a> of file <a class="el" href="backtrace_8hpp_source.html">backtrace.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="aafd8c5b38d705fe30a95a77cf4cd4733"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mlpack::Backtrace::Backtrace </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor initialize fields and call GetAddress to retrieve addresses for each frame of backtrace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">maxDepth</td><td>Maximum depth of backtrace. Default 32 steps. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a6a7072146260e6c518c869dac2f533dc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void mlpack::Backtrace::DecodeAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>address</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Decodes file name, function & line number. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">address</td><td>Address of traced frame. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adaf7b82d759203c53b86dc5f1e577854"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void mlpack::Backtrace::DemangleFunction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Demangles function name. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad3a35e77ea697f8856b1b7cf79734df1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void mlpack::Backtrace::GetAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>maxDepth</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets addresses of each called function from the stack. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">maxDepth</td><td>Maximum depth of backtrace. Default 32 steps. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a08aceaae4ac2faae9c27d7d9b557f7c0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="bindings_2matlab_2CMakeLists_8txt.html#acb14fd14ddd837abe9630e0d8a43703b">std::string</a> mlpack::Backtrace::ToString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns string of backtrace. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="adb74af1e0158315968c249ba566eb70a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct <a class="el" href="structmlpack_1_1Backtrace_1_1Frames.html">mlpack::Backtrace::Frames</a> mlpack::Backtrace::frame</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a939d55982282b38a4aa32304300238ac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<<a class="el" href="structmlpack_1_1Backtrace_1_1Frames.html">Frames</a>> mlpack::Backtrace::stack</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A vector for all the backtrace information. </p>
|
|
|
|
<p>Definition at line <a class="el" href="backtrace_8hpp_source.html#l00091">91</a> of file <a class="el" href="backtrace_8hpp_source.html">backtrace.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/mlpack/core/util/<a class="el" href="backtrace_8hpp_source.html">backtrace.hpp</a></li>
|
|
</ul>
|
|
</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>
|