autodoc.git / traditional_manual / chapter_21.html

version» Context lines:

autodoc.git/traditional_manual/chapter_21.html:18007:   <span class='homogen--name'><b>get_prof_info</b></span>   </dt>   <dd><p><code><code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>string</code>|<code class='datatype'>float</code>|<code class='datatype'>int</code>)) <b><span class='method'>get_prof_info</span>(</b><code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>include</code>, <code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>exclude</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Collect profiling data.</p>   <p> This will return the CPU usage, by function, since the last time    the function was called.</p>   <p> The returned array contains the following entries per entry:</p>   <table class='box'><tr><td colspan='2'>Array</td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>name</code></code></td><td><p>The name of the function</p> + <tr><td><code><code class='datatype'>string</code> <code class='key'>name</code></code></td><td><p>The name of the function.</p>   </td></tr> - <tr><td><code><code class='datatype'>float</code> <code class='key'>number_of_calls</code></code></td><td><p>The number of calls</p> + <tr><td><code><code class='datatype'>int</code> <code class='key'>number_of_calls</code></code></td><td><p>The number of calls.</p>   </td></tr> - <tr><td><code><code class='datatype'>float</code> <code class='key'>self_time</code></code></td><td><p>The self CPU time</p> + <tr><td><code><code class='datatype'>float</code> <code class='key'>total_self_time</code></code></td><td><p>Total self CPU time in milliseconds.</p>   </td></tr> - <tr><td><code><code class='datatype'>float</code> <code class='key'>cpu_time</code></code></td><td><p>The self CPU time, including children.</p> + <tr><td><code><code class='datatype'>float</code> <code class='key'>total_cpu_time</code></code></td><td><p>Total self CPU time in milliseconds, including children.</p>   </td></tr> -  + <tr><td><code><code class='datatype'>float</code> <code class='key'>avg_self_time</code></code></td><td><p>Average self CPU time in microseconds.</p> + </td></tr> + <tr><td><code><code class='datatype'>float</code> <code class='key'>avg_cpu_time</code></code></td><td><p>Average self CPU time in microseconds, including children.</p> + </td></tr>   <tr><td><code><code class='datatype'>float</code> <code class='key'>self_time_pct</code></code></td><td><p>The self CPU time as percentage of total time.</p>   </td></tr>   <tr><td><code><code class='datatype'>float</code> <code class='key'>cpu_time_pct</code></code></td><td><p>The self CPU time, including children, as percentage of total    time.</p>   </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>function_line</code></code></td><td><p>This is the location in the source of the start of the function</p> + <tr><td><code><code class='datatype'>string</code> <code class='key'>function_line</code></code></td><td><p>Function's definition source location.</p>   </td></tr>   </table>   </dd></dl>   </dd></dl></dd></dl><dl><dt><h2 class='header'>Module <b class='ms datatype'>DefaultCompilerEnvironment</b></h2>   </dt><dd><dl class='group--doc'>   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>The <code>CompilerEnvironment</code> object that is used    for loading C-modules and by <code>predef::compile()</code>.</p>   </dd>   <dt class='head--doc'>Note</dt>