boost_mirror/histogram
1
0
Fork 0
mirror of https://github.com/boostorg/histogram.git synced 2025-05-11 05:07:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

tweaking doc

Browse Source
This commit is contained in:
Hans Dembinski 2016-04-25 22:04:53 -04:00
parent 195c7f5bd4
commit 3e84e561ec
3 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

15
doc/html/types.html
View File

@ -174,9 +174,10 @@ template&lt;typename <code class="descname">T</code>&gt;</dt>
</dd></dl>
</div>
<div class="section" id="module-histogram">
<span id="python-interface"></span><h3>Python interface<a class="headerlink" href="#module-histogram" title="Permalink to this headline"></a></h3>
<dl class="class">
<div class="section" id="python-interface">
<h3>Python interface<a class="headerlink" href="#python-interface" title="Permalink to this headline"></a></h3>
<p>The operators <code class="docutils literal"><span class="pre">==</span></code>, <code class="docutils literal"><span class="pre">+=</span></code>, and <code class="docutils literal"><span class="pre">+</span></code> are defined for histograms. They are also pickable.</p>
<span class="target" id="module-histogram"></span><dl class="class">
<dt id="histogram.histogram">
<em class="property">class </em><code class="descclassname">histogram.</code><code class="descname">histogram</code><a class="headerlink" href="#histogram.histogram" title="Permalink to this definition"></a></dt>
<dd><p>N-dimensional histogram for real-valued data.</p>
@ -260,7 +261,6 @@ template&lt;typename <code class="descname">T</code>&gt;</dt>
</table>
</dd></dl>
<p>The operators <code class="docutils literal"><span class="pre">==</span></code>, <code class="docutils literal"><span class="pre">+=</span></code>, and <code class="docutils literal"><span class="pre">+</span></code> are defined for histograms. They are also pickable.</p>
</dd></dl>
</div>
@ -270,12 +270,14 @@ template&lt;typename <code class="descname">T</code>&gt;</dt>
<p><code class="docutils literal"><span class="pre">#include</span> <span class="pre">&lt;boost/histogram/axis.hpp&gt;</span></code></p>
<div class="section" id="id1">
<h3>C++ interface<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<p>Axis types have a similar and often common interface, but have no common base type. To increase performance, axis types are internally stored by <code class="xref cpp cpp-class docutils literal"><span class="pre">basic_histogram</span></code> in a <code class="xref cpp cpp-class docutils literal"><span class="pre">boost::variant</span></code>.</p>
<dl class="type">
<dt id="_CPPv29axis_type">
<span id="axis_type"></span><em class="property">typedef </em>boost::variant&lt;<a class="reference internal" href="#_CPPv212regular_axis" title="regular_axis">regular_axis</a>, <a class="reference internal" href="#_CPPv210polar_axis" title="polar_axis">polar_axis</a>, <a class="reference internal" href="#_CPPv213variable_axis" title="variable_axis">variable_axis</a>, <a class="reference internal" href="#_CPPv213category_axis" title="category_axis">category_axis</a>, <a class="reference internal" href="#_CPPv212integer_axis" title="integer_axis">integer_axis</a>&gt; <code class="descclassname"></code><code class="descname">axis_type</code><a class="headerlink" href="#_CPPv29axis_type" title="Permalink to this definition"></a></dt>
<dd><p>A variant template which stores one of several axis objects. It needs to be cast to the type it currently holds to be useful.</p>
<dd><p>A variant which stores one of several axis objects. It needs to be cast to the type it currently holds to be useful or passed to a visitor.</p>
</dd></dl>
<p>All axis types support the <code class="docutils literal"><span class="pre">==</span></code> operator.</p>
<dl class="class">
<dt id="_CPPv212regular_axis">
<span id="regular_axis"></span><em class="property">class </em><code class="descclassname"></code><code class="descname">regular_axis</code><a class="headerlink" href="#_CPPv212regular_axis" title="Permalink to this definition"></a></dt>
@ -442,10 +444,10 @@ template&lt;typename <code class="descname">T</code>&gt;</dt>
<dd><p>Returns the low edge of the bin (not implemented for category_axis and integer_axis).</p>
</dd></dl>
<p>All axis types support the <code class="docutils literal"><span class="pre">==</span></code> operator.</p>
</div>
<div class="section" id="id2">
<h3>Python interface<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<p>All axis types support the operators <code class="docutils literal"><span class="pre">==</span></code> and <code class="docutils literal"><span class="pre">[]</span></code>. They support the <code class="xref py py-func docutils literal"><span class="pre">len()</span></code> and <code class="xref py py-func docutils literal"><span class="pre">repr()</span></code> calls, and the iterator protocol.</p>
<dl class="class">
<dt id="histogram.regular_axis">
<em class="property">class </em><code class="descclassname">histogram.</code><code class="descname">regular_axis</code><a class="headerlink" href="#histogram.regular_axis" title="Permalink to this definition"></a></dt>
@ -572,7 +574,6 @@ Binning is a O(1) operation.</p>
</dd></dl>
<p>All axis types support the operators <code class="docutils literal"><span class="pre">==</span></code> and <code class="docutils literal"><span class="pre">[]</span></code>. They support the <code class="xref py py-func docutils literal"><span class="pre">len()</span></code> and <code class="xref py py-func docutils literal"><span class="pre">repr()</span></code> calls, and the iterator protocol.</p>
</div>
</div>
</div>

16
doc/sphinx/types.rst
View File

@ -106,6 +106,8 @@ C++ interface
Python interface
^^^^^^^^^^^^^^^^
The operators ``==``, ``+=``, and ``+`` are defined for histograms. They are also pickable.
.. py:module:: histogram
.. autoclass:: histogram
@ -136,8 +138,6 @@ Python interface
:param int indices: indices of the bin
:return: variance estimate for the bin
The operators ``==``, ``+=``, and ``+`` are defined for histograms. They are also pickable.
Axis Types
----------
@ -146,10 +146,14 @@ Axis Types
C++ interface
^^^^^^^^^^^^^
Axis types have a similar and often common interface, but have no common base type. To increase performance, axis types are internally stored by :cpp:class:`basic_histogram` in a :cpp:class:`boost::variant`.
.. cpp:type:: boost::variant\<regular_axis, polar_axis, variable_axis, \
category_axis, integer_axis> axis_type
A variant template which stores one of several axis objects. It needs to be cast to the type it currently holds to be useful.
A variant which stores one of several axis objects. It needs to be cast to the type it currently holds to be useful or passed to a visitor.
All axis types support the ``==`` operator.
.. cpp:class:: regular_axis
@ -239,11 +243,11 @@ Common interface among axis types:
Returns the low edge of the bin (not implemented for category_axis and integer_axis).
All axis types support the ``==`` operator.
Python interface
^^^^^^^^^^^^^^^^
All axis types support the operators ``==`` and ``[]``. They support the :py:func:`len` and :py:func:`repr` calls, and the iterator protocol.
.. autoclass:: regular_axis
:members:
@ -258,5 +262,3 @@ Python interface
.. autoclass:: integer_axis
:members:
All axis types support the operators ``==`` and ``[]``. They support the :py:func:`len` and :py:func:`repr` calls, and the iterator protocol.