libs/histogram/doc/reference.xml

   1 <?xml version="1.0" standalone="yes"?>
   2 <library-reference><header name="boost/histogram.hpp">
   3 <para>Includes all standard headers of the Boost.Histogram library. </para><para>Extra headers not automatically included are:<itemizedlist>
   4 <listitem><para><ulink url="histogram/reference.html#header.boost.histogram.ostream_hpp">boost/histogram/ostream.hpp</ulink></para>
   5 </listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.axis.ostream_hpp">boost/histogram/axis/ostream.hpp</ulink></para>
   6 </listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.accumulators.ostream_hpp">boost/histogram/accumulators/ostream.hpp</ulink></para>
   7 </listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.serialization_hpp">boost/histogram/serialization.hpp</ulink></para>
   8 </listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.display_hpp">boost/histogram/display.hpp</ulink> </para>
   9 </listitem></itemizedlist>
  10 </para></header>
  11 <header name="boost/histogram/histogram.hpp">
  12 <namespace name="boost">
  13 <namespace name="histogram">
  14 <class name="histogram"><template>
  15       <template-type-parameter name="Axes"><purpose><para>std::tuple of axis types OR std::vector of an axis type or <classname alt="boost::histogram::axis::variant">axis::variant</classname> </para></purpose></template-type-parameter>
  16       <template-type-parameter name="Storage"><purpose><para>class that implements the storage interface </para></purpose></template-type-parameter>
  17     </template><purpose>Central class of the histogram library. </purpose><description><para>Histogram uses the call operator to insert data, like the <ulink url="https://www.boost.org/doc/libs/develop/doc/html/accumulators.html">Boost.Accumulators</ulink>.</para><para>Use factory functions (see <ulink url="histogram/reference.html#header.boost.histogram.make_histogram_hpp">make_histogram.hpp</ulink> and <ulink url="histogram/reference.html#header.boost.histogram.make_profile_hpp">make_profile.hpp</ulink>) to conveniently create histograms rather than calling the ctors directly.</para><para>Use the <ulink url="boost/histogram/indexed.html">indexed</ulink> range generator to iterate over filled histograms, which is convenient and faster than hand-written loops for multi-dimensional histograms.</para><para>
  18 </para></description><typedef name="axes_type"><type>Axes</type></typedef>
  19 <typedef name="storage_type"><type>Storage</type></typedef>
  20 <typedef name="value_type"><type>typename storage_type::value_type</type></typedef>
  21 <typedef name="iterator"><type>typename storage_type::iterator</type></typedef>
  22 <typedef name="const_iterator"><type>typename storage_type::const_iterator</type></typedef>
  23 <method-group name="public member functions">
  24 <method name="rank" cv="const noexcept"><type>constexpr unsigned</type><purpose>Number of axes (dimensions). </purpose></method>
  25 <method name="size" cv="const noexcept"><type>std::size_t</type><purpose>Total number of bins (including underflow/overflow). </purpose></method>
  26 <method name="reset"><type>void</type><purpose>Reset all bins to default initialized values. </purpose></method>
  27 <method name="axis" cv="const"><type>decltype(auto)</type><template>
  28           <template-nontype-parameter name="N"><type>unsigned</type><default>0</default></template-nontype-parameter>
  29         </template><parameter name=""><paramtype>std::integral_constant&lt; unsigned, N &gt;</paramtype><default>{}</default></parameter><purpose>Get N-th axis using a compile-time number. </purpose><description><para>This version is more efficient than the one accepting a run-time number. </para></description></method>
  30 <method name="axis" cv="const"><type>decltype(auto)</type><parameter name="i"><paramtype>unsigned</paramtype></parameter><purpose>Get N-th axis with run-time number. </purpose><description><para>Prefer the version that accepts a compile-time number, if you can use it. </para></description></method>
  31 <method name="for_each_axis" cv="const"><type>auto</type><template>
  32           <template-type-parameter name="Unary"/>
  33         </template><parameter name="unary"><paramtype>Unary &amp;&amp;</paramtype></parameter><purpose>Apply unary functor/function to each axis. </purpose></method>
  34 <method name="operator()"><type><emphasis>unspecified</emphasis></type><template>
  35           <template-type-parameter name="Arg0"/>
  36           <template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
  37         </template><parameter name="arg0"><paramtype>const Arg0 &amp;</paramtype></parameter><parameter name="args"><paramtype>const Args &amp;...</paramtype></parameter><purpose>Fill histogram with values, an optional weight, and/or a sample. </purpose><description><para>Arguments are passed in order to the axis objects. Passing an argument type that is not convertible to the value type accepted by the axis or passing the wrong number of arguments causes a throw of <computeroutput>std::invalid_argument</computeroutput>.</para><para><emphasis role="bold">Optional weight</emphasis></para><para>An optional weight can be passed as the first or last argument with the <ulink url="boost/histogram/weight.html">weight</ulink> helper function. Compilation fails if the storage elements do not support weights.</para><para><emphasis role="bold">Samples</emphasis></para><para>If the storage elements accept samples, pass them with the sample helper function in addition to the axis arguments, which can be the first or last argument. The <ulink url="boost/histogram/sample.html">sample</ulink> helper function can pass one or more arguments to the storage element. If samples and weights are used together, they can be passed in any order at the beginning or end of the argument list.</para><para><emphasis role="bold">Axis with multiple arguments</emphasis></para><para>If the histogram contains an axis which accepts a <computeroutput>std::tuple</computeroutput> of arguments, the arguments for that axis need to passed as a <computeroutput>std::tuple</computeroutput>, for example, <computeroutput>std::make_tuple(1.2, 2.3)</computeroutput>. If the histogram contains only this axis and no other, the arguments can be passed directly. </para></description></method>
  38 <method name="operator()"><type>iterator</type><template>
  39           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
  40         </template><parameter name="args"><paramtype>const std::tuple&lt; Ts... &gt; &amp;</paramtype></parameter><purpose>Fill histogram with values, an optional weight, and/or a sample from a <computeroutput>std::tuple</computeroutput>. </purpose></method>
  41 <method name="fill"><type>void</type><template>
  42           <template-type-parameter name="Iterable"/>
  43           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  44         </template><parameter name="args"><paramtype>const Iterable &amp;</paramtype><description><para>iterable as explained in the long description. </para></description></parameter><purpose>Fill histogram with several values at once. </purpose><description><para>The argument must be an iterable with a size that matches the rank of the histogram. The element of an iterable may be 1) a value or 2) an iterable with contiguous storage over values or 3) a variant of 1) and 2). Sub-iterables must have the same length.</para><para>Values are passed to the corresponding histogram axis in order. If a single value is passed together with an iterable of values, the single value is treated like an iterable with matching length of copies of this value.</para><para>If the histogram has only one axis, an iterable of values may be passed directly.</para><para>
  45 </para></description></method>
  46 <method name="fill"><type>void</type><template>
  47           <template-type-parameter name="Iterable"/>
  48           <template-type-parameter name="T"/>
  49           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  50         </template><parameter name="args"><paramtype>const Iterable &amp;</paramtype><description><para>iterable of values. </para></description></parameter><parameter name="weights"><paramtype>const <classname>weight_type</classname>&lt; T &gt; &amp;</paramtype><description><para>single weight or an iterable of weights. </para></description></parameter><purpose>Fill histogram with several values and weights at once. </purpose><description><para>
  51 </para></description></method>
  52 <method name="fill"><type>void</type><template>
  53           <template-type-parameter name="Iterable"/>
  54           <template-type-parameter name="T"/>
  55           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  56         </template><parameter name="weights"><paramtype>const <classname>weight_type</classname>&lt; T &gt; &amp;</paramtype><description><para>single weight or an iterable of weights. </para></description></parameter><parameter name="args"><paramtype>const Iterable &amp;</paramtype><description><para>iterable of values. </para></description></parameter><purpose>Fill histogram with several values and weights at once. </purpose><description><para>
  57 </para></description></method>
  58 <method name="fill"><type>void</type><template>
  59           <template-type-parameter name="Iterable"/>
  60           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
  61           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  62         </template><parameter name="args"><paramtype>const Iterable &amp;</paramtype><description><para>iterable of values. </para></description></parameter><parameter name="samples"><paramtype>const sample_type&lt; std::tuple&lt; Ts... &gt;&gt; &amp;</paramtype><description><para>single sample or an iterable of samples. </para></description></parameter><purpose>Fill histogram with several values and samples at once. </purpose><description><para>
  63 </para></description></method>
  64 <method name="fill"><type>void</type><template>
  65           <template-type-parameter name="Iterable"/>
  66           <template-type-parameter name="T"/>
  67           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  68         </template><parameter name="samples"><paramtype>const sample_type&lt; T &gt; &amp;</paramtype><description><para>single sample or an iterable of samples. </para></description></parameter><parameter name="args"><paramtype>const Iterable &amp;</paramtype><description><para>iterable of values. </para></description></parameter><purpose>Fill histogram with several values and samples at once. </purpose><description><para>
  69 </para></description></method>
  70 <method name="fill"><type>void</type><template>
  71           <template-type-parameter name="Iterable"/>
  72           <template-type-parameter name="T"/>
  73           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
  74           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  75         </template><parameter name="args"><paramtype>const Iterable &amp;</paramtype></parameter><parameter name="weights"><paramtype>const <classname>weight_type</classname>&lt; T &gt; &amp;</paramtype></parameter><parameter name="samples"><paramtype>const sample_type&lt; std::tuple&lt; Ts... &gt;&gt; &amp;</paramtype></parameter></method>
  76 <method name="fill"><type>void</type><template>
  77           <template-type-parameter name="Iterable"/>
  78           <template-type-parameter name="T"/>
  79           <template-type-parameter name="U"/>
  80           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  81         </template><parameter name="samples"><paramtype>const sample_type&lt; T &gt; &amp;</paramtype></parameter><parameter name="weights"><paramtype>const <classname>weight_type</classname>&lt; U &gt; &amp;</paramtype></parameter><parameter name="args"><paramtype>const Iterable &amp;</paramtype></parameter></method>
  82 <method name="fill"><type>void</type><template>
  83           <template-type-parameter name="Iterable"/>
  84           <template-type-parameter name="T"/>
  85           <template-type-parameter name="U"/>
  86           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  87         </template><parameter name="weights"><paramtype>const <classname>weight_type</classname>&lt; T &gt; &amp;</paramtype></parameter><parameter name="samples"><paramtype>const sample_type&lt; U &gt; &amp;</paramtype></parameter><parameter name="args"><paramtype>const Iterable &amp;</paramtype></parameter></method>
  88 <method name="fill"><type>void</type><template>
  89           <template-type-parameter name="Iterable"/>
  90           <template-type-parameter name="T"/>
  91           <template-type-parameter name="U"/>
  92           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
  93         </template><parameter name="args"><paramtype>const Iterable &amp;</paramtype></parameter><parameter name="samples"><paramtype>const sample_type&lt; T &gt; &amp;</paramtype></parameter><parameter name="weights"><paramtype>const <classname>weight_type</classname>&lt; U &gt; &amp;</paramtype></parameter></method>
  94 <method name="at"><type>decltype(auto)</type><template>
  95           <template-nontype-parameter name="Indices"><type>class...</type></template-nontype-parameter>
  96         </template><parameter name="i"><paramtype>axis::index_type</paramtype><description><para>index of first axis. </para></description></parameter><parameter name="is"><paramtype>Indices...</paramtype><description><para>indices of second, third, ... axes. </para></description></parameter><purpose>Access cell value at integral indices. </purpose><description><para>You can pass indices as individual arguments, as a std::tuple of integers, or as an interable range of integers. Passing the wrong number of arguments causes a throw of std::invalid_argument. Passing an index which is out of bounds causes a throw of std::out_of_range.</para><para>
  97
  98 </para></description><returns><para>reference to cell value. </para>
  99 </returns></method>
 100 <method name="at" cv="const"><type>decltype(auto)</type><template>
 101           <template-nontype-parameter name="Indices"><type>class...</type></template-nontype-parameter>
 102         </template><parameter name="i"><paramtype>axis::index_type</paramtype></parameter><parameter name="is"><paramtype>Indices...</paramtype></parameter><purpose>Access cell value at integral indices (read-only). </purpose></method>
 103 <method name="at"><type>decltype(auto)</type><template>
 104           <template-nontype-parameter name="Indices"><type>class...</type></template-nontype-parameter>
 105         </template><parameter name="is"><paramtype>const std::tuple&lt; Indices... &gt; &amp;</paramtype></parameter><purpose>Access cell value at integral indices stored in <computeroutput>std::tuple</computeroutput>. </purpose></method>
 106 <method name="at" cv="const"><type>decltype(auto)</type><template>
 107           <template-nontype-parameter name="Indices"><type>typename...</type></template-nontype-parameter>
 108         </template><parameter name="is"><paramtype>const std::tuple&lt; Indices... &gt; &amp;</paramtype></parameter><purpose>Access cell value at integral indices stored in <computeroutput>std::tuple</computeroutput> (read-only). </purpose></method>
 109 <method name="at"><type>decltype(auto)</type><template>
 110           <template-type-parameter name="Iterable"/>
 111           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
 112         </template><parameter name="is"><paramtype>const Iterable &amp;</paramtype></parameter><purpose>Access cell value at integral indices stored in iterable. </purpose></method>
 113 <method name="at" cv="const"><type>decltype(auto)</type><template>
 114           <template-type-parameter name="Iterable"/>
 115           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
 116         </template><parameter name="is"><paramtype>const Iterable &amp;</paramtype></parameter><purpose>Access cell value at integral indices stored in iterable (read-only). </purpose></method>
 117 <method name="operator[]"><type>decltype(auto)</type><template>
 118           <template-type-parameter name="Indices"/>
 119         </template><parameter name="is"><paramtype>const Indices &amp;</paramtype></parameter><purpose>Access value at index (number for rank = 1, else <computeroutput>std::tuple</computeroutput> or iterable). </purpose></method>
 120 <method name="operator[]" cv="const"><type>decltype(auto)</type><template>
 121           <template-type-parameter name="Indices"/>
 122         </template><parameter name="is"><paramtype>const Indices &amp;</paramtype></parameter><purpose>Access value at index (read-only). </purpose></method>
 123 <method name="operator==" cv="const noexcept"><type>bool</type><template>
 124           <template-type-parameter name="A"/>
 125           <template-type-parameter name="S"/>
 126         </template><parameter name="rhs"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><purpose>Equality operator, tests equality for all axes and the storage. </purpose></method>
 127 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
 128           <template-type-parameter name="A"/>
 129           <template-type-parameter name="S"/>
 130         </template><parameter name="rhs"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><purpose>Negation of the equality operator. </purpose></method>
 131 <method name="operator+="><type><emphasis>unspecified</emphasis></type><template>
 132           <template-type-parameter name="A"/>
 133           <template-type-parameter name="S"/>
 134         </template><parameter name="rhs"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><purpose>Add values of another histogram. </purpose></method>
 135 <method name="operator-="><type><emphasis>unspecified</emphasis></type><template>
 136           <template-type-parameter name="A"/>
 137           <template-type-parameter name="S"/>
 138         </template><parameter name="rhs"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><purpose>Subtract values of another histogram. </purpose></method>
 139 <method name="operator *="><type><emphasis>unspecified</emphasis></type><template>
 140           <template-type-parameter name="A"/>
 141           <template-type-parameter name="S"/>
 142         </template><parameter name="rhs"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><purpose>Multiply by values of another histogram. </purpose></method>
 143 <method name="operator/="><type><emphasis>unspecified</emphasis></type><template>
 144           <template-type-parameter name="A"/>
 145           <template-type-parameter name="S"/>
 146         </template><parameter name="rhs"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><purpose>Divide by values of another histogram. </purpose></method>
 147 <method name="operator *="><type><emphasis>unspecified</emphasis></type><template>
 148           <template-type-parameter name="V"><default>value_type</default></template-type-parameter>
 149         </template><parameter name="x"><paramtype>const double</paramtype></parameter><purpose>Multiply all values with a scalar. </purpose></method>
 150 <method name="operator *="><type><emphasis>unspecified</emphasis></type><template>
 151           <template-type-parameter name="V"><default>value_type</default></template-type-parameter>
 152         </template><parameter name="x"><paramtype>const double</paramtype></parameter><purpose>Multiply all values with a scalar. </purpose></method>
 153 <method name="operator/="><type><emphasis>unspecified</emphasis></type><template>
 154           <template-type-parameter name="V"><default>value_type</default></template-type-parameter>
 155         </template><parameter name="x"><paramtype>const double</paramtype></parameter><purpose>Divide all values by a scalar. </purpose></method>
 156 <method name="begin" cv="noexcept"><type>iterator</type><purpose>Return value iterator to the beginning of the histogram. </purpose></method>
 157 <method name="end" cv="noexcept"><type>iterator</type><purpose>Return value iterator to the end in the histogram. </purpose></method>
 158 <method name="begin" cv="const noexcept"><type>const_iterator</type><purpose>Return value iterator to the beginning of the histogram (read-only). </purpose></method>
 159 <method name="end" cv="const noexcept"><type>const_iterator</type><purpose>Return value iterator to the end in the histogram (read-only). </purpose></method>
 160 <method name="cbegin" cv="const noexcept"><type>const_iterator</type><purpose>Return value iterator to the beginning of the histogram (read-only). </purpose></method>
 161 <method name="cend" cv="const noexcept"><type>const_iterator</type><purpose>Return value iterator to the end in the histogram (read-only). </purpose></method>
 162 <method name="serialize"><type>void</type><template>
 163           <template-type-parameter name="Archive"/>
 164         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
 165 </method-group>
 166 <constructor cv="= default"/>
 167 <constructor specifiers="explicit"><template>
 168           <template-type-parameter name="A"/>
 169           <template-type-parameter name="S"/>
 170         </template><parameter name="rhs"><paramtype><classname>histogram</classname>&lt; A, S &gt; &amp;&amp;</paramtype></parameter></constructor>
 171 <constructor specifiers="explicit"><template>
 172           <template-type-parameter name="A"/>
 173           <template-type-parameter name="S"/>
 174         </template><parameter name="rhs"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter></constructor>
 175 <copy-assignment><type><classname>histogram</classname> &amp;</type><template>
 176           <template-type-parameter name="A"/>
 177           <template-type-parameter name="S"/>
 178         </template><parameter name="rhs"><paramtype><classname>histogram</classname>&lt; A, S &gt; &amp;&amp;</paramtype></parameter></copy-assignment>
 179 <copy-assignment><type><classname>histogram</classname> &amp;</type><template>
 180           <template-type-parameter name="A"/>
 181           <template-type-parameter name="S"/>
 182         </template><parameter name="rhs"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter></copy-assignment>
 183 <constructor><template>
 184           <template-type-parameter name="A"/>
 185           <template-type-parameter name=""><default>detail::requires_axes&lt;A&gt;</default></template-type-parameter>
 186         </template><parameter name="a"><paramtype>A &amp;&amp;</paramtype></parameter><parameter name="s"><paramtype>Storage</paramtype></parameter></constructor>
 187 <constructor specifiers="explicit"><parameter name="axes"><paramtype>Axes</paramtype></parameter></constructor>
 188 <constructor specifiers="explicit"><template>
 189           <template-nontype-parameter name="As"><type>class...</type></template-nontype-parameter>
 190           <template-type-parameter name=""><default>detail::requires_axes&lt;std::tuple&lt;std::decay_t&lt;As&gt;...&gt;&gt;</default></template-type-parameter>
 191         </template><parameter name="as"><paramtype>As &amp;&amp;...</paramtype></parameter></constructor>
 192 </class>
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210 <function name="operator+"><type>auto</type><template>
 211           <template-type-parameter name="A1"/>
 212           <template-type-parameter name="S1"/>
 213           <template-type-parameter name="A2"/>
 214           <template-type-parameter name="S2"/>
 215         </template><parameter name="a"><paramtype>const <classname>histogram</classname>&lt; A1, S1 &gt; &amp;</paramtype></parameter><parameter name="b"><paramtype>const <classname>histogram</classname>&lt; A2, S2 &gt; &amp;</paramtype></parameter><purpose>Pairwise add cells of two histograms and return histogram with the sum. </purpose><description><para>The returned histogram type is the most efficient and safest one constructible from the inputs, if they are not the same type. If one histogram has a tuple axis, the result has a tuple axis. The chosen storage is the one with the larger dynamic range. </para></description></function>
 216 <function name="operator*"><type>auto</type><template>
 217           <template-type-parameter name="A1"/>
 218           <template-type-parameter name="S1"/>
 219           <template-type-parameter name="A2"/>
 220           <template-type-parameter name="S2"/>
 221         </template><parameter name="a"><paramtype>const <classname>histogram</classname>&lt; A1, S1 &gt; &amp;</paramtype></parameter><parameter name="b"><paramtype>const <classname>histogram</classname>&lt; A2, S2 &gt; &amp;</paramtype></parameter><purpose>Pairwise multiply cells of two histograms and return histogram with the product. </purpose><description><para>For notes on the returned histogram type, see operator+. </para></description></function>
 222 <function name="operator-"><type>auto</type><template>
 223           <template-type-parameter name="A1"/>
 224           <template-type-parameter name="S1"/>
 225           <template-type-parameter name="A2"/>
 226           <template-type-parameter name="S2"/>
 227         </template><parameter name="a"><paramtype>const <classname>histogram</classname>&lt; A1, S1 &gt; &amp;</paramtype></parameter><parameter name="b"><paramtype>const <classname>histogram</classname>&lt; A2, S2 &gt; &amp;</paramtype></parameter><purpose>Pairwise subtract cells of two histograms and return histogram with the difference. </purpose><description><para>For notes on the returned histogram type, see operator+. </para></description></function>
 228 <function name="operator/"><type>auto</type><template>
 229           <template-type-parameter name="A1"/>
 230           <template-type-parameter name="S1"/>
 231           <template-type-parameter name="A2"/>
 232           <template-type-parameter name="S2"/>
 233         </template><parameter name="a"><paramtype>const <classname>histogram</classname>&lt; A1, S1 &gt; &amp;</paramtype></parameter><parameter name="b"><paramtype>const <classname>histogram</classname>&lt; A2, S2 &gt; &amp;</paramtype></parameter><purpose>Pairwise divide cells of two histograms and return histogram with the quotient. </purpose><description><para>For notes on the returned histogram type, see operator+. </para></description></function>
 234 <function name="operator*"><type>auto</type><template>
 235           <template-type-parameter name="A"/>
 236           <template-type-parameter name="S"/>
 237         </template><parameter name="h"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><parameter name="x"><paramtype>double</paramtype></parameter><purpose>Multiply all cells of the histogram by a number and return a new histogram. </purpose><description><para>If the original histogram has integer cells, the result has double cells. </para></description></function>
 238 <function name="operator*"><type>auto</type><template>
 239           <template-type-parameter name="A"/>
 240           <template-type-parameter name="S"/>
 241         </template><parameter name="x"><paramtype>double</paramtype></parameter><parameter name="h"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><purpose>Multiply all cells of the histogram by a number and return a new histogram. </purpose><description><para>If the original histogram has integer cells, the result has double cells. </para></description></function>
 242 <function name="operator/"><type>auto</type><template>
 243           <template-type-parameter name="A"/>
 244           <template-type-parameter name="S"/>
 245         </template><parameter name="h"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><parameter name="x"><paramtype>double</paramtype></parameter><purpose>Divide all cells of the histogram by a number and return a new histogram. </purpose><description><para>If the original histogram has integer cells, the result has double cells. </para></description></function>
 246 </namespace>
 247 </namespace>
 248 </header>
 249 <header name="boost/histogram/accumulators.hpp">
 250 <para>Includes all accumulator headers of the Boost.Histogram library. </para><para>Extra header not automatically included:<itemizedlist>
 251 <listitem><para><ulink url="histogram/reference.html#header.boost.histogram.accumulators.ostream_hpp">boost/histogram/accumulators/ostream.hpp</ulink> </para>
 252 </listitem></itemizedlist>
 253 </para></header>
 254 <header name="boost/histogram/accumulators/mean.hpp">
 255 <namespace name="boost">
 256 <namespace name="histogram">
 257 <namespace name="accumulators">
 258 <class name="mean"><template>
 259       <template-type-parameter name="RealType"/>
 260     </template><purpose>Calculates mean and variance of sample. </purpose><description><para>Uses Welfords's incremental algorithm to improve the numerical stability of mean and variance computation. </para></description><method-group name="public member functions">
 261 <method name="operator()" cv="noexcept"><type>void</type><parameter name="x"><paramtype>const RealType &amp;</paramtype></parameter></method>
 262 <method name="operator()" cv="noexcept"><type>void</type><parameter name="w"><paramtype>const <classname>weight_type</classname>&lt; RealType &gt; &amp;</paramtype></parameter><parameter name="x"><paramtype>const RealType &amp;</paramtype></parameter></method>
 263 <method name="operator+=" cv="noexcept"><type><classname>mean</classname> &amp;</type><template>
 264           <template-type-parameter name="T"/>
 265         </template><parameter name="rhs"><paramtype>const <classname>mean</classname>&lt; T &gt; &amp;</paramtype></parameter></method>
 266 <method name="operator *=" cv="noexcept"><type><classname>mean</classname> &amp;</type><parameter name="s"><paramtype>const RealType &amp;</paramtype></parameter></method>
 267 <method name="operator==" cv="const noexcept"><type>bool</type><template>
 268           <template-type-parameter name="T"/>
 269         </template><parameter name="rhs"><paramtype>const <classname>mean</classname>&lt; T &gt; &amp;</paramtype></parameter></method>
 270 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
 271           <template-type-parameter name="T"/>
 272         </template><parameter name="rhs"><paramtype>const <classname>mean</classname>&lt; T &gt; &amp;</paramtype></parameter></method>
 273 <method name="count" cv="const noexcept"><type>const RealType &amp;</type></method>
 274 <method name="value" cv="const noexcept"><type>const RealType &amp;</type></method>
 275 <method name="variance" cv="const noexcept"><type>RealType</type></method>
 276 <method name="serialize"><type>void</type><template>
 277           <template-type-parameter name="Archive"/>
 278         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name="version"><paramtype>unsigned</paramtype></parameter></method>
 279 </method-group>
 280 <constructor cv="= default"/>
 281 <constructor cv="noexcept"><parameter name="n"><paramtype>const RealType &amp;</paramtype></parameter><parameter name="mean"><paramtype>const RealType &amp;</paramtype></parameter><parameter name="variance"><paramtype>const RealType &amp;</paramtype></parameter></constructor>
 282 </class></namespace>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308 </namespace>
 309 </namespace>
 310 </header>
 311 <header name="boost/histogram/accumulators/sum.hpp">
 312 <namespace name="boost">
 313 <namespace name="histogram">
 314 <namespace name="accumulators">
 315 <class name="sum"><template>
 316       <template-type-parameter name="RealType"/>
 317     </template><purpose>Uses Neumaier algorithm to compute accurate sums. </purpose><description><para>The algorithm uses memory for two floats and is three to five times slower compared to a simple floating point number used to accumulate a sum, but the relative error of the sum is at the level of the machine precision, independent of the number of samples.</para><para>A. Neumaier, Zeitschrift fuer Angewandte Mathematik und Mechanik 54 (1974) 39-51. </para></description><method-group name="public member functions">
 318 <method name="operator++"><type><classname>sum</classname> &amp;</type><purpose>Increment sum by one. </purpose></method>
 319 <method name="operator+="><type><classname>sum</classname> &amp;</type><parameter name="value"><paramtype>const RealType &amp;</paramtype></parameter><purpose>Increment sum by value. </purpose></method>
 320 <method name="operator *="><type><classname>sum</classname> &amp;</type><parameter name="value"><paramtype>const RealType &amp;</paramtype></parameter><purpose>Scale by value. </purpose></method>
 321 <method name="operator==" cv="const noexcept"><type>bool</type><template>
 322           <template-type-parameter name="T"/>
 323         </template><parameter name="rhs"><paramtype>const <classname>sum</classname>&lt; T &gt; &amp;</paramtype></parameter></method>
 324 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
 325           <template-type-parameter name="T"/>
 326         </template><parameter name="rhs"><paramtype>const T &amp;</paramtype></parameter></method>
 327 <method name="large" cv="const"><type>const RealType &amp;</type><purpose>Return large part of the sum. </purpose></method>
 328 <method name="small" cv="const"><type>const RealType &amp;</type><purpose>Return small part of the sum. </purpose></method>
 329 <method name="conversion-operator" cv="const"><type>RealType</type></method>
 330 <method name="serialize"><type>void</type><template>
 331           <template-type-parameter name="Archive"/>
 332         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
 333 </method-group>
 334 <constructor cv="= default"/>
 335 <constructor specifiers="explicit" cv="noexcept"><parameter name="value"><paramtype>const RealType &amp;</paramtype></parameter><purpose>Initialize sum to value. </purpose></constructor>
 336 <copy-assignment cv="noexcept"><type><classname>sum</classname> &amp;</type><parameter name="value"><paramtype>const RealType &amp;</paramtype></parameter><purpose>Set sum to value. </purpose></copy-assignment>
 337 </class></namespace>
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363 </namespace>
 364 </namespace>
 365 </header>
 366 <header name="boost/histogram/algorithm/sum.hpp">
 367 <namespace name="boost">
 368 <namespace name="histogram">
 369 <namespace name="algorithm">
 370 <function name="sum"><type>auto</type><template>
 371           <template-type-parameter name="A"/>
 372           <template-type-parameter name="S"/>
 373         </template><parameter name="h"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><purpose>Compute the sum over all histogram cells, including underflow/overflow bins. </purpose><description><para>If the value type of the histogram is an integral or floating point type, boost::accumulators::sum&lt;double&gt; is used to compute the sum, else the original value type is used. Compilation fails, if the value type does not support operator+=.</para><para>Return type is double if the value type of the histogram is integral or floating point, and the original value type otherwise. </para></description></function>
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389 </namespace>
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415 </namespace>
 416 </namespace>
 417 </header>
 418 <header name="boost/histogram/accumulators/thread_safe.hpp">
 419 <namespace name="boost">
 420 <namespace name="histogram">
 421 <namespace name="accumulators">
 422 <class name="thread_safe"><template>
 423       <template-type-parameter name="T"><purpose><para>type to adapt, must be supported by std::atomic. </para></purpose></template-type-parameter>
 424     </template><inherit access="public">std::atomic&lt; T &gt;</inherit><purpose>Thread-safe adaptor for builtin integral and floating point numbers. </purpose><description><para>This adaptor uses std::atomic to make concurrent increments and additions safe for the stored value.</para><para>On common computing platforms, the adapted integer has the same size and alignment as underlying type. The atomicity is implemented with a special CPU instruction. On exotic platforms the size of the adapted number may be larger and/or the type may have different alignment, which means it cannot be tightly packed into arrays.</para><para>
 425 </para></description><typedef name="value_type"><type>T</type></typedef>
 426 <typedef name="super_t"><type>std::atomic&lt; T &gt;</type></typedef>
 427 <method-group name="public member functions">
 428 <method name="operator+="><type><classname>thread_safe</classname> &amp;</type><parameter name="arg"><paramtype>const <classname>thread_safe</classname> &amp;</paramtype></parameter></method>
 429 <method name="operator+="><type><classname>thread_safe</classname> &amp;</type><parameter name="arg"><paramtype>value_type</paramtype></parameter></method>
 430 <method name="operator++"><type><classname>thread_safe</classname> &amp;</type></method>
 431 <method name="serialize"><type>void</type><template>
 432           <template-type-parameter name="Archive"/>
 433         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
 434 </method-group>
 435 <constructor cv="noexcept"/>
 436 <constructor cv="noexcept"><parameter name="o"><paramtype>const <classname>thread_safe</classname> &amp;</paramtype></parameter></constructor>
 437 <copy-assignment cv="noexcept"><type><classname>thread_safe</classname> &amp;</type><parameter name="o"><paramtype>const <classname>thread_safe</classname> &amp;</paramtype></parameter></copy-assignment>
 438 <constructor><parameter name="arg"><paramtype>value_type</paramtype></parameter></constructor>
 439 <copy-assignment><type><classname>thread_safe</classname> &amp;</type><parameter name="arg"><paramtype>value_type</paramtype></parameter></copy-assignment>
 440 </class></namespace>
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466 </namespace>
 467 </namespace>
 468 </header>
 469 <header name="boost/histogram/accumulators/weighted_mean.hpp">
 470 <namespace name="boost">
 471 <namespace name="histogram">
 472 <namespace name="accumulators">
 473 <class name="weighted_mean"><template>
 474       <template-type-parameter name="RealType"/>
 475     </template><purpose>Calculates mean and variance of weighted sample. </purpose><description><para>Uses West's incremental algorithm to improve numerical stability of mean and variance computation. </para></description><method-group name="public member functions">
 476 <method name="operator()"><type>void</type><parameter name="x"><paramtype>const RealType &amp;</paramtype></parameter></method>
 477 <method name="operator()"><type>void</type><parameter name="w"><paramtype>const <classname>weight_type</classname>&lt; RealType &gt; &amp;</paramtype></parameter><parameter name="x"><paramtype>const RealType &amp;</paramtype></parameter></method>
 478 <method name="operator+="><type><classname>weighted_mean</classname> &amp;</type><template>
 479           <template-type-parameter name="T"/>
 480         </template><parameter name="rhs"><paramtype>const <classname>weighted_mean</classname>&lt; T &gt; &amp;</paramtype></parameter></method>
 481 <method name="operator *="><type><classname>weighted_mean</classname> &amp;</type><parameter name="s"><paramtype>const RealType &amp;</paramtype></parameter></method>
 482 <method name="operator==" cv="const noexcept"><type>bool</type><template>
 483           <template-type-parameter name="T"/>
 484         </template><parameter name="rhs"><paramtype>const <classname>weighted_mean</classname>&lt; T &gt; &amp;</paramtype></parameter></method>
 485 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
 486           <template-type-parameter name="T"/>
 487         </template><parameter name="rhs"><paramtype>const T &amp;</paramtype></parameter></method>
 488 <method name="sum_of_weights" cv="const noexcept"><type>const RealType &amp;</type></method>
 489 <method name="sum_of_weights_squared" cv="const noexcept"><type>const RealType &amp;</type></method>
 490 <method name="value" cv="const noexcept"><type>const RealType &amp;</type></method>
 491 <method name="variance" cv="const"><type>RealType</type></method>
 492 <method name="serialize"><type>void</type><template>
 493           <template-type-parameter name="Archive"/>
 494         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
 495 </method-group>
 496 <constructor cv="= default"/>
 497 <constructor><parameter name="wsum"><paramtype>const RealType &amp;</paramtype></parameter><parameter name="wsum2"><paramtype>const RealType &amp;</paramtype></parameter><parameter name="mean"><paramtype>const RealType &amp;</paramtype></parameter><parameter name="variance"><paramtype>const RealType &amp;</paramtype></parameter></constructor>
 498 </class></namespace>
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524 </namespace>
 525 </namespace>
 526 </header>
 527 <header name="boost/histogram/accumulators/weighted_sum.hpp">
 528 <namespace name="boost">
 529 <namespace name="histogram">
 530 <namespace name="accumulators">
 531 <class name="weighted_sum"><template>
 532       <template-type-parameter name="RealType"/>
 533     </template><purpose>Holds sum of weights and its variance estimate. </purpose><method-group name="public member functions">
 534 <method name="operator++"><type><classname>weighted_sum</classname> &amp;</type><purpose>Increment by one. </purpose></method>
 535 <method name="operator+="><type><classname>weighted_sum</classname> &amp;</type><template>
 536           <template-type-parameter name="T"/>
 537         </template><parameter name="value"><paramtype>const T &amp;</paramtype></parameter><purpose>Increment by value. </purpose></method>
 538 <method name="operator+="><type><classname>weighted_sum</classname> &amp;</type><template>
 539           <template-type-parameter name="T"/>
 540         </template><parameter name="rhs"><paramtype>const <classname>weighted_sum</classname>&lt; T &gt; &amp;</paramtype></parameter><purpose>Added another weighted sum. </purpose></method>
 541 <method name="operator *="><type><classname>weighted_sum</classname> &amp;</type><parameter name="x"><paramtype>const RealType &amp;</paramtype></parameter><purpose>Scale by value. </purpose></method>
 542 <method name="operator==" cv="const noexcept"><type>bool</type><parameter name="rhs"><paramtype>const RealType &amp;</paramtype></parameter></method>
 543 <method name="operator==" cv="const noexcept"><type>bool</type><template>
 544           <template-type-parameter name="T"/>
 545         </template><parameter name="rhs"><paramtype>const <classname>weighted_sum</classname>&lt; T &gt; &amp;</paramtype></parameter></method>
 546 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
 547           <template-type-parameter name="T"/>
 548         </template><parameter name="rhs"><paramtype>const T &amp;</paramtype></parameter></method>
 549 <method name="value" cv="const noexcept"><type>const RealType &amp;</type><purpose>Return value of the sum. </purpose></method>
 550 <method name="variance" cv="const noexcept"><type>const RealType &amp;</type><purpose>Return estimated variance of the sum. </purpose></method>
 551 <method name="conversion-operator" cv="const" specifiers="explicit"><type>T</type><template>
 552           <template-type-parameter name="T"/>
 553         </template></method>
 554 <method name="serialize"><type>void</type><template>
 555           <template-type-parameter name="Archive"/>
 556         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
 557 </method-group>
 558 <constructor cv="= default"/>
 559 <constructor specifiers="explicit" cv="noexcept"><parameter name="value"><paramtype>const RealType &amp;</paramtype></parameter></constructor>
 560 <constructor cv="noexcept"><parameter name="value"><paramtype>const RealType &amp;</paramtype></parameter><parameter name="variance"><paramtype>const RealType &amp;</paramtype></parameter></constructor>
 561 </class></namespace>
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587 </namespace>
 588 </namespace>
 589 </header>
 590 <header name="boost/histogram/algorithm.hpp">
 591 <para>Includes all algorithm headers of the Boost.Histogram library. </para></header>
 592 <header name="boost/histogram/algorithm/empty.hpp">
 593 <namespace name="boost">
 594 <namespace name="histogram">
 595 <namespace name="algorithm">
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611 <function name="empty"><type>auto</type><template>
 612           <template-type-parameter name="A"/>
 613           <template-type-parameter name="S"/>
 614         </template><parameter name="h"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><parameter name="cov"><paramtype>coverage</paramtype></parameter><purpose>Check to see if all histogram cells are empty. </purpose><description><para>Use coverage to include or exclude the underflow/overflow bins.</para><para>This algorithm has O(N) complexity, where N is the number of cells.</para><para>Returns true if all cells are empty, and false otherwise. </para></description></function>
 615 </namespace>
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641 </namespace>
 642 </namespace>
 643 </header>
 644 <header name="boost/histogram/algorithm/project.hpp">
 645 <namespace name="boost">
 646 <namespace name="histogram">
 647 <namespace name="algorithm">
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661 <function name="project"><type>auto</type><template>
 662           <template-type-parameter name="A"/>
 663           <template-type-parameter name="S"/>
 664           <template-nontype-parameter name="N"><type>unsigned</type></template-nontype-parameter>
 665           <template-nontype-parameter name="Ns"><type>typename...</type></template-nontype-parameter>
 666         </template><parameter name="h"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><parameter name=""><paramtype>std::integral_constant&lt; unsigned, N &gt;</paramtype></parameter><parameter name=""><paramtype>Ns...</paramtype></parameter><purpose>Returns a lower-dimensional histogram, summing over removed axes. </purpose><description><para>Arguments are the source histogram and compile-time numbers, the remaining indices of the axes. Returns a new histogram which only contains the subset of axes. The source histogram is summed over the removed axes. </para></description></function>
 667 <function name="project"><type>auto</type><template>
 668           <template-type-parameter name="A"/>
 669           <template-type-parameter name="S"/>
 670           <template-type-parameter name="Iterable"/>
 671           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
 672         </template><parameter name="h"><paramtype>const <classname>histogram</classname>&lt; A, S &gt; &amp;</paramtype></parameter><parameter name="c"><paramtype>const Iterable &amp;</paramtype></parameter><purpose>Returns a lower-dimensional histogram, summing over removed axes. </purpose><description><para>This version accepts a source histogram and an iterable range containing the remaining indices. </para></description></function>
 673
 674 </namespace>
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700 </namespace>
 701 </namespace>
 702 </header>
 703 <header name="boost/histogram/algorithm/reduce.hpp">
 704 <namespace name="boost">
 705 <namespace name="histogram">
 706 <namespace name="algorithm">
 707 <typedef name="reduce_option"><type><emphasis>unspecified</emphasis></type></typedef>
 708
 709 <function name="shrink_and_rebin"><type>reduce_option</type><parameter name="iaxis"><paramtype>unsigned</paramtype><description><para>which axis to operate on. </para></description></parameter><parameter name="lower"><paramtype>double</paramtype><description><para>lowest bound that should be kept. </para></description></parameter><parameter name="upper"><paramtype>double</paramtype><description><para>highest bound that should be kept. If upper is inside bin interval, the whole interval is removed. </para></description></parameter><parameter name="merge"><paramtype>unsigned</paramtype><description><para>how many adjacent bins to merge into one. </para></description></parameter><purpose>Shrink and rebin option to be used in reduce(). </purpose><description><para>To shrink and rebin in one command. Equivalent to passing both the shrink() and the rebin() option for the same axis to reduce.</para><para>
 710 </para></description></function>
 711 <function name="slice_and_rebin"><type>reduce_option</type><parameter name="iaxis"><paramtype>unsigned</paramtype><description><para>which axis to operate on. </para></description></parameter><parameter name="begin"><paramtype>axis::index_type</paramtype><description><para>first index that should be kept. </para></description></parameter><parameter name="end"><paramtype>axis::index_type</paramtype><description><para>one past the last index that should be kept. </para></description></parameter><parameter name="merge"><paramtype>unsigned</paramtype><description><para>how many adjacent bins to merge into one. </para></description></parameter><purpose>Slice and rebin option to be used in reduce(). </purpose><description><para>To slice and rebin in one command. Equivalent to passing both the slice() and the rebin() option for the same axis to reduce.</para><para>
 712 </para></description></function>
 713 <function name="shrink"><type>reduce_option</type><parameter name="iaxis"><paramtype>unsigned</paramtype><description><para>which axis to operate on. </para></description></parameter><parameter name="lower"><paramtype>double</paramtype><description><para>bin which contains lower is first to be kept. </para></description></parameter><parameter name="upper"><paramtype>double</paramtype><description><para>bin which contains upper is last to be kept, except if upper is equal to the lower edge. </para></description></parameter><purpose>Shrink option to be used in reduce(). </purpose><description><para>The shrink is inclusive. The bin which contains the first value starts the range of bins to keep. The bin which contains the second value is the last included in that range. When the second value is exactly equal to a lower bin edge, then the previous bin is the last in the range.</para><para>
 714 </para></description></function>
 715 <function name="slice"><type>reduce_option</type><parameter name="iaxis"><paramtype>unsigned</paramtype><description><para>which axis to operate on. </para></description></parameter><parameter name="begin"><paramtype>axis::index_type</paramtype><description><para>first index that should be kept. </para></description></parameter><parameter name="end"><paramtype>axis::index_type</paramtype><description><para>one past the last index that should be kept. </para></description></parameter><purpose>Slice option to be used in reduce(). </purpose><description><para>
 716 </para></description></function>
 717 <function name="rebin"><type>reduce_option</type><parameter name="iaxis"><paramtype>unsigned</paramtype><description><para>which axis to operate on. </para></description></parameter><parameter name="merge"><paramtype>unsigned</paramtype><description><para>how many adjacent bins to merge into one. </para></description></parameter><purpose>Rebin option to be used in reduce(). </purpose><description><para>
 718 </para></description></function>
 719 <function name="shrink_and_rebin"><type>reduce_option</type><parameter name="lower"><paramtype>double</paramtype><description><para>lowest bound that should be kept. </para></description></parameter><parameter name="upper"><paramtype>double</paramtype><description><para>highest bound that should be kept. If upper is inside bin interval, the whole interval is removed. </para></description></parameter><parameter name="merge"><paramtype>unsigned</paramtype><description><para>how many adjacent bins to merge into one. </para></description></parameter><purpose>Shrink and rebin option to be used in reduce() (convenience overload for single axis). </purpose><description><para>
 720 </para></description></function>
 721 <function name="slice_and_rebin"><type>reduce_option</type><parameter name="begin"><paramtype>axis::index_type</paramtype><description><para>first index that should be kept. </para></description></parameter><parameter name="end"><paramtype>axis::index_type</paramtype><description><para>one past the last index that should be kept. </para></description></parameter><parameter name="merge"><paramtype>unsigned</paramtype><description><para>how many adjacent bins to merge into one. </para></description></parameter><purpose>Slice and rebin option to be used in reduce() (convenience for 1D histograms). </purpose><description><para>
 722 </para></description></function>
 723 <function name="shrink"><type>reduce_option</type><parameter name="lower"><paramtype>double</paramtype><description><para>lowest bound that should be kept. </para></description></parameter><parameter name="upper"><paramtype>double</paramtype><description><para>highest bound that should be kept. If upper is inside bin interval, the whole interval is removed. </para></description></parameter><purpose>Shrink option to be used in reduce() (convenience for 1D histograms). </purpose><description><para>
 724 </para></description></function>
 725 <function name="slice"><type>reduce_option</type><parameter name="begin"><paramtype>axis::index_type</paramtype><description><para>first index that should be kept. </para></description></parameter><parameter name="end"><paramtype>axis::index_type</paramtype><description><para>one past the last index that should be kept. </para></description></parameter><purpose>Slice option to be used in reduce() (convenience for 1D histograms). </purpose><description><para>
 726 </para></description></function>
 727 <function name="rebin"><type>reduce_option</type><parameter name="merge"><paramtype>unsigned</paramtype><description><para>how many adjacent bins to merge into one. </para></description></parameter><purpose>Rebin option to be used in reduce() (convenience for 1D histograms). </purpose><description><para>
 728 </para></description></function>
 729 <function name="reduce"><type>decltype(auto)</type><template>
 730           <template-type-parameter name="Histogram"/>
 731           <template-type-parameter name="Iterable"/>
 732           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
 733         </template><parameter name="hist"><paramtype>const Histogram &amp;</paramtype><description><para>original histogram. </para></description></parameter><parameter name="options"><paramtype>const Iterable &amp;</paramtype><description><para>iterable sequence of reduce options, generated by shrink_and_rebin(), slice_and_rebin(), shrink(), slice(), and rebin(). </para></description></parameter><purpose>Shrink, slice, and/or rebin axes of a histogram. </purpose><description><para>Returns the reduced copy of the histogram.</para><para>Shrinking only works with axes that accept double values. Some axis types do not support the reduce operation, for example, the builtin category axis, which is not ordered. Custom axis types must implement a special constructor (see concepts) to be reducible.</para><para>
 734 </para></description></function>
 735 <function name="reduce"><type>decltype(auto)</type><template>
 736           <template-type-parameter name="Histogram"/>
 737           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
 738         </template><parameter name="hist"><paramtype>const Histogram &amp;</paramtype><description><para>original histogram. </para></description></parameter><parameter name="opt"><paramtype>const reduce_option &amp;</paramtype><description><para>reduce option generated by shrink_and_rebin(), shrink(), and rebin(). </para></description></parameter><parameter name="opts"><paramtype>const Ts &amp;...</paramtype><description><para>more reduce options. </para></description></parameter><purpose>Shrink, slice, and/or rebin axes of a histogram. </purpose><description><para>Returns the reduced copy of the histogram.</para><para>Shrinking only works with axes that accept double values. Some axis types do not support the reduce operation, for example, the builtin category axis, which is not ordered. Custom axis types must implement a special constructor (see concepts) to be reducible.</para><para>
 739 </para></description></function>
 740
 741
 742
 743 </namespace>
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769 </namespace>
 770 </namespace>
 771 </header>
 772 <header name="boost/histogram/axis.hpp">
 773 <para>Includes all axis headers of the Boost.Histogram library. </para><para>Extra header not automatically included:<itemizedlist>
 774 <listitem><para><ulink url="histogram/reference.html#header.boost.histogram.axis.ostream_hpp">boost/histogram/axis/ostream.hpp</ulink> </para>
 775 </listitem></itemizedlist>
 776 </para></header>
 777 <header name="boost/histogram/axis/category.hpp">
 778 <namespace name="boost">
 779 <namespace name="histogram">
 780 <namespace name="axis">
 781 <class name="category"><template>
 782       <template-type-parameter name="Value"><purpose><para>input value type, must be equal-comparable. </para></purpose></template-type-parameter>
 783       <template-type-parameter name="MetaData"><purpose><para>type to store meta data. </para></purpose></template-type-parameter>
 784       <template-type-parameter name="Options"><purpose><para>see boost::histogram::axis::option. </para></purpose></template-type-parameter>
 785       <template-type-parameter name="Allocator"><purpose><para>allocator to use for dynamic memory management.</para></purpose></template-type-parameter>
 786     </template><inherit access="public">boost::histogram::axis::iterator_mixin&lt; category&lt; Value, MetaData, Options, Allocator &gt; &gt;</inherit><inherit access="public">boost::histogram::axis::metadata_base&lt; MetaData &gt;</inherit><purpose>Maps at a set of unique values to bin indices. </purpose><description><para>The axis maps a set of values to bins, following the order of arguments in the constructor. The optional overflow bin for this axis counts input values that are not part of the set. Binning has O(N) complexity, but with a very small factor. For small N (the typical use case) it beats other kinds of lookup.</para><para>
 787 The options <computeroutput>underflow</computeroutput> and <computeroutput>circular</computeroutput> are not allowed. The options <computeroutput>growth</computeroutput> and <computeroutput>overflow</computeroutput> are mutually exclusive. </para></description><method-group name="public member functions">
 788 <method name="index" cv="const noexcept"><type>index_type</type><parameter name="x"><paramtype>const value_type &amp;</paramtype></parameter><purpose>Return index for value argument. </purpose></method>
 789 <method name="update"><type>auto</type><parameter name="x"><paramtype>const value_type &amp;</paramtype></parameter><purpose>Returns index and shift (if axis has grown) for the passed argument. </purpose></method>
 790 <method name="value" cv="const"><type>auto</type><parameter name="idx"><paramtype>index_type</paramtype></parameter><purpose>Return value for index argument. </purpose><description><para>Throws <computeroutput>std::out_of_range</computeroutput> if the index is out of bounds. </para></description></method>
 791 <method name="bin" cv="const noexcept"><type>decltype(auto)</type><parameter name="idx"><paramtype>index_type</paramtype></parameter><purpose>Return value for index argument. </purpose></method>
 792 <method name="size" cv="const noexcept"><type>index_type</type><purpose>Returns the number of bins, without over- or underflow. </purpose></method>
 793 <method name="operator==" cv="const noexcept"><type>bool</type><template>
 794           <template-type-parameter name="V"/>
 795           <template-type-parameter name="M"/>
 796           <template-type-parameter name="O"/>
 797           <template-type-parameter name="A"/>
 798         </template><parameter name="o"><paramtype>const <classname>category</classname>&lt; V, M, O, A &gt; &amp;</paramtype></parameter></method>
 799 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
 800           <template-type-parameter name="V"/>
 801           <template-type-parameter name="M"/>
 802           <template-type-parameter name="O"/>
 803           <template-type-parameter name="A"/>
 804         </template><parameter name="o"><paramtype>const <classname>category</classname>&lt; V, M, O, A &gt; &amp;</paramtype></parameter></method>
 805 <method name="get_allocator" cv="const"><type>auto</type></method>
 806 <method name="serialize"><type>void</type><template>
 807           <template-type-parameter name="Archive"/>
 808         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
 809 </method-group>
 810 <constructor cv="= default"/>
 811 <constructor specifiers="explicit"><parameter name="alloc"><paramtype>allocator_type</paramtype></parameter></constructor>
 812 <constructor><template>
 813           <template-type-parameter name="It"/>
 814           <template-type-parameter name=""><default>detail::requires_iterator&lt;It&gt;</default></template-type-parameter>
 815         </template><parameter name="begin"><paramtype>It</paramtype><description><para>begin of category range of unique values. </para></description></parameter><parameter name="end"><paramtype>It</paramtype><description><para>end of category range of unique values. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis. </para></description></parameter><parameter name="alloc"><paramtype>allocator_type</paramtype><default>{}</default><description><para>allocator instance to use. </para></description></parameter><purpose>Construct from iterator range of unique values. </purpose><description><para>
 816 </para></description></constructor>
 817 <constructor><template>
 818           <template-type-parameter name="C"/>
 819           <template-type-parameter name=""><default>detail::requires_iterable&lt;C&gt;</default></template-type-parameter>
 820         </template><parameter name="iterable"><paramtype>const C &amp;</paramtype><description><para>sequence of unique values. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis. </para></description></parameter><parameter name="alloc"><paramtype>allocator_type</paramtype><default>{}</default><description><para>allocator instance to use. </para></description></parameter><purpose>Construct axis from iterable sequence of unique values. </purpose><description><para>
 821 </para></description></constructor>
 822 <constructor><template>
 823           <template-type-parameter name="U"/>
 824         </template><parameter name="list"><paramtype>std::initializer_list&lt; U &gt;</paramtype><description><para><computeroutput>std::initializer_list</computeroutput> of unique values. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis. </para></description></parameter><parameter name="alloc"><paramtype>allocator_type</paramtype><default>{}</default><description><para>allocator instance to use. </para></description></parameter><purpose>Construct axis from an initializer list of unique values. </purpose><description><para>
 825 </para></description></constructor>
 826 <method-group name="public static functions">
 827 <method name="options" cv="noexcept" specifiers="static"><type>constexpr unsigned</type><purpose>Returns the options. </purpose></method>
 828 <method name="inclusive" cv="noexcept" specifiers="static"><type>constexpr bool</type><purpose>Whether the axis is inclusive (see axis::traits::is_inclusive). </purpose></method>
 829 </method-group>
 830 </class>
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843 </namespace>
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869 </namespace>
 870 </namespace>
 871 </header>
 872 <header name="boost/histogram/axis/integer.hpp">
 873 <namespace name="boost">
 874 <namespace name="histogram">
 875 <namespace name="axis">
 876 <class name="integer"><template>
 877       <template-type-parameter name="Value"><purpose><para>input value type. Must be integer or floating point. </para></purpose></template-type-parameter>
 878       <template-type-parameter name="MetaData"><purpose><para>type to store meta data. </para></purpose></template-type-parameter>
 879       <template-type-parameter name="Options"><purpose><para>see boost::histogram::axis::option (all values allowed). </para></purpose></template-type-parameter>
 880     </template><inherit access="public">boost::histogram::axis::iterator_mixin&lt; integer&lt; Value, MetaData, Options &gt; &gt;</inherit><inherit access="public">boost::histogram::axis::metadata_base&lt; MetaData &gt;</inherit><purpose>Axis for an interval of integer values with unit steps. </purpose><description><para>Binning is a O(1) operation. This axis bins faster than a regular axis.</para><para>
 881 </para></description><method-group name="public member functions">
 882 <method name="index" cv="const noexcept"><type>index_type</type><parameter name="x"><paramtype>value_type</paramtype></parameter><purpose>Return index for value argument. </purpose></method>
 883 <method name="update" cv="noexcept"><type>auto</type><parameter name="x"><paramtype>value_type</paramtype></parameter><purpose>Returns index and shift (if axis has grown) for the passed argument. </purpose></method>
 884 <method name="value" cv="const noexcept"><type>value_type</type><parameter name="i"><paramtype>local_index_type</paramtype></parameter><purpose>Return value for index argument. </purpose></method>
 885 <method name="bin" cv="const noexcept"><type>decltype(auto)</type><parameter name="idx"><paramtype>index_type</paramtype></parameter><purpose>Return bin for index argument. </purpose></method>
 886 <method name="size" cv="const noexcept"><type>index_type</type><purpose>Returns the number of bins, without over- or underflow. </purpose></method>
 887 <method name="operator==" cv="const noexcept"><type>bool</type><template>
 888           <template-type-parameter name="V"/>
 889           <template-type-parameter name="M"/>
 890           <template-type-parameter name="O"/>
 891         </template><parameter name="o"><paramtype>const <classname>integer</classname>&lt; V, M, O &gt; &amp;</paramtype></parameter></method>
 892 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
 893           <template-type-parameter name="V"/>
 894           <template-type-parameter name="M"/>
 895           <template-type-parameter name="O"/>
 896         </template><parameter name="o"><paramtype>const <classname>integer</classname>&lt; V, M, O &gt; &amp;</paramtype></parameter></method>
 897 <method name="serialize"><type>void</type><template>
 898           <template-type-parameter name="Archive"/>
 899         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
 900 </method-group>
 901 <constructor cv="= default"/>
 902 <constructor><parameter name="start"><paramtype>value_type</paramtype><description><para>first integer of covered range. </para></description></parameter><parameter name="stop"><paramtype>value_type</paramtype><description><para>one past last integer of covered range. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis. </para></description></parameter><purpose>Construct over semi-open integer interval [start, stop). </purpose><description><para>
 903 </para></description></constructor>
 904 <constructor><parameter name="src"><paramtype>const <classname>integer</classname> &amp;</paramtype></parameter><parameter name="begin"><paramtype>index_type</paramtype></parameter><parameter name="end"><paramtype>index_type</paramtype></parameter><parameter name="merge"><paramtype>unsigned</paramtype></parameter><purpose>Constructor used by algorithm::reduce to shrink and rebin. </purpose></constructor>
 905 <method-group name="public static functions">
 906 <method name="options" cv="noexcept" specifiers="static"><type>constexpr unsigned</type><purpose>Returns the options. </purpose></method>
 907 <method name="inclusive" cv="noexcept" specifiers="static"><type>constexpr bool</type><purpose>Whether the axis is inclusive (see axis::traits::is_inclusive). </purpose></method>
 908 </method-group>
 909 <method-group name="private member functions">
 910 <method name="index_impl" cv="const noexcept"><type>index_type</type><parameter name=""><paramtype>std::false_type</paramtype></parameter><parameter name="x"><paramtype>int</paramtype></parameter></method>
 911 <method name="index_impl" cv="const noexcept"><type>index_type</type><template>
 912           <template-type-parameter name="T"/>
 913         </template><parameter name=""><paramtype>std::true_type</paramtype></parameter><parameter name="x"><paramtype>T</paramtype></parameter></method>
 914 </method-group>
 915 </class>
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928 </namespace>
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954 </namespace>
 955 </namespace>
 956 </header>
 957 <header name="boost/histogram/axis/interval_view.hpp">
 958 <namespace name="boost">
 959 <namespace name="histogram">
 960 <namespace name="axis">
 961 <class name="interval_view"><template>
 962       <template-type-parameter name="Axis"/>
 963     </template><purpose>Lightweight bin view. </purpose><description><para>Represents the current bin interval. </para></description><method-group name="public member functions">
 964 <method name="lower" cv="const noexcept"><type>decltype(auto)</type><purpose>Return lower edge of bin. </purpose></method>
 965 <method name="upper" cv="const noexcept"><type>decltype(auto)</type><purpose>Return upper edge of bin. </purpose></method>
 966 <method name="center" cv="const noexcept"><type>decltype(auto)</type><purpose>Return center of bin. </purpose></method>
 967 <method name="width" cv="const noexcept"><type>decltype(auto)</type><purpose>Return width of bin. </purpose></method>
 968 <method name="operator==" cv="const noexcept"><type>bool</type><template>
 969           <template-type-parameter name="BinType"/>
 970         </template><parameter name="rhs"><paramtype>const BinType &amp;</paramtype></parameter></method>
 971 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
 972           <template-type-parameter name="BinType"/>
 973         </template><parameter name="rhs"><paramtype>const BinType &amp;</paramtype></parameter></method>
 974 </method-group>
 975 <constructor><parameter name="axis"><paramtype>const Axis &amp;</paramtype></parameter><parameter name="idx"><paramtype>int</paramtype></parameter></constructor>
 976 <constructor cv="= delete"><parameter name="axis"><paramtype>Axis &amp;&amp;</paramtype></parameter><parameter name="idx"><paramtype>int</paramtype></parameter></constructor>
 977 </class>
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990 </namespace>
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016 </namespace>
1017 </namespace>
1018 </header>
1019 <header name="boost/histogram/axis/iterator.hpp">
1020 <namespace name="boost">
1021 <namespace name="histogram">
1022 <namespace name="axis">
1023 <class name="iterator"><template>
1024       <template-type-parameter name="Axis"/>
1025     </template><method-group name="public member functions">
1026 <method name="operator *" cv="const"><type>decltype(auto)</type><purpose>Return current bin object. </purpose></method>
1027 </method-group>
1028 <constructor><parameter name="axis"><paramtype>const Axis &amp;</paramtype></parameter><parameter name="idx"><paramtype>int</paramtype></parameter><purpose>Make iterator from axis and index. </purpose></constructor>
1029 </class><class name="iterator_mixin"><template>
1030       <template-type-parameter name="Derived"/>
1031     </template><purpose>Uses CRTP to inject iterator logic into Derived. </purpose><typedef name="const_iterator"><type>iterator&lt; Derived &gt;</type></typedef>
1032 <typedef name="const_reverse_iterator"><type>std::reverse_iterator&lt; const_iterator &gt;</type></typedef>
1033 <method-group name="public member functions">
1034 <method name="begin" cv="const noexcept"><type>const_iterator</type><purpose>Bin iterator to beginning of the axis (read-only). </purpose></method>
1035 <method name="end" cv="const noexcept"><type>const_iterator</type><purpose>Bin iterator to the end of the axis (read-only). </purpose></method>
1036 <method name="rbegin" cv="const noexcept"><type>const_reverse_iterator</type><purpose>Reverse bin iterator to the last entry of the axis (read-only). </purpose></method>
1037 <method name="rend" cv="const noexcept"><type>const_reverse_iterator</type><purpose>Reverse bin iterator to the end (read-only). </purpose></method>
1038 </method-group>
1039 </class>
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052 </namespace>
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078 </namespace>
1079 </namespace>
1080 </header>
1081 <header name="boost/histogram/axis/metadata_base.hpp">
1082 <namespace name="boost">
1083 <namespace name="histogram">
1084 <namespace name="axis">
1085 <class name="metadata_base"><template>
1086       <template-type-parameter name="Metadata"/>
1087       <template-type-parameter name="DetailMetadata"><default>detail::replace_default&lt;Metadata, std::string&gt;</default></template-type-parameter>
1088     </template><inherit access="private">empty_value&lt; DetailMetadata &gt;</inherit><purpose>Meta data holder with space optimization for empty meta data types. </purpose><method-group name="protected member functions">
1089 </method-group>
1090 <constructor cv="= default"/>
1091 <constructor cv="= default"><parameter name=""><paramtype>const <classname>metadata_base</classname> &amp;</paramtype></parameter></constructor>
1092 <copy-assignment cv="= default"><type><classname>metadata_base</classname> &amp;</type><parameter name=""><paramtype>const <classname>metadata_base</classname> &amp;</paramtype></parameter></copy-assignment>
1093 <constructor cv="noexcept"><parameter name="o"><paramtype><classname>metadata_base</classname> &amp;&amp;</paramtype></parameter></constructor>
1094 <constructor cv="noexcept"><parameter name="o"><paramtype>metadata_type &amp;&amp;</paramtype></parameter></constructor>
1095 <copy-assignment cv="noexcept"><type><classname>metadata_base</classname> &amp;</type><parameter name="o"><paramtype><classname>metadata_base</classname> &amp;&amp;</paramtype></parameter></copy-assignment>
1096 <method-group name="public member functions">
1097 <method name="metadata" cv="noexcept"><type>metadata_type &amp;</type><purpose>Returns reference to metadata. </purpose></method>
1098 <method name="metadata" cv="const noexcept"><type>const metadata_type &amp;</type><purpose>Returns reference to const metadata. </purpose></method>
1099 <method name="operator==" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>metadata_base</classname> &amp;</paramtype></parameter></method>
1100 <method name="operator!=" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>metadata_base</classname> &amp;</paramtype></parameter></method>
1101 </method-group>
1102 </class>
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115 </namespace>
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141 </namespace>
1142 </namespace>
1143 </header>
1144 <header name="boost/histogram/axis/option.hpp">
1145 <para>Options for builtin axis types. </para><para>Options <computeroutput>circular</computeroutput> and <computeroutput>growth</computeroutput> are mutually exclusive. Options <computeroutput>circular</computeroutput> and <computeroutput>underflow</computeroutput> are mutually exclusive. </para><namespace name="boost">
1146 <namespace name="histogram">
1147 <namespace name="axis">
1148 <namespace name="option">
1149 <struct name="bit"><template>
1150       <template-nontype-parameter name="Pos"><type>unsigned</type><purpose><para>position of the bit in the set. </para></purpose></template-nontype-parameter>
1151     </template><inherit access="public">boost::histogram::axis::option::bitset&lt;(1&lt;&lt; Pos)&gt;</inherit><purpose>Single option flag. </purpose><description><para>
1152 </para></description></struct><struct name="bitset"><template>
1153       <template-nontype-parameter name="Bits"><type>unsigned</type></template-nontype-parameter>
1154     </template><inherit access="public">std::integral_constant&lt; unsigned, Bits &gt;</inherit><purpose>Holder of axis options. </purpose><method-group name="public static functions">
1155 <method name="test" specifiers="static"><type>constexpr auto</type><template>
1156           <template-nontype-parameter name="B"><type>unsigned</type></template-nontype-parameter>
1157         </template><parameter name=""><paramtype><classname>bitset</classname>&lt; B &gt;</paramtype></parameter><purpose>Returns true if all option flags in the argument are set and false otherwise. </purpose></method>
1158 </method-group>
1159 </struct><typedef name="none_t"><purpose>All options off. </purpose><type><classname>bitset</classname>&lt; 0 &gt;</type></typedef>
1160 <typedef name="underflow_t"><purpose>Axis has an underflow bin. Mutually exclusive with <computeroutput>circular</computeroutput>. </purpose><type><classname>bit</classname>&lt; 0 &gt;</type></typedef>
1161 <typedef name="overflow_t"><purpose>Axis has overflow bin. </purpose><type><classname>bit</classname>&lt; 1 &gt;</type></typedef>
1162 <typedef name="circular_t"><purpose>Axis is circular. Mutually exclusive with <computeroutput>growth</computeroutput> and <computeroutput>underflow</computeroutput>. </purpose><type><classname>bit</classname>&lt; 2 &gt;</type></typedef>
1163 <typedef name="growth_t"><purpose>Axis can grow. Mutually exclusive with <computeroutput>circular</computeroutput>. </purpose><type><classname>bit</classname>&lt; 3 &gt;</type></typedef>
1164 <data-member name="none"><type>constexpr none_t</type><purpose>Instance of <computeroutput>none_t</computeroutput>. </purpose></data-member>
1165 <data-member name="underflow"><type>constexpr underflow_t</type><purpose>Instance of <computeroutput>underflow_t</computeroutput>. </purpose></data-member>
1166 <data-member name="overflow"><type>constexpr overflow_t</type><purpose>Instance of <computeroutput>overflow_t</computeroutput>. </purpose></data-member>
1167 <data-member name="circular"><type>constexpr circular_t</type><purpose>Instance of <computeroutput>circular_t</computeroutput>. </purpose></data-member>
1168 <data-member name="growth"><type>constexpr growth_t</type><purpose>Instance of <computeroutput>growth_t</computeroutput>. </purpose></data-member>
1169 <function name="operator|"><type>constexpr auto</type><template>
1170           <template-nontype-parameter name="B1"><type>unsigned</type></template-nontype-parameter>
1171           <template-nontype-parameter name="B2"><type>unsigned</type></template-nontype-parameter>
1172         </template><parameter name=""><paramtype><classname>bitset</classname>&lt; B1 &gt;</paramtype></parameter><parameter name=""><paramtype><classname>bitset</classname>&lt; B2 &gt;</paramtype></parameter><purpose>Set union of the axis option arguments. </purpose></function>
1173 <function name="operator&amp;"><type>constexpr auto</type><template>
1174           <template-nontype-parameter name="B1"><type>unsigned</type></template-nontype-parameter>
1175           <template-nontype-parameter name="B2"><type>unsigned</type></template-nontype-parameter>
1176         </template><parameter name=""><paramtype><classname>bitset</classname>&lt; B1 &gt;</paramtype></parameter><parameter name=""><paramtype><classname>bitset</classname>&lt; B2 &gt;</paramtype></parameter><purpose>Set intersection of the option arguments. </purpose></function>
1177 <function name="operator-"><type>constexpr auto</type><template>
1178           <template-nontype-parameter name="B1"><type>unsigned</type></template-nontype-parameter>
1179           <template-nontype-parameter name="B2"><type>unsigned</type></template-nontype-parameter>
1180         </template><parameter name=""><paramtype><classname>bitset</classname>&lt; B1 &gt;</paramtype></parameter><parameter name=""><paramtype><classname>bitset</classname>&lt; B2 &gt;</paramtype></parameter><purpose>Set difference of the option arguments. </purpose></function>
1181 </namespace>
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195 </namespace>
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221 </namespace>
1222 </namespace>
1223 </header>
1224 <header name="boost/histogram/axis/polymorphic_bin.hpp">
1225 <namespace name="boost">
1226 <namespace name="histogram">
1227 <namespace name="axis">
1228 <class name="polymorphic_bin"><template>
1229       <template-type-parameter name="RealType"/>
1230     </template><purpose>Holds the bin data of an <classname alt="boost::histogram::axis::variant">axis::variant</classname>. </purpose><description><para>The interface is a superset of the <classname alt="boost::histogram::axis::interval_view">axis::interval_view</classname> class. In addition, the object is implicitly convertible to the value type, returning the equivalent of a call to lower(). For discrete axes, lower() == upper(), and width() returns zero.</para><para>This is not a view like <classname alt="boost::histogram::axis::interval_view">axis::interval_view</classname> for two reasons.<itemizedlist>
1231 <listitem><para>Sequential calls to lower() and upper() would have to each loop through the variant types. This is likely to be slower than filling all the data in one loop.</para>
1232 </listitem><listitem><para><classname alt="boost::histogram::axis::polymorphic_bin">polymorphic_bin</classname> may be created from a temporary instance of <classname alt="boost::histogram::axis::variant">axis::variant</classname>, like in the call histogram::axis(0). Storing a reference to the axis would result in a dangling reference. Rather than specialing the code to handle this, it seems easier to just use a value instead of a view. </para>
1233 </listitem></itemizedlist>
1234 </para></description><method-group name="public member functions">
1235 <method name="conversion-operator" cv="const noexcept"><type>const value_type &amp;</type><purpose>Implicitly convert to bin value (for axis with discrete values). </purpose></method>
1236 <method name="lower" cv="const noexcept"><type>value_type</type><purpose>Return lower edge of bin. </purpose></method>
1237 <method name="upper" cv="const noexcept"><type>value_type</type><purpose>Return upper edge of bin. </purpose></method>
1238 <method name="center" cv="const noexcept"><type>value_type</type><purpose>Return center of bin. </purpose></method>
1239 <method name="width" cv="const noexcept"><type>value_type</type><purpose>Return width of bin. </purpose></method>
1240 <method name="operator==" cv="const noexcept"><type>bool</type><template>
1241           <template-type-parameter name="BinType"/>
1242         </template><parameter name="rhs"><paramtype>const BinType &amp;</paramtype></parameter></method>
1243 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
1244           <template-type-parameter name="BinType"/>
1245         </template><parameter name="rhs"><paramtype>const BinType &amp;</paramtype></parameter></method>
1246 <method name="is_discrete" cv="const noexcept"><type>bool</type><purpose>Return true if bin is discrete. </purpose></method>
1247 </method-group>
1248 <constructor><parameter name="lower"><paramtype>value_type</paramtype></parameter><parameter name="upper"><paramtype>value_type</paramtype></parameter></constructor>
1249 <method-group name="private member functions">
1250 <method name="equal_impl" cv="const noexcept"><type>bool</type><parameter name=""><paramtype>std::true_type</paramtype></parameter><parameter name="rhs"><paramtype>const <classname>polymorphic_bin</classname> &amp;</paramtype></parameter></method>
1251 <method name="equal_impl" cv="const noexcept"><type>bool</type><template>
1252           <template-type-parameter name="BinType"/>
1253         </template><parameter name=""><paramtype>std::true_type</paramtype></parameter><parameter name="rhs"><paramtype>const BinType &amp;</paramtype></parameter></method>
1254 <method name="equal_impl" cv="const noexcept"><type>bool</type><template>
1255           <template-type-parameter name="BinType"/>
1256         </template><parameter name=""><paramtype>std::false_type</paramtype></parameter><parameter name="rhs"><paramtype>const BinType &amp;</paramtype></parameter></method>
1257 </method-group>
1258 </class>
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271 </namespace>
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297 </namespace>
1298 </namespace>
1299 </header>
1300 <header name="boost/histogram/axis/regular.hpp">
1301 <namespace name="boost">
1302 <namespace name="histogram">
1303 <namespace name="axis">
1304 <class name="circular"><template>
1305       <template-type-parameter name="Value"><default>double</default></template-type-parameter>
1306       <template-type-parameter name="MetaData"><default>use_default</default></template-type-parameter>
1307       <template-type-parameter name="Options"><default>use_default</default></template-type-parameter>
1308     </template><purpose>Regular axis with circular option already set. </purpose></class><class name="regular"><template>
1309       <template-type-parameter name="Value"><purpose><para>input value type, must be floating point. </para></purpose></template-type-parameter>
1310       <template-type-parameter name="Transform"><purpose><para>builtin or user-defined transform type. </para></purpose></template-type-parameter>
1311       <template-type-parameter name="MetaData"><purpose><para>type to store meta data. </para></purpose></template-type-parameter>
1312       <template-type-parameter name="Options"><purpose><para>see boost::histogram::axis::option (all values allowed). </para></purpose></template-type-parameter>
1313     </template><inherit access="public">boost::histogram::axis::iterator_mixin&lt; regular&lt; Value, Transform, MetaData, Options &gt; &gt;</inherit><inherit access="public">boost::histogram::axis::metadata_base&lt; MetaData &gt;</inherit><purpose>Axis for equidistant intervals on the real line. </purpose><description><para>The most common binning strategy. Very fast. Binning is a O(1) operation.</para><para>
1314 </para></description><method-group name="public member functions">
1315 <method name="transform" cv="const noexcept"><type>const transform_type &amp;</type><purpose>Return instance of the transform type. </purpose></method>
1316 <method name="index" cv="const noexcept"><type>index_type</type><parameter name="x"><paramtype>value_type</paramtype></parameter><purpose>Return index for value argument. </purpose></method>
1317 <method name="update" cv="noexcept"><type>auto</type><parameter name="x"><paramtype>value_type</paramtype></parameter><purpose>Returns index and shift (if axis has grown) for the passed argument. </purpose></method>
1318 <method name="value" cv="const noexcept"><type>value_type</type><parameter name="i"><paramtype>real_index_type</paramtype></parameter><purpose>Return value for fractional index argument. </purpose></method>
1319 <method name="bin" cv="const noexcept"><type>decltype(auto)</type><parameter name="idx"><paramtype>index_type</paramtype></parameter><purpose>Return bin for index argument. </purpose></method>
1320 <method name="size" cv="const noexcept"><type>index_type</type><purpose>Returns the number of bins, without over- or underflow. </purpose></method>
1321 <method name="operator==" cv="const noexcept"><type>bool</type><template>
1322           <template-type-parameter name="V"/>
1323           <template-type-parameter name="T"/>
1324           <template-type-parameter name="M"/>
1325           <template-type-parameter name="O"/>
1326         </template><parameter name="o"><paramtype>const <classname>regular</classname>&lt; V, T, M, O &gt; &amp;</paramtype></parameter></method>
1327 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
1328           <template-type-parameter name="V"/>
1329           <template-type-parameter name="T"/>
1330           <template-type-parameter name="M"/>
1331           <template-type-parameter name="O"/>
1332         </template><parameter name="o"><paramtype>const <classname>regular</classname>&lt; V, T, M, O &gt; &amp;</paramtype></parameter></method>
1333 <method name="serialize"><type>void</type><template>
1334           <template-type-parameter name="Archive"/>
1335         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
1336 </method-group>
1337 <constructor cv="= default"/>
1338 <constructor><parameter name="trans"><paramtype>transform_type</paramtype><description><para>transform instance to use. </para></description></parameter><parameter name="n"><paramtype>unsigned</paramtype><description><para>number of bins. </para></description></parameter><parameter name="start"><paramtype>value_type</paramtype><description><para>low edge of first bin. </para></description></parameter><parameter name="stop"><paramtype>value_type</paramtype><description><para>high edge of last bin. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis (optional). </para></description></parameter><purpose>Construct n bins over real transformed range [start, stop). </purpose><description><para>
1339 </para></description></constructor>
1340 <constructor><parameter name="n"><paramtype>unsigned</paramtype><description><para>number of bins. </para></description></parameter><parameter name="start"><paramtype>value_type</paramtype><description><para>low edge of first bin. </para></description></parameter><parameter name="stop"><paramtype>value_type</paramtype><description><para>high edge of last bin. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis (optional). </para></description></parameter><purpose>Construct n bins over real range [start, stop). </purpose><description><para>
1341 </para></description></constructor>
1342 <constructor><template>
1343           <template-type-parameter name="T"/>
1344         </template><parameter name="trans"><paramtype>transform_type</paramtype><description><para>transform instance to use. </para></description></parameter><parameter name="step"><paramtype>step_type&lt; T &gt;</paramtype><description><para>width of a single bin. </para></description></parameter><parameter name="start"><paramtype>value_type</paramtype><description><para>low edge of first bin. </para></description></parameter><parameter name="stop"><paramtype>value_type</paramtype><description><para>upper limit of high edge of last bin (see below). </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis (optional).</para></description></parameter><purpose>Construct bins with the given step size over real transformed range [start, stop). </purpose><description><para>
1345 The axis computes the number of bins as n = abs(stop - start) / step, rounded down. This means that stop is an upper limit to the actual value (start + n * step). </para></description></constructor>
1346 <constructor><template>
1347           <template-type-parameter name="T"/>
1348         </template><parameter name="step"><paramtype>step_type&lt; T &gt;</paramtype><description><para>width of a single bin. </para></description></parameter><parameter name="start"><paramtype>value_type</paramtype><description><para>low edge of first bin. </para></description></parameter><parameter name="stop"><paramtype>value_type</paramtype><description><para>upper limit of high edge of last bin (see below). </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis (optional).</para></description></parameter><purpose>Construct bins with the given step size over real range [start, stop). </purpose><description><para>
1349 The axis computes the number of bins as n = abs(stop - start) / step, rounded down. This means that stop is an upper limit to the actual value (start + n * step). </para></description></constructor>
1350 <constructor><parameter name="src"><paramtype>const <classname>regular</classname> &amp;</paramtype></parameter><parameter name="begin"><paramtype>index_type</paramtype></parameter><parameter name="end"><paramtype>index_type</paramtype></parameter><parameter name="merge"><paramtype>unsigned</paramtype></parameter><purpose>Constructor used by algorithm::reduce to shrink and rebin (not for users). </purpose></constructor>
1351 <method-group name="public static functions">
1352 <method name="options" cv="noexcept" specifiers="static"><type>constexpr unsigned</type><purpose>Returns the options. </purpose></method>
1353 </method-group>
1354 </class><namespace name="transform">
1355 <struct name="id"><purpose>Identity transform for equidistant bins. </purpose><method-group name="public static functions">
1356 <method name="forward" cv="noexcept" specifiers="static"><type>T</type><template>
1357           <template-type-parameter name="T"/>
1358         </template><parameter name="x"><paramtype>T &amp;&amp;</paramtype></parameter><purpose>Pass-through. </purpose></method>
1359 <method name="inverse" cv="noexcept" specifiers="static"><type>T</type><template>
1360           <template-type-parameter name="T"/>
1361         </template><parameter name="x"><paramtype>T &amp;&amp;</paramtype></parameter><purpose>Pass-through. </purpose></method>
1362 </method-group>
1363 <method-group name="public member functions">
1364 <method name="serialize"><type>void</type><template>
1365           <template-type-parameter name="Archive"/>
1366         </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
1367 </method-group>
1368 </struct><struct name="log"><purpose>Log transform for equidistant bins in log-space. </purpose><method-group name="public static functions">
1369 <method name="forward" specifiers="static"><type>T</type><template>
1370           <template-type-parameter name="T"/>
1371         </template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns log(x) of external value x. </purpose></method>
1372 <method name="inverse" specifiers="static"><type>T</type><template>
1373           <template-type-parameter name="T"/>
1374         </template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns exp(x) for internal value x. </purpose></method>
1375 </method-group>
1376 <method-group name="public member functions">
1377 <method name="serialize"><type>void</type><template>
1378           <template-type-parameter name="Archive"/>
1379         </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
1380 </method-group>
1381 </struct><struct name="pow"><purpose>Pow transform for equidistant bins in pow-space. </purpose><data-member name="power"><type>double</type><purpose>power index </purpose></data-member>
1382 <method-group name="public member functions">
1383 <method name="forward" cv="const"><type>auto</type><template>
1384           <template-type-parameter name="T"/>
1385         </template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns pow(x, power) of external value x. </purpose></method>
1386 <method name="inverse" cv="const"><type>auto</type><template>
1387           <template-type-parameter name="T"/>
1388         </template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns pow(x, 1/power) of external value x. </purpose></method>
1389 <method name="operator==" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>pow</classname> &amp;</paramtype></parameter></method>
1390 <method name="serialize"><type>void</type><template>
1391           <template-type-parameter name="Archive"/>
1392         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
1393 </method-group>
1394 <constructor specifiers="explicit"><parameter name="p"><paramtype>double</paramtype></parameter><purpose>Make transform with index p. </purpose></constructor>
1395 <constructor cv="= default"/>
1396 </struct><struct name="sqrt"><purpose>Sqrt transform for equidistant bins in sqrt-space. </purpose><method-group name="public static functions">
1397 <method name="forward" specifiers="static"><type>T</type><template>
1398           <template-type-parameter name="T"/>
1399         </template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns sqrt(x) of external value x. </purpose></method>
1400 <method name="inverse" specifiers="static"><type>T</type><template>
1401           <template-type-parameter name="T"/>
1402         </template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns x^2 of internal value x. </purpose></method>
1403 </method-group>
1404 <method-group name="public member functions">
1405 <method name="serialize"><type>void</type><template>
1406           <template-type-parameter name="Archive"/>
1407         </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
1408 </method-group>
1409 </struct></namespace>
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422 <function name="step"><type>step_type&lt; T &gt;</type><template>
1423           <template-type-parameter name="T"/>
1424         </template><parameter name="t"><paramtype>T</paramtype></parameter><purpose>Helper function to mark argument as step size. </purpose></function>
1425 </namespace>
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451 </namespace>
1452 </namespace>
1453 </header>
1454 <header name="boost/histogram/axis/traits.hpp">
1455 <namespace name="boost">
1456 <namespace name="histogram">
1457 <namespace name="axis">
1458 <namespace name="traits">
1459 <struct name="is_continuous"><template>
1460       <template-type-parameter name="Axis"/>
1461     </template><purpose>Whether axis is continuous or discrete. </purpose><description><para>Doxygen does not render this well. This is a meta-function (template alias), it accepts an axis type and returns a compile-time boolean. If the boolean is true, the axis is continuous. Otherwise it is discrete. </para></description></struct><struct name="is_reducible"><template>
1462       <template-type-parameter name="Axis"><purpose><para>axis type. </para></purpose></template-type-parameter>
1463     </template><purpose>Meta-function to detect whether an axis is reducible. </purpose><description><para>Doxygen does not render this well. This is a meta-function (template alias), it accepts an axis type and represents compile-time boolean which is true or false, depending on whether the axis can be reduced with boost::histogram::algorithm::reduce().</para><para>
1464 </para></description></struct><struct name="static_is_inclusive"><template>
1465       <template-type-parameter name="Axis"/>
1466     </template><purpose>Meta-function to detect whether an axis is inclusive. </purpose><description><para>Doxygen does not render this well. This is a meta-function (template alias), it accepts an axis type and represents compile-time boolean which is true or false, depending on whether the axis is inclusive or not.</para><para>An inclusive axis has a bin for every possible input value. A histogram which consists only of inclusive axes can be filled more efficiently, since input values always end up in a valid cell and there is no need to keep track of input tuples that need to be discarded.</para><para>An axis with underflow and overflow bins is always inclusive, but an axis may be inclusive under other conditions. The meta-function checks for the method <computeroutput>constexpr static bool inclusive()</computeroutput>, and uses the result. If this method is not present, it uses static_options&lt;Axis&gt; and checks whether the underflow and overflow bits are present.</para><para>
1467 </para></description></struct><struct name="static_options"><template>
1468       <template-type-parameter name="Axis"><purpose><para>axis type </para></purpose></template-type-parameter>
1469     </template><purpose>Get static axis options for axis type. </purpose><description><para>Doxygen does not render this well. This is a meta-function (template alias), it accepts an axis type and returns the <classname alt="boost::histogram::axis::option::bitset">boost::histogram::axis::option::bitset</classname>.</para><para>If Axis::options() is valid and constexpr, <classname alt="boost::histogram::axis::traits::static_options">static_options</classname> is the corresponding option type. Otherwise, it is boost::histogram::axis::option::growth_t, if the axis has a method <computeroutput>update</computeroutput>, else boost::histogram::axis::option::none_t.</para><para>
1470 </para></description></struct><struct name="value_type"><template>
1471       <template-type-parameter name="Axis"/>
1472     </template><purpose>Get value type for axis type. </purpose><description><para>Doxygen does not render this well. This is a meta-function (template alias), it accepts an axis type and returns the value type. </para></description></struct><function name="options"><type>constexpr unsigned</type><template>
1473           <template-type-parameter name="Axis"/>
1474         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><purpose>Returns axis options as unsigned integer. </purpose><description><para>If axis.options() is a valid expression, return the result. Otherwise, return static_options&lt;Axis&gt;::value.</para><para>
1475 </para></description></function>
1476 <function name="options"><type>unsigned</type><template>
1477           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
1478         </template><parameter name="axis"><paramtype>const <classname>variant</classname>&lt; Ts... &gt; &amp;</paramtype></parameter></function>
1479 <function name="inclusive"><type>constexpr bool</type><template>
1480           <template-type-parameter name="Axis"/>
1481         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><purpose>Returns true if axis is inclusive or false. </purpose><description><para>See <classname alt="boost::histogram::axis::traits::static_is_inclusive">static_is_inclusive</classname> for details.</para><para>
1482 </para></description></function>
1483 <function name="inclusive"><type>bool</type><template>
1484           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
1485         </template><parameter name="axis"><paramtype>const <classname>variant</classname>&lt; Ts... &gt; &amp;</paramtype></parameter></function>
1486 <function name="extent"><type>index_type</type><template>
1487           <template-type-parameter name="Axis"/>
1488         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><purpose>Returns axis size plus any extra bins for under- and overflow. </purpose><description><para>
1489 </para></description></function>
1490 <function name="metadata"><type>decltype(auto)</type><template>
1491           <template-type-parameter name="Axis"/>
1492         </template><parameter name="axis"><paramtype>Axis &amp;&amp;</paramtype><description><para>any axis instance </para></description></parameter><purpose>Returns reference to metadata of an axis. </purpose><description><para>If the expression x.metadata() for an axis instance <computeroutput>x</computeroutput> (maybe const) is valid, return the result. Otherwise, return a reference to a static instance of <classname alt="boost::histogram::axis::null_type">boost::histogram::axis::null_type</classname>.</para><para>
1493 </para></description></function>
1494 <function name="value"><type>decltype(auto)</type><template>
1495           <template-type-parameter name="Axis"/>
1496         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><parameter name="index"><paramtype>real_index_type</paramtype><description><para>floating point axis index </para></description></parameter><purpose>Returns axis value for index. </purpose><description><para>If the axis has no <computeroutput>value</computeroutput> method, throw std::runtime_error. If the method exists and accepts a floating point index, pass the index and return the result. If the method exists but accepts only integer indices, cast the floating point index to int, pass this index and return the result.</para><para>
1497 </para></description></function>
1498 <function name="value_as"><type>Result</type><template>
1499           <template-type-parameter name="Result"><purpose><para>requested return type </para></purpose></template-type-parameter>
1500           <template-type-parameter name="Axis"><purpose><para>axis type </para></purpose></template-type-parameter>
1501         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><parameter name="index"><paramtype>real_index_type</paramtype><description><para>floating point axis index </para></description></parameter><purpose>Returns axis value for index if it is convertible to target type or throws. </purpose><description><para>Like boost::histogram::axis::traits::value, but converts the result into the requested return type. If the conversion is not possible, throws std::runtime_error.</para><para>
1502
1503 </para></description></function>
1504 <function name="index"><type>axis::index_type</type><template>
1505           <template-type-parameter name="Axis"/>
1506           <template-type-parameter name="U"/>
1507         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><parameter name="value"><paramtype>const U &amp;</paramtype><description><para>argument to be passed to <computeroutput>index</computeroutput> method </para></description></parameter><purpose>Returns axis index for value. </purpose><description><para>Throws std::invalid_argument if the value argument is not implicitly convertible.</para><para>
1508 </para></description></function>
1509 <function name="index"><type>axis::index_type</type><template>
1510           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
1511           <template-type-parameter name="U"/>
1512         </template><parameter name="axis"><paramtype>const <classname>variant</classname>&lt; Ts... &gt; &amp;</paramtype></parameter><parameter name="value"><paramtype>const U &amp;</paramtype></parameter></function>
1513 <function name="rank"><type>constexpr unsigned</type><template>
1514           <template-type-parameter name="Axis"/>
1515         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><purpose>Return axis rank (how many arguments it processes). </purpose><description><para>
1516 </para></description></function>
1517 <function name="rank"><type>unsigned</type><template>
1518           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
1519         </template><parameter name="axis"><paramtype>const <classname>axis::variant</classname>&lt; Ts... &gt; &amp;</paramtype></parameter></function>
1520 <function name="update"><type>std::pair&lt; index_type, index_type &gt;</type><template>
1521           <template-type-parameter name="Axis"/>
1522           <template-type-parameter name="U"/>
1523         </template><parameter name="axis"><paramtype>Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><parameter name="value"><paramtype>const U &amp;</paramtype><description><para>argument to be passed to <computeroutput>update</computeroutput> or <computeroutput>index</computeroutput> method </para></description></parameter><purpose>Returns pair of axis index and shift for the value argument. </purpose><description><para>Throws <computeroutput>std::invalid_argument</computeroutput> if the value argument is not implicitly convertible to the argument expected by the <computeroutput>index</computeroutput> method. If the result of boost::histogram::axis::traits::static_options&lt;decltype(axis)&gt; has the growth flag set, call <computeroutput>update</computeroutput> method with the argument and return the result. Otherwise, call <computeroutput>index</computeroutput> and return the pair of the result and a zero shift.</para><para>
1524 </para></description></function>
1525 <function name="update"><type>std::pair&lt; index_type, index_type &gt;</type><template>
1526           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
1527           <template-type-parameter name="U"/>
1528         </template><parameter name="axis"><paramtype><classname>variant</classname>&lt; Ts... &gt; &amp;</paramtype></parameter><parameter name="value"><paramtype>const U &amp;</paramtype></parameter></function>
1529 <function name="width"><type>decltype(auto)</type><template>
1530           <template-type-parameter name="Axis"/>
1531         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><parameter name="index"><paramtype>index_type</paramtype><description><para>bin index </para></description></parameter><purpose>Returns bin width at axis index. </purpose><description><para>If the axis has no <computeroutput>value</computeroutput> method, throw std::runtime_error. If the method exists and accepts a floating point index, return the result of <computeroutput>axis.value(index + 1) - axis.value(index)</computeroutput>. If the method exists but accepts only integer indices, return 0.</para><para>
1532 </para></description></function>
1533 <function name="width_as"><type>Result</type><template>
1534           <template-type-parameter name="Result"/>
1535           <template-type-parameter name="Axis"/>
1536         </template><parameter name="axis"><paramtype>const Axis &amp;</paramtype><description><para>any axis instance </para></description></parameter><parameter name="index"><paramtype>index_type</paramtype><description><para>bin index </para></description></parameter><purpose>Returns bin width at axis index. </purpose><description><para>Like boost::histogram::axis::traits::width, but converts the result into the requested return type. If the conversion is not possible, throw std::runtime_error.</para><para>
1537 </para></description></function>
1538 </namespace>
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552 </namespace>
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578 </namespace>
1579 </namespace>
1580 </header>
1581 <header name="boost/histogram/axis/variable.hpp">
1582 <namespace name="boost">
1583 <namespace name="histogram">
1584 <namespace name="axis">
1585 <class name="variable"><template>
1586       <template-type-parameter name="Value"><purpose><para>input value type, must be floating point. </para></purpose></template-type-parameter>
1587       <template-type-parameter name="MetaData"><purpose><para>type to store meta data. </para></purpose></template-type-parameter>
1588       <template-type-parameter name="Options"><purpose><para>see boost::histogram::axis::option (all values allowed). </para></purpose></template-type-parameter>
1589       <template-type-parameter name="Allocator"><purpose><para>allocator to use for dynamic memory management. </para></purpose></template-type-parameter>
1590     </template><inherit access="public">boost::histogram::axis::iterator_mixin&lt; variable&lt; Value, MetaData, Options, Allocator &gt; &gt;</inherit><inherit access="public">boost::histogram::axis::metadata_base&lt; MetaData &gt;</inherit><purpose>Axis for non-equidistant bins on the real line. </purpose><description><para>Binning is a O(log(N)) operation. If speed matters and the problem domain allows it, prefer a regular axis, possibly with a transform.</para><para>
1591 </para></description><method-group name="public member functions">
1592 <method name="index" cv="const noexcept"><type>index_type</type><parameter name="x"><paramtype>value_type</paramtype></parameter><purpose>Return index for value argument. </purpose></method>
1593 <method name="update" cv="noexcept"><type>auto</type><parameter name="x"><paramtype>value_type</paramtype></parameter></method>
1594 <method name="value" cv="const noexcept"><type>value_type</type><parameter name="i"><paramtype>real_index_type</paramtype></parameter><purpose>Return value for fractional index argument. </purpose></method>
1595 <method name="bin" cv="const noexcept"><type>auto</type><parameter name="idx"><paramtype>index_type</paramtype></parameter><purpose>Return bin for index argument. </purpose></method>
1596 <method name="size" cv="const noexcept"><type>index_type</type><purpose>Returns the number of bins, without over- or underflow. </purpose></method>
1597 <method name="operator==" cv="const noexcept"><type>bool</type><template>
1598           <template-type-parameter name="V"/>
1599           <template-type-parameter name="M"/>
1600           <template-type-parameter name="O"/>
1601           <template-type-parameter name="A"/>
1602         </template><parameter name="o"><paramtype>const <classname>variable</classname>&lt; V, M, O, A &gt; &amp;</paramtype></parameter></method>
1603 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
1604           <template-type-parameter name="V"/>
1605           <template-type-parameter name="M"/>
1606           <template-type-parameter name="O"/>
1607           <template-type-parameter name="A"/>
1608         </template><parameter name="o"><paramtype>const <classname>variable</classname>&lt; V, M, O, A &gt; &amp;</paramtype></parameter></method>
1609 <method name="get_allocator" cv="const"><type>auto</type><purpose>Return allocator instance. </purpose></method>
1610 <method name="serialize"><type>void</type><template>
1611           <template-type-parameter name="Archive"/>
1612         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
1613 </method-group>
1614 <constructor cv="= default"/>
1615 <constructor specifiers="explicit"><parameter name="alloc"><paramtype>allocator_type</paramtype></parameter></constructor>
1616 <constructor><template>
1617           <template-type-parameter name="It"/>
1618           <template-type-parameter name=""><default>detail::requires_iterator&lt;It&gt;</default></template-type-parameter>
1619         </template><parameter name="begin"><paramtype>It</paramtype><description><para>begin of edge sequence. </para></description></parameter><parameter name="end"><paramtype>It</paramtype><description><para>end of edge sequence. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis. </para></description></parameter><parameter name="alloc"><paramtype>allocator_type</paramtype><default>{}</default><description><para>allocator instance to use. </para></description></parameter><purpose>Construct from iterator range of bin edges. </purpose><description><para>
1620 </para></description></constructor>
1621 <constructor><template>
1622           <template-type-parameter name="U"/>
1623           <template-type-parameter name=""><default>detail::requires_iterable&lt;U&gt;</default></template-type-parameter>
1624         </template><parameter name="iterable"><paramtype>const U &amp;</paramtype><description><para>iterable range of bin edges. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis. </para></description></parameter><parameter name="alloc"><paramtype>allocator_type</paramtype><default>{}</default><description><para>allocator instance to use. </para></description></parameter><purpose>Construct variable axis from iterable range of bin edges. </purpose><description><para>
1625 </para></description></constructor>
1626 <constructor><template>
1627           <template-type-parameter name="U"/>
1628         </template><parameter name="list"><paramtype>std::initializer_list&lt; U &gt;</paramtype><description><para><computeroutput>std::initializer_list</computeroutput> of bin edges. </para></description></parameter><parameter name="meta"><paramtype>metadata_type</paramtype><default>{}</default><description><para>description of the axis. </para></description></parameter><parameter name="alloc"><paramtype>allocator_type</paramtype><default>{}</default><description><para>allocator instance to use. </para></description></parameter><purpose>Construct variable axis from initializer list of bin edges. </purpose><description><para>
1629 </para></description></constructor>
1630 <constructor><parameter name="src"><paramtype>const <classname>variable</classname> &amp;</paramtype></parameter><parameter name="begin"><paramtype>index_type</paramtype></parameter><parameter name="end"><paramtype>index_type</paramtype></parameter><parameter name="merge"><paramtype>unsigned</paramtype></parameter><purpose>Constructor used by algorithm::reduce to shrink and rebin (not for users). </purpose></constructor>
1631 <method-group name="public static functions">
1632 <method name="options" cv="noexcept" specifiers="static"><type>constexpr unsigned</type><purpose>Returns the options. </purpose></method>
1633 </method-group>
1634 </class>
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647 </namespace>
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673 </namespace>
1674 </namespace>
1675 </header>
1676 <header name="boost/histogram/axis/variant.hpp">
1677 <namespace name="boost">
1678 <namespace name="histogram">
1679 <namespace name="axis">
1680 <class name="variant"><template>
1681       <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
1682     </template><inherit access="public">boost::histogram::axis::iterator_mixin&lt; variant&lt; Ts... &gt; &gt;</inherit><purpose>Polymorphic axis type. </purpose><method-group name="public member functions">
1683 <method name="size" cv="const"><type>index_type</type><purpose>Return size of axis. </purpose></method>
1684 <method name="options" cv="const"><type>unsigned</type><purpose>Return options of axis or option::none_t if axis has no options. </purpose></method>
1685 <method name="inclusive" cv="const"><type>bool</type><purpose>Returns true if the axis is inclusive or false. </purpose></method>
1686 <method name="metadata" cv="const"><type>const metadata_type &amp;</type><purpose>Return reference to const metadata or instance of <classname alt="boost::histogram::axis::null_type">null_type</classname> if axis has no metadata. </purpose></method>
1687 <method name="metadata"><type>metadata_type &amp;</type><purpose>Return reference to metadata or instance of <classname alt="boost::histogram::axis::null_type">null_type</classname> if axis has no metadata. </purpose></method>
1688 <method name="index" cv="const"><type>index_type</type><template>
1689           <template-type-parameter name="U"/>
1690         </template><parameter name="u"><paramtype>const U &amp;</paramtype></parameter><purpose>Return index for value argument. </purpose><description><para>Throws std::invalid_argument if axis has incompatible call signature. </para></description></method>
1691 <method name="value" cv="const"><type>double</type><parameter name="idx"><paramtype>real_index_type</paramtype></parameter><purpose>Return value for index argument. </purpose><description><para>Only works for axes with value method that returns something convertible to double and will throw a runtime_error otherwise, see axis::traits::value(). </para></description></method>
1692 <method name="bin" cv="const"><type>auto</type><parameter name="idx"><paramtype>index_type</paramtype></parameter><purpose>Return bin for index argument. </purpose><description><para>Only works for axes with value method that returns something convertible to double and will throw a runtime_error otherwise, see axis::traits::value(). </para></description></method>
1693 <method name="operator==" cv="const"><type>bool</type><template>
1694           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1695         </template><parameter name="u"><paramtype>const <classname>variant</classname>&lt; Us... &gt; &amp;</paramtype></parameter><purpose>Compare two variants. </purpose><description><para>Return true if the variants point to the same concrete axis type and the types compare equal. Otherwise return false. </para></description></method>
1696 <method name="operator==" cv="const"><type>bool</type><template>
1697           <template-type-parameter name="T"/>
1698         </template><parameter name="t"><paramtype>const T &amp;</paramtype></parameter><purpose>Compare variant with a concrete axis type. </purpose><description><para>Return true if the variant point to the same concrete axis type and the types compare equal. Otherwise return false. </para></description></method>
1699 <method name="operator!=" cv="const"><type>bool</type><template>
1700           <template-type-parameter name="T"/>
1701         </template><parameter name="t"><paramtype>const T &amp;</paramtype></parameter><purpose>The negation of operator==. </purpose></method>
1702 <method name="serialize"><type>void</type><template>
1703           <template-type-parameter name="Archive"/>
1704         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
1705 </method-group>
1706 <constructor cv="= default"/>
1707 <constructor cv="= default"><parameter name=""><paramtype>const <classname>variant</classname> &amp;</paramtype></parameter></constructor>
1708 <copy-assignment cv="= default"><type><classname>variant</classname> &amp;</type><parameter name=""><paramtype>const <classname>variant</classname> &amp;</paramtype></parameter></copy-assignment>
1709 <constructor cv="= default"><parameter name=""><paramtype><classname>variant</classname> &amp;&amp;</paramtype></parameter></constructor>
1710 <copy-assignment cv="= default"><type><classname>variant</classname> &amp;</type><parameter name=""><paramtype><classname>variant</classname> &amp;&amp;</paramtype></parameter></copy-assignment>
1711 <constructor><template>
1712           <template-type-parameter name="T"/>
1713           <template-type-parameter name=""><default>requires_bounded_type&lt;T&gt;</default></template-type-parameter>
1714         </template><parameter name="t"><paramtype>T &amp;&amp;</paramtype></parameter></constructor>
1715 <copy-assignment><type><classname>variant</classname> &amp;</type><template>
1716           <template-type-parameter name="T"/>
1717           <template-type-parameter name=""><default>requires_bounded_type&lt;T&gt;</default></template-type-parameter>
1718         </template><parameter name="t"><paramtype>T &amp;&amp;</paramtype></parameter></copy-assignment>
1719 <constructor><template>
1720           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1721         </template><parameter name="u"><paramtype>const <classname>variant</classname>&lt; Us... &gt; &amp;</paramtype></parameter></constructor>
1722 <copy-assignment><type><classname>variant</classname> &amp;</type><template>
1723           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1724         </template><parameter name="u"><paramtype>const <classname>variant</classname>&lt; Us... &gt; &amp;</paramtype></parameter></copy-assignment>
1725 </class><class name="variant"><template>
1726     </template></class><function name="visit"><type>decltype(auto)</type><template>
1727           <template-type-parameter name="Visitor"/>
1728           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1729         </template><parameter name="vis"><paramtype>Visitor &amp;&amp;</paramtype></parameter><parameter name="var"><paramtype><classname>variant</classname>&lt; Us... &gt; &amp;</paramtype></parameter><purpose>Apply visitor to variant (reference). </purpose></function>
1730 <function name="visit"><type>decltype(auto)</type><template>
1731           <template-type-parameter name="Visitor"/>
1732           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1733         </template><parameter name="vis"><paramtype>Visitor &amp;&amp;</paramtype></parameter><parameter name="var"><paramtype><classname>variant</classname>&lt; Us... &gt; &amp;&amp;</paramtype></parameter><purpose>Apply visitor to variant (movable reference). </purpose></function>
1734 <function name="visit"><type>decltype(auto)</type><template>
1735           <template-type-parameter name="Visitor"/>
1736           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1737         </template><parameter name="vis"><paramtype>Visitor &amp;&amp;</paramtype></parameter><parameter name="var"><paramtype>const <classname>variant</classname>&lt; Us... &gt; &amp;</paramtype></parameter><purpose>Apply visitor to variant (const reference). </purpose></function>
1738 <function name="get_if"><type>auto</type><template>
1739           <template-type-parameter name="T"/>
1740           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1741         </template><parameter name="v"><paramtype><classname>variant</classname>&lt; Us... &gt; *</paramtype></parameter><purpose>Returns pointer to T in variant or null pointer if type does not match. </purpose></function>
1742 <function name="get_if"><type>auto</type><template>
1743           <template-type-parameter name="T"/>
1744           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1745         </template><parameter name="v"><paramtype>const <classname>variant</classname>&lt; Us... &gt; *</paramtype></parameter><purpose>Returns pointer to const T in variant or null pointer if type does not match. </purpose></function>
1746 <function name="get"><type>decltype(auto)</type><template>
1747           <template-type-parameter name="T"/>
1748           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1749         </template><parameter name="v"><paramtype><classname>variant</classname>&lt; Us... &gt; &amp;</paramtype></parameter><purpose>Return reference to T, throws std::runtime_error if type does not match. </purpose></function>
1750 <function name="get"><type>decltype(auto)</type><template>
1751           <template-type-parameter name="T"/>
1752           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1753         </template><parameter name="v"><paramtype><classname>variant</classname>&lt; Us... &gt; &amp;&amp;</paramtype></parameter><purpose>Return movable reference to T, throws unspecified exception if type does not match. </purpose></function>
1754 <function name="get"><type>decltype(auto)</type><template>
1755           <template-type-parameter name="T"/>
1756           <template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
1757         </template><parameter name="v"><paramtype>const <classname>variant</classname>&lt; Us... &gt; &amp;</paramtype></parameter><purpose>Return const reference to T, throws unspecified exception if type does not match. </purpose></function>
1758 <function name="visit"><type>decltype(auto)</type><template>
1759           <template-type-parameter name="Visitor"/>
1760           <template-type-parameter name="T"/>
1761         </template><parameter name="vis"><paramtype>Visitor &amp;&amp;</paramtype></parameter><parameter name="var"><paramtype>T &amp;&amp;</paramtype></parameter></function>
1762 <function name="get"><type>decltype(auto)</type><template>
1763           <template-type-parameter name="T"/>
1764           <template-type-parameter name="U"/>
1765         </template><parameter name="u"><paramtype>U &amp;&amp;</paramtype></parameter></function>
1766 <function name="get_if"><type>auto</type><template>
1767           <template-type-parameter name="T"/>
1768           <template-type-parameter name="U"/>
1769         </template><parameter name="u"><paramtype>U *</paramtype></parameter></function>
1770 <function name="get_if"><type>auto</type><template>
1771           <template-type-parameter name="T"/>
1772           <template-type-parameter name="U"/>
1773         </template><parameter name="u"><paramtype>const U *</paramtype></parameter></function>
1774
1775 </namespace>
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801 </namespace>
1802 </namespace>
1803 </header>
1804 <header name="boost/histogram/fwd.hpp">
1805 <para>Forward declarations, tag types and type aliases. </para><namespace name="boost">
1806 <namespace name="histogram">
1807 <namespace name="axis">
1808 <struct name="null_type"><purpose>Empty metadata type. </purpose><method-group name="public member functions">
1809 <method name="serialize"><type>void</type><template>
1810           <template-type-parameter name="Archive"/>
1811         </template><parameter name=""><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
1812 </method-group>
1813 </struct><typedef name="index_type"><purpose>Integral type for axis indices. </purpose><type>int</type></typedef>
1814 <typedef name="real_index_type"><purpose>Real type for axis indices. </purpose><type>double</type></typedef>
1815 <typedef name="empty_type"><purpose>Another alias for an empty metadata type. </purpose><type><classname>null_type</classname></type></typedef>
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829 </namespace>
1830 <typedef name="dense_storage"><purpose>Vector-like storage for fast zero-overhead access to cells. </purpose><type><classname>storage_adaptor</classname>&lt; std::vector&lt; T, A &gt; &gt;</type></typedef>
1831 <typedef name="default_storage"><purpose>Default storage, optimized for unweighted histograms. </purpose><type><classname>unlimited_storage</classname>&lt;&gt;</type></typedef>
1832 <typedef name="weight_storage"><purpose>Dense storage which tracks sums of weights and a variance estimate. </purpose><type>dense_storage&lt; <classname>accumulators::weighted_sum</classname>&lt;&gt; &gt;</type></typedef>
1833 <typedef name="profile_storage"><purpose>Dense storage which tracks means of samples in each cell. </purpose><type>dense_storage&lt; <classname>accumulators::mean</classname>&lt;&gt; &gt;</type></typedef>
1834 <typedef name="weighted_profile_storage"><purpose>Dense storage which tracks means of weighted samples in each cell. </purpose><type>dense_storage&lt; <classname>accumulators::weighted_mean</classname>&lt;&gt; &gt;</type></typedef>
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860 </namespace>
1861 </namespace>
1862 </header>
1863 <header name="boost/histogram/indexed.hpp">
1864 <namespace name="boost">
1865 <namespace name="histogram">
1866 <class name="indexed_range"><template>
1867       <template-type-parameter name="Histogram"/>
1868     </template><purpose>Input iterator range over histogram bins with multi-dimensional index. </purpose><description><para>The iterator returned by begin() can only be incremented. begin() may only be called once, calling it a second time returns the end() iterator. If several copies of the input iterators exist, the other copies become invalid if one of them is incremented. </para></description><class name="accessor"><purpose>Lightweight view to access value and index of current cell. </purpose><description><para>The methods provide access to the current cell indices and bins. It acts like a pointer to the cell value, and in a limited way also like a reference. To interoperate with the algorithms of the standard library, the accessor is implicitly convertible to a cell value. Assignments and comparisons are passed through to the cell. An accessor is coupled to its parent <classname alt="boost::histogram::indexed_range::iterator">indexed_range::iterator</classname>. Moving the parent iterator forward also updates the linked accessor. Accessors are not copyable. They cannot be stored in containers, but <classname alt="boost::histogram::indexed_range::iterator">indexed_range::iterator</classname> can be stored. </para></description><class name="index_view"><purpose>Array-like view into the current multi-dimensional index. </purpose><class name="const_iterator"><purpose>implementation detail </purpose><method-group name="public member functions">
1869 <method name="operator *" cv="const noexcept"><type>const_reference</type></method>
1870 </method-group>
1871 <method-group name="private member functions">
1872 </method-group>
1873 <constructor specifiers="explicit" cv="noexcept"><parameter name="i"><paramtype>index_pointer</paramtype></parameter></constructor>
1874 </class><typedef name="const_reference"><type>const axis::index_type &amp;</type></typedef>
1875 <typedef name="reference"><purpose>deprecated </purpose><type>const_reference</type></typedef>
1876 <method-group name="public member functions">
1877 <method name="begin" cv="const noexcept"><type><classname>const_iterator</classname></type></method>
1878 <method name="end" cv="const noexcept"><type><classname>const_iterator</classname></type></method>
1879 <method name="size" cv="const noexcept"><type>std::size_t</type></method>
1880 <method name="operator[]" cv="const noexcept"><type>const_reference</type><parameter name="d"><paramtype>unsigned</paramtype></parameter></method>
1881 <method name="at" cv="const"><type>const_reference</type><parameter name="d"><paramtype>unsigned</paramtype></parameter></method>
1882 </method-group>
1883 <method-group name="private member functions">
1884 </method-group>
1885 <constructor><parameter name="b"><paramtype>index_pointer</paramtype></parameter><parameter name="e"><paramtype>index_pointer</paramtype></parameter><purpose>implementation detail </purpose></constructor>
1886 </class><method-group name="public member functions">
1887 <method name="get" cv="const noexcept"><type>value_reference</type><purpose>Returns the cell reference. </purpose></method>
1888 <method name="operator *" cv="const noexcept"><type>value_reference</type><purpose>Returns the cell reference. </purpose></method>
1889 <method name="operator-&gt;" cv="const noexcept"><type>value_iterator</type><purpose>Access fields and methods of the cell object. </purpose></method>
1890 <method name="index" cv="const noexcept"><type>axis::index_type</type><parameter name="d"><paramtype>unsigned</paramtype><default>0</default><description><para>axis dimension. </para></description></parameter><purpose>Access current index. </purpose><description><para>
1891 </para></description></method>
1892 <method name="indices" cv="const noexcept"><type><classname>index_view</classname></type><purpose>Access indices as an iterable range. </purpose></method>
1893 <method name="bin" cv="const"><type>decltype(auto)</type><template>
1894           <template-nontype-parameter name="N"><type>unsigned</type><default>0</default><purpose><para>axis dimension. </para></purpose></template-nontype-parameter>
1895         </template><parameter name=""><paramtype>std::integral_constant&lt; unsigned, N &gt;</paramtype><default>{}</default></parameter><purpose>Access current bin. </purpose><description><para>
1896 </para></description></method>
1897 <method name="bin" cv="const"><type>decltype(auto)</type><parameter name="d"><paramtype>unsigned</paramtype><description><para>axis dimension. </para></description></parameter><purpose>Access current bin. </purpose><description><para>
1898 </para></description></method>
1899 <method name="density" cv="const"><type>double</type><purpose>Computes density in current cell. </purpose><description><para>The density is computed as the cell value divided by the product of bin widths. Axes without bin widths, like <classname alt="boost::histogram::axis::category">axis::category</classname>, are treated as having unit bin with. </para></description></method>
1900 <method name="operator&lt;" cv="noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>accessor</classname> &amp;</paramtype></parameter></method>
1901 <method name="operator&gt;" cv="noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>accessor</classname> &amp;</paramtype></parameter></method>
1902 <method name="operator==" cv="noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>accessor</classname> &amp;</paramtype></parameter></method>
1903 <method name="operator!=" cv="noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>accessor</classname> &amp;</paramtype></parameter></method>
1904 <method name="operator&lt;=" cv="noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>accessor</classname> &amp;</paramtype></parameter></method>
1905 <method name="operator&gt;=" cv="noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>accessor</classname> &amp;</paramtype></parameter></method>
1906 <method name="operator&lt;" cv="const noexcept"><type>bool</type><template>
1907           <template-type-parameter name="U"/>
1908         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
1909 <method name="operator&gt;" cv="const noexcept"><type>bool</type><template>
1910           <template-type-parameter name="U"/>
1911         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
1912 <method name="operator==" cv="const noexcept"><type>bool</type><template>
1913           <template-type-parameter name="U"/>
1914         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
1915 <method name="operator!=" cv="const noexcept"><type>bool</type><template>
1916           <template-type-parameter name="U"/>
1917         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
1918 <method name="operator&lt;=" cv="const noexcept"><type>bool</type><template>
1919           <template-type-parameter name="U"/>
1920         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
1921 <method name="operator&gt;=" cv="const noexcept"><type>bool</type><template>
1922           <template-type-parameter name="U"/>
1923         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
1924 <method name="conversion-operator" cv="const noexcept"><type>value_type</type></method>
1925 </method-group>
1926 <copy-assignment><type><classname>accessor</classname> &amp;</type><parameter name="o"><paramtype>const <classname>accessor</classname> &amp;</paramtype></parameter></copy-assignment>
1927 <copy-assignment><type><classname>accessor</classname> &amp;</type><template>
1928           <template-type-parameter name="T"/>
1929         </template><parameter name="x"><paramtype>const T &amp;</paramtype></parameter></copy-assignment>
1930 <method-group name="private member functions">
1931 </method-group>
1932 <constructor cv="noexcept"><parameter name="i"><paramtype><classname>iterator</classname> &amp;</paramtype></parameter></constructor>
1933 <constructor cv="= default"><parameter name=""><paramtype>const <classname>accessor</classname> &amp;</paramtype></parameter></constructor>
1934 </class><class name="iterator"><purpose>implementation detail </purpose><struct name="index_data"><data-member name="idx"><type>axis::index_type</type></data-member>
1935 <data-member name="begin"><type>axis::index_type</type></data-member>
1936 <data-member name="end"><type>axis::index_type</type></data-member>
1937 <data-member name="extent"><type>axis::index_type</type></data-member>
1938 </struct><struct name="indices_t"><inherit access="public">std::array&lt; index_data, buffer_size &gt;</inherit><typedef name="base_type"><type>std::array&lt; index_data, buffer_size &gt;</type></typedef>
1939 <data-member name="hist_"><type>histogram_type *</type></data-member>
1940 <method-group name="public member functions">
1941 <method name="end" cv="noexcept"><type>constexpr auto</type></method>
1942 <method name="end" cv="const noexcept"><type>constexpr auto</type></method>
1943 </method-group>
1944 <constructor cv="noexcept"><parameter name="h"><paramtype>histogram_type *</paramtype></parameter></constructor>
1945 </struct><struct name="pointer_proxy"><data-member name="ref_"><type><classname>reference</classname></type></data-member>
1946 <method-group name="public member functions">
1947 <method name="operator-&gt;" cv="noexcept"><type><classname>reference</classname> *</type></method>
1948 </method-group>
1949 </struct><typedef name="value_type"><type>typename indexed_range::value_type</type></typedef>
1950 <typedef name="reference"><type><classname>accessor</classname></type></typedef>
1951 <typedef name="pointer"><type>pointer_proxy</type></typedef>
1952 <typedef name="difference_type"><type>std::ptrdiff_t</type></typedef>
1953 <typedef name="iterator_category"><type>std::forward_iterator_tag</type></typedef>
1954 <method-group name="public member functions">
1955 <method name="operator *" cv="noexcept"><type><classname>reference</classname></type></method>
1956 <method name="operator-&gt;" cv="noexcept"><type>pointer</type></method>
1957 <method name="operator++"><type><classname>iterator</classname> &amp;</type></method>
1958 <method name="operator++"><type><classname>iterator</classname></type><parameter name=""><paramtype>int</paramtype></parameter></method>
1959 <method name="operator==" cv="const noexcept"><type>bool</type><parameter name="x"><paramtype>const <classname>iterator</classname> &amp;</paramtype></parameter></method>
1960 <method name="operator!=" cv="const noexcept"><type>bool</type><parameter name="x"><paramtype>const <classname>iterator</classname> &amp;</paramtype></parameter></method>
1961 </method-group>
1962 <method-group name="private member functions">
1963 </method-group>
1964 <constructor><parameter name="h"><paramtype>histogram_type *</paramtype></parameter></constructor>
1965 </class><typedef name="value_iterator"><type>std::conditional_t&lt; std::is_const&lt; histogram_type &gt;::value, typename histogram_type::const_iterator, typename histogram_type::iterator &gt;</type></typedef>
1966 <typedef name="value_reference"><type>typename std::iterator_traits&lt; value_iterator &gt;::reference</type></typedef>
1967 <typedef name="value_type"><type>typename std::iterator_traits&lt; value_iterator &gt;::value_type</type></typedef>
1968 <typedef name="range_iterator"><purpose>deprecated </purpose><type><classname>iterator</classname></type></typedef>
1969 <method-group name="public member functions">
1970 <method name="begin" cv="noexcept"><type><classname>iterator</classname></type></method>
1971 <method name="end" cv="noexcept"><type><classname>iterator</classname></type></method>
1972 </method-group>
1973 <constructor><parameter name="hist"><paramtype>histogram_type &amp;</paramtype></parameter><parameter name="cov"><paramtype>coverage</paramtype></parameter></constructor>
1974 </class><enum name="coverage"><enumvalue name="inner"><description><para>iterate over inner bins, exclude underflow and overflow </para></description></enumvalue><enumvalue name="all"><description><para>iterate over all bins, including underflow and overflow </para></description></enumvalue><purpose>Coverage mode of the indexed range generator. </purpose><description><para>Defines options for the iteration strategy. </para></description></enum>
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992 <function name="indexed"><type>auto</type><template>
1993           <template-type-parameter name="Histogram"/>
1994         </template><parameter name="hist"><paramtype>Histogram &amp;&amp;</paramtype><description><para>Reference to the histogram. </para></description></parameter><parameter name="cov"><paramtype>coverage</paramtype><default>coverage::inner</default><description><para>Iterate over all or only inner bins (optional, default: inner). </para></description></parameter><purpose>Generates an indexed range of <ulink url="https://en.cppreference.com/w/cpp/named_req/ForwardIterator">forward iterators</ulink> over the histogram cells. </purpose><description><para>Use this in a range-based for loop:</para><para><programlisting language="c++">for (auto&amp;&amp; x : indexed(hist)) { ... }
1995 </programlisting></para><para>This generates an optimized loop which is nearly always faster than a hand-written loop over the histogram cells. The iterators dereference to an <classname alt="boost::histogram::indexed_range::accessor">indexed_range::accessor</classname>, which has methods to query the current indices and bins and acts like a pointer to the cell value. The returned iterators are forward iterators. They can be stored in a container, but may not be used after the life-time of the histogram ends.</para><para>
1996
1997 </para></description><returns><para><classname alt="boost::histogram::indexed_range">indexed_range</classname></para>
1998 </returns></function>
1999
2000
2001
2002
2003
2004
2005
2006 </namespace>
2007 </namespace>
2008 </header>
2009 <header name="boost/histogram/literals.hpp">
2010 <namespace name="boost">
2011 <namespace name="histogram">
2012 <namespace name="literals">
2013 <function name="operator&quot;&quot;_c"><type>auto</type><template>
2014           <template-nontype-parameter name="digits"><type>char...</type></template-nontype-parameter>
2015         </template><purpose>Suffix operator to generate literal compile-time numbers, 0_c, 12_c, etc. </purpose></function>
2016 </namespace>
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042 </namespace>
2043 </namespace>
2044 </header>
2045 <header name="boost/histogram/make_histogram.hpp">
2046 <para>Collection of factory functions to conveniently create histograms. </para><namespace name="boost">
2047 <namespace name="histogram">
2048
2049
2050
2051
2052
2053
2054
2055
2056 <function name="make_histogram_with"><type>auto</type><template>
2057           <template-type-parameter name="Storage"/>
2058           <template-type-parameter name="Axis"/>
2059           <template-nontype-parameter name="Axes"><type>class...</type></template-nontype-parameter>
2060           <template-type-parameter name=""><default>detail::requires_storage_or_adaptible&lt;Storage&gt;</default></template-type-parameter>
2061           <template-type-parameter name=""><default>detail::requires_axis&lt;Axis&gt;</default></template-type-parameter>
2062         </template><parameter name="storage"><paramtype>Storage &amp;&amp;</paramtype><description><para>Storage or container with standard interface (any vector, array, or map). </para></description></parameter><parameter name="axis"><paramtype>Axis &amp;&amp;</paramtype><description><para>First axis instance. </para></description></parameter><parameter name="axes"><paramtype>Axes &amp;&amp;...</paramtype><description><para>Other axis instances. </para></description></parameter><purpose>Make histogram from compile-time axis configuration and custom storage. </purpose><description><para>
2063 </para></description></function>
2064 <function name="make_histogram"><type>auto</type><template>
2065           <template-type-parameter name="Axis"/>
2066           <template-nontype-parameter name="Axes"><type>class...</type></template-nontype-parameter>
2067           <template-type-parameter name=""><default>detail::requires_axis&lt;Axis&gt;</default></template-type-parameter>
2068         </template><parameter name="axis"><paramtype>Axis &amp;&amp;</paramtype><description><para>First axis instance. </para></description></parameter><parameter name="axes"><paramtype>Axes &amp;&amp;...</paramtype><description><para>Other axis instances. </para></description></parameter><purpose>Make histogram from compile-time axis configuration and default storage. </purpose><description><para>
2069 </para></description></function>
2070 <function name="make_weighted_histogram"><type>auto</type><template>
2071           <template-type-parameter name="Axis"/>
2072           <template-nontype-parameter name="Axes"><type>class...</type></template-nontype-parameter>
2073           <template-type-parameter name=""><default>detail::requires_axis&lt;Axis&gt;</default></template-type-parameter>
2074         </template><parameter name="axis"><paramtype>Axis &amp;&amp;</paramtype><description><para>First axis instance. </para></description></parameter><parameter name="axes"><paramtype>Axes &amp;&amp;...</paramtype><description><para>Other axis instances. </para></description></parameter><purpose>Make histogram from compile-time axis configuration and weight-counting storage. </purpose><description><para>
2075 </para></description></function>
2076 <function name="make_histogram_with"><type>auto</type><template>
2077           <template-type-parameter name="Storage"/>
2078           <template-type-parameter name="Iterable"/>
2079           <template-type-parameter name=""><default>detail::requires_storage_or_adaptible&lt;Storage&gt;</default></template-type-parameter>
2080           <template-type-parameter name=""><default>detail::requires_sequence_of_any_axis&lt;Iterable&gt;</default></template-type-parameter>
2081         </template><parameter name="storage"><paramtype>Storage &amp;&amp;</paramtype><description><para>Storage or container with standard interface (any vector, array, or map). </para></description></parameter><parameter name="iterable"><paramtype>Iterable &amp;&amp;</paramtype><description><para>Iterable range of axis objects. </para></description></parameter><purpose>Make histogram from iterable range and custom storage. </purpose><description><para>
2082 </para></description></function>
2083 <function name="make_histogram"><type>auto</type><template>
2084           <template-type-parameter name="Iterable"/>
2085           <template-type-parameter name=""><default>detail::requires_sequence_of_any_axis&lt;Iterable&gt;</default></template-type-parameter>
2086         </template><parameter name="iterable"><paramtype>Iterable &amp;&amp;</paramtype><description><para>Iterable range of axis objects. </para></description></parameter><purpose>Make histogram from iterable range and default storage. </purpose><description><para>
2087 </para></description></function>
2088 <function name="make_weighted_histogram"><type>auto</type><template>
2089           <template-type-parameter name="Iterable"/>
2090           <template-type-parameter name=""><default>detail::requires_sequence_of_any_axis&lt;Iterable&gt;</default></template-type-parameter>
2091         </template><parameter name="iterable"><paramtype>Iterable &amp;&amp;</paramtype><description><para>Iterable range of axis objects. </para></description></parameter><purpose>Make histogram from iterable range and weight-counting storage. </purpose><description><para>
2092 </para></description></function>
2093 <function name="make_histogram_with"><type>auto</type><template>
2094           <template-type-parameter name="Storage"/>
2095           <template-type-parameter name="Iterator"/>
2096           <template-type-parameter name=""><default>detail::requires_storage_or_adaptible&lt;Storage&gt;</default></template-type-parameter>
2097           <template-type-parameter name=""><default>detail::requires_iterator&lt;Iterator&gt;</default></template-type-parameter>
2098         </template><parameter name="storage"><paramtype>Storage &amp;&amp;</paramtype><description><para>Storage or container with standard interface (any vector, array, or map). </para></description></parameter><parameter name="begin"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><parameter name="end"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><purpose>Make histogram from iterator interval and custom storage. </purpose><description><para>
2099 </para></description></function>
2100 <function name="make_histogram"><type>auto</type><template>
2101           <template-type-parameter name="Iterator"/>
2102           <template-type-parameter name=""><default>detail::requires_iterator&lt;Iterator&gt;</default></template-type-parameter>
2103         </template><parameter name="begin"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><parameter name="end"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><purpose>Make histogram from iterator interval and default storage. </purpose><description><para>
2104 </para></description></function>
2105 <function name="make_weighted_histogram"><type>auto</type><template>
2106           <template-type-parameter name="Iterator"/>
2107           <template-type-parameter name=""><default>detail::requires_iterator&lt;Iterator&gt;</default></template-type-parameter>
2108         </template><parameter name="begin"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><parameter name="end"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><purpose>Make histogram from iterator interval and weight-counting storage. </purpose><description><para>
2109 </para></description></function>
2110
2111
2112
2113
2114
2115
2116
2117
2118 </namespace>
2119 </namespace>
2120 </header>
2121 <header name="boost/histogram/make_profile.hpp">
2122 <para>Collection of factory functions to conveniently create profiles. </para><para>Profiles are histograms which accept an additional sample and compute the mean of the sample in each cell. </para><namespace name="boost">
2123 <namespace name="histogram">
2124
2125
2126 <function name="make_profile"><type>auto</type><template>
2127           <template-type-parameter name="Axis"/>
2128           <template-nontype-parameter name="Axes"><type>typename...</type></template-nontype-parameter>
2129           <template-type-parameter name=""><default>detail::requires_axis&lt;Axis&gt;</default></template-type-parameter>
2130         </template><parameter name="axis"><paramtype>Axis &amp;&amp;</paramtype><description><para>First axis instance. </para></description></parameter><parameter name="axes"><paramtype>Axes &amp;&amp;...</paramtype><description><para>Other axis instances. </para></description></parameter><purpose>Make profle from compile-time axis configuration. </purpose><description><para>
2131 </para></description></function>
2132 <function name="make_weighted_profile"><type>auto</type><template>
2133           <template-type-parameter name="Axis"/>
2134           <template-nontype-parameter name="Axes"><type>typename...</type></template-nontype-parameter>
2135           <template-type-parameter name=""><default>detail::requires_axis&lt;Axis&gt;</default></template-type-parameter>
2136         </template><parameter name="axis"><paramtype>Axis &amp;&amp;</paramtype><description><para>First axis instance. </para></description></parameter><parameter name="axes"><paramtype>Axes &amp;&amp;...</paramtype><description><para>Other axis instances. </para></description></parameter><purpose>Make profle from compile-time axis configuration which accepts weights. </purpose><description><para>
2137 </para></description></function>
2138 <function name="make_profile"><type>auto</type><template>
2139           <template-type-parameter name="Iterable"/>
2140           <template-type-parameter name=""><default>detail::requires_sequence_of_any_axis&lt;Iterable&gt;</default></template-type-parameter>
2141         </template><parameter name="iterable"><paramtype>Iterable &amp;&amp;</paramtype><description><para>Iterable range of axis objects. </para></description></parameter><purpose>Make profile from iterable range. </purpose><description><para>
2142 </para></description></function>
2143 <function name="make_weighted_profile"><type>auto</type><template>
2144           <template-type-parameter name="Iterable"/>
2145           <template-type-parameter name=""><default>detail::requires_sequence_of_any_axis&lt;Iterable&gt;</default></template-type-parameter>
2146         </template><parameter name="iterable"><paramtype>Iterable &amp;&amp;</paramtype><description><para>Iterable range of axis objects. </para></description></parameter><purpose>Make profile from iterable range which accepts weights. </purpose><description><para>
2147 </para></description></function>
2148 <function name="make_profile"><type>auto</type><template>
2149           <template-type-parameter name="Iterator"/>
2150           <template-type-parameter name=""><default>detail::requires_iterator&lt;Iterator&gt;</default></template-type-parameter>
2151         </template><parameter name="begin"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><parameter name="end"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><purpose>Make profile from iterator interval. </purpose><description><para>
2152 </para></description></function>
2153 <function name="make_weighted_profile"><type>auto</type><template>
2154           <template-type-parameter name="Iterator"/>
2155           <template-type-parameter name=""><default>detail::requires_iterator&lt;Iterator&gt;</default></template-type-parameter>
2156         </template><parameter name="begin"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><parameter name="end"><paramtype>Iterator</paramtype><description><para>Iterator to range of axis objects. </para></description></parameter><purpose>Make profile from iterator interval which accepts weights. </purpose><description><para>
2157 </para></description></function>
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175 </namespace>
2176 </namespace>
2177 </header>
2178 <header name="boost/histogram/ostream.hpp">
2179 <para>A simple streaming operator for the histogram type. </para><para>The text representation is rudimentary and not guaranteed to be stable between versions of Boost.Histogram. This header is not included by any other header and must be explicitly included to use the streaming operator.</para><para>To you use your own, simply include your own implementation instead of this header. </para></header>
2180 <header name="boost/histogram/accumulators/ostream.hpp">
2181 <para>Simple streaming operators for the builtin accumulator types. </para><para>The text representation is not guaranteed to be stable between versions of Boost.Histogram. This header is only included by <ulink url="histogram/reference.html#header.boost.histogram.ostream_hpp">boost/histogram/ostream.hpp</ulink>. To you use your own, include your own implementation instead of this header and do not include <ulink url="histogram/reference.html#header.boost.histogram.ostream_hpp">boost/histogram/ostream.hpp</ulink>. </para></header>
2182 <header name="boost/histogram/axis/ostream.hpp">
2183 <para>Simple streaming operators for the builtin axis types. </para><para>The text representation is not guaranteed to be stable between versions of Boost.Histogram. This header is only included by <ulink url="histogram/reference.html#header.boost.histogram.ostream_hpp">boost/histogram/ostream.hpp</ulink>. To you use your own, include your own implementation instead of this header and do not include <ulink url="histogram/reference.html#header.boost.histogram.ostream_hpp">boost/histogram/ostream.hpp</ulink>. </para></header>
2184 <header name="boost/histogram/sample.hpp">
2185 <namespace name="boost">
2186 <namespace name="histogram">
2187 <struct name="sample_type"><template>
2188       <template-type-parameter name="T"/>
2189     </template><data-member name="value"><type>T</type></data-member>
2190 </struct>
2191 <function name="sample"><type>auto</type><template>
2192           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
2193         </template><parameter name="ts"><paramtype>Ts &amp;&amp;...</paramtype><description><para>arguments to be forwarded to the accumulator. </para></description></parameter><purpose>Helper function to mark arguments as sample. </purpose><description><para>
2194 </para></description></function>
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218 </namespace>
2219 </namespace>
2220 </header>
2221 <header name="boost/histogram/serialization.hpp">
2222 <para>Headers from <ulink url="https://www.boost.org/doc/libs/develop/libs/serialization/doc/index.html">Boost.Serialization</ulink> needed to serialize STL types that are used internally by the Boost.Histogram classes. </para></header>
2223 <header name="boost/histogram/storage_adaptor.hpp">
2224 <namespace name="boost">
2225 <namespace name="histogram">
2226 <class name="storage_adaptor"><template>
2227       <template-type-parameter name="T"/>
2228     </template><purpose>Turns any vector-like, array-like, and map-like container into a storage type. </purpose><method-group name="public member functions">
2229 <method name="operator==" cv="const"><type>bool</type><template>
2230           <template-type-parameter name="U"/>
2231           <template-type-parameter name=""><default>detail::requires_iterable&lt;U&gt;</default></template-type-parameter>
2232         </template><parameter name="u"><paramtype>const U &amp;</paramtype></parameter></method>
2233 <method name="serialize"><type>void</type><template>
2234           <template-type-parameter name="Archive"/>
2235         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
2236 </method-group>
2237 <constructor cv="= default"><parameter name=""><paramtype><classname>storage_adaptor</classname> &amp;&amp;</paramtype></parameter></constructor>
2238 <constructor cv="= default"><parameter name=""><paramtype>const <classname>storage_adaptor</classname> &amp;</paramtype></parameter></constructor>
2239 <copy-assignment cv="= default"><type><classname>storage_adaptor</classname> &amp;</type><parameter name=""><paramtype><classname>storage_adaptor</classname> &amp;&amp;</paramtype></parameter></copy-assignment>
2240 <copy-assignment cv="= default"><type><classname>storage_adaptor</classname> &amp;</type><parameter name=""><paramtype>const <classname>storage_adaptor</classname> &amp;</paramtype></parameter></copy-assignment>
2241 <constructor><template>
2242           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
2243         </template><parameter name="ts"><paramtype>Ts &amp;&amp;...</paramtype></parameter></constructor>
2244 <copy-assignment><type><classname>storage_adaptor</classname> &amp;</type><template>
2245           <template-type-parameter name="U"/>
2246         </template><parameter name="u"><paramtype>U &amp;&amp;</paramtype></parameter></copy-assignment>
2247 </class>
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272 </namespace>
2273 </namespace>
2274 </header>
2275 <header name="boost/histogram/unlimited_storage.hpp">
2276 <namespace name="boost">
2277 <namespace name="histogram">
2278 <class name="unlimited_storage"><template>
2279       <template-type-parameter name="Allocator"/>
2280     </template><purpose>Memory-efficient storage for integral counters which cannot overflow. </purpose><description><para>This storage provides a no-overflow-guarantee if the counters are incremented with integer weights. It maintains a contiguous array of elemental counters, one for each cell. If an operation is requested which would overflow a counter, the array is replaced with another of a wider integral type, then the operation is executed. The storage uses integers of 8, 16, 32, 64 bits, and then switches to a multiprecision integral type, similar to those in <ulink url="https://www.boost.org/doc/libs/develop/libs/multiprecision/doc/html/index.html">Boost.Multiprecision</ulink>.</para><para>A scaling operation or adding a floating point number triggers a conversion of the elemental counters into doubles, which voids the no-overflow-guarantee. </para></description><struct name="adder"><method-group name="public member functions">
2281 <method name="operator()"><type>void</type><template>
2282           <template-type-parameter name="U"/>
2283         </template><parameter name="tp"><paramtype>double *</paramtype></parameter><parameter name=""><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2284 <method name="operator()"><type>void</type><parameter name="tp"><paramtype>large_int *</paramtype></parameter><parameter name=""><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const large_int &amp;</paramtype></parameter></method>
2285 <method name="operator()"><type>void</type><template>
2286           <template-type-parameter name="T"/>
2287           <template-type-parameter name="U"/>
2288         </template><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2289 <method name="is_x_integral"><type>void</type><template>
2290           <template-type-parameter name="T"/>
2291           <template-type-parameter name="U"/>
2292         </template><parameter name=""><paramtype>std::false_type</paramtype></parameter><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2293 <method name="is_x_integral"><type>void</type><template>
2294           <template-type-parameter name="T"/>
2295         </template><parameter name=""><paramtype>std::false_type</paramtype></parameter><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const large_int &amp;</paramtype></parameter></method>
2296 <method name="is_x_integral"><type>void</type><template>
2297           <template-type-parameter name="T"/>
2298           <template-type-parameter name="U"/>
2299         </template><parameter name=""><paramtype>std::true_type</paramtype></parameter><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2300 <method name="is_x_unsigned"><type>void</type><template>
2301           <template-type-parameter name="T"/>
2302           <template-type-parameter name="U"/>
2303         </template><parameter name=""><paramtype>std::false_type</paramtype></parameter><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2304 <method name="is_x_unsigned"><type>void</type><template>
2305           <template-type-parameter name="T"/>
2306           <template-type-parameter name="U"/>
2307         </template><parameter name=""><paramtype>std::true_type</paramtype></parameter><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2308 <method name="is_x_unsigned"><type>void</type><template>
2309           <template-type-parameter name="U"/>
2310         </template><parameter name=""><paramtype>std::true_type</paramtype></parameter><parameter name="tp"><paramtype>large_int *</paramtype></parameter><parameter name=""><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2311 </method-group>
2312 </struct><struct name="buffer_type"><typedef name="types"><type>mp11::mp_list&lt; U8, U16, U32, U64, large_int, double &gt;</type></typedef>
2313 <data-member name="alloc"><type>allocator_type</type></data-member>
2314 <data-member name="size"><type>std::size_t</type></data-member>
2315 <data-member name="type"><type>unsigned</type></data-member>
2316 <data-member name="ptr" specifiers="mutable"><type>void *</type></data-member>
2317 <method-group name="public static functions">
2318 <method name="type_index" cv="noexcept" specifiers="static"><type>constexpr unsigned</type><template>
2319           <template-type-parameter name="T"/>
2320         </template></method>
2321 </method-group>
2322 <method-group name="public member functions">
2323 <method name="visit" cv="const"><type>decltype(auto)</type><template>
2324           <template-type-parameter name="F"/>
2325           <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
2326         </template><parameter name="f"><paramtype>F &amp;&amp;</paramtype></parameter><parameter name="ts"><paramtype>Ts &amp;&amp;...</paramtype></parameter></method>
2327 <method name="destroy" cv="noexcept"><type>void</type></method>
2328 <method name="make"><type>void</type><template>
2329           <template-type-parameter name="T"/>
2330         </template><parameter name="n"><paramtype>std::size_t</paramtype></parameter></method>
2331 <method name="make"><type>void</type><template>
2332           <template-type-parameter name="T"/>
2333           <template-type-parameter name="U"/>
2334         </template><parameter name="n"><paramtype>std::size_t</paramtype></parameter><parameter name="iter"><paramtype>U</paramtype></parameter></method>
2335 </method-group>
2336 <constructor><parameter name="a"><paramtype>const allocator_type &amp;</paramtype><default>{}</default></parameter></constructor>
2337 <constructor cv="noexcept"><parameter name="o"><paramtype>buffer_type &amp;&amp;</paramtype></parameter></constructor>
2338 <copy-assignment cv="noexcept"><type>buffer_type &amp;</type><parameter name="o"><paramtype>buffer_type &amp;&amp;</paramtype></parameter></copy-assignment>
2339 <constructor><parameter name="x"><paramtype>const buffer_type &amp;</paramtype></parameter></constructor>
2340 <copy-assignment><type>buffer_type &amp;</type><parameter name="o"><paramtype>const buffer_type &amp;</paramtype></parameter></copy-assignment>
2341 <destructor/>
2342 </struct><class name="const_reference"><purpose>implementation detail </purpose><method-group name="public member functions">
2343 <method name="conversion-operator" cv="const noexcept"><type>double</type></method>
2344 <method name="operator&lt;" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>const_reference</classname> &amp;</paramtype></parameter></method>
2345 <method name="operator==" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>const_reference</classname> &amp;</paramtype></parameter></method>
2346 <method name="operator&lt;" cv="const noexcept"><type><emphasis>unspecified</emphasis></type><template>
2347           <template-type-parameter name="U"/>
2348         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
2349 <method name="operator&gt;" cv="const noexcept"><type><emphasis>unspecified</emphasis></type><template>
2350           <template-type-parameter name="U"/>
2351         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
2352 <method name="operator==" cv="const noexcept"><type><emphasis>unspecified</emphasis></type><template>
2353           <template-type-parameter name="U"/>
2354         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
2355 </method-group>
2356 <constructor cv="noexcept"><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter></constructor>
2357 <constructor><parameter name=""><paramtype>const <classname>const_reference</classname> &amp;</paramtype></parameter></constructor>
2358 <copy-assignment cv="= delete"><type><classname>const_reference</classname> &amp;</type><parameter name=""><paramtype>const <classname>const_reference</classname> &amp;</paramtype></parameter></copy-assignment>
2359 <copy-assignment cv="= delete"><type><classname>const_reference</classname> &amp;</type><parameter name=""><paramtype><classname>const_reference</classname> &amp;&amp;</paramtype></parameter></copy-assignment>
2360 <method-group name="private member functions">
2361 <method name="apply_binary" cv="const noexcept"><type>bool</type><template>
2362           <template-type-parameter name="Binary"/>
2363         </template><parameter name="x"><paramtype>const <classname>const_reference</classname> &amp;</paramtype></parameter></method>
2364 <method name="apply_binary" cv="const noexcept"><type>bool</type><template>
2365           <template-type-parameter name="Binary"/>
2366           <template-type-parameter name="U"/>
2367         </template><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2368 </method-group>
2369 </class><struct name="incrementor"><method-group name="public member functions">
2370 <method name="operator()"><type>void</type><template>
2371           <template-type-parameter name="T"/>
2372         </template><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter></method>
2373 <method name="operator()"><type>void</type><parameter name="tp"><paramtype>large_int *</paramtype></parameter><parameter name=""><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter></method>
2374 <method name="operator()"><type>void</type><parameter name="tp"><paramtype>double *</paramtype></parameter><parameter name=""><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter></method>
2375 </method-group>
2376 </struct><class name="iterator_impl"><template>
2377       <template-type-parameter name="Value"/>
2378       <template-type-parameter name="Reference"/>
2379     </template><method-group name="public member functions">
2380 <method name="operator *" cv="const noexcept"><type>Reference</type></method>
2381 </method-group>
2382 <constructor cv="= default"/>
2383 <constructor><template>
2384           <template-type-parameter name="V"/>
2385           <template-type-parameter name="R"/>
2386         </template><parameter name="it"><paramtype>const iterator_impl&lt; V, R &gt; &amp;</paramtype></parameter></constructor>
2387 <constructor cv="noexcept"><parameter name="b"><paramtype>buffer_type *</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter></constructor>
2388 </class><struct name="multiplier"><method-group name="public member functions">
2389 <method name="operator()"><type>void</type><template>
2390           <template-type-parameter name="T"/>
2391         </template><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="x"><paramtype>const double</paramtype></parameter></method>
2392 <method name="operator()"><type>void</type><parameter name="tp"><paramtype>double *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="x"><paramtype>const double</paramtype></parameter></method>
2393 <method name="operator()"><type>void</type><template>
2394           <template-type-parameter name="T"/>
2395         </template><parameter name="tp"><paramtype>T *</paramtype></parameter><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const double</paramtype></parameter></method>
2396 <method name="operator()"><type>void</type><parameter name="tp"><paramtype>double *</paramtype></parameter><parameter name=""><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter><parameter name="x"><paramtype>const double</paramtype></parameter></method>
2397 </method-group>
2398 </struct><class name="reference"><inherit access="public">boost::histogram::unlimited_storage&lt; Allocator &gt;::const_reference</inherit><purpose>implementation detail </purpose><method-group name="public member functions">
2399 <method name="operator&lt;" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>reference</classname> &amp;</paramtype></parameter></method>
2400 <method name="operator==" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>reference</classname> &amp;</paramtype></parameter></method>
2401 <method name="operator&lt;" cv="const noexcept"><type><emphasis>unspecified</emphasis></type><template>
2402           <template-type-parameter name="U"/>
2403         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
2404 <method name="operator&gt;" cv="const noexcept"><type><emphasis>unspecified</emphasis></type><template>
2405           <template-type-parameter name="U"/>
2406         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
2407 <method name="operator==" cv="const noexcept"><type><emphasis>unspecified</emphasis></type><template>
2408           <template-type-parameter name="U"/>
2409         </template><parameter name="o"><paramtype>const U &amp;</paramtype></parameter></method>
2410 <method name="operator+="><type><classname>reference</classname> &amp;</type><parameter name="x"><paramtype>const <classname>const_reference</classname> &amp;</paramtype></parameter></method>
2411 <method name="operator+="><type><emphasis>unspecified</emphasis></type><template>
2412           <template-type-parameter name="U"/>
2413         </template><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></method>
2414 <method name="operator-="><type><classname>reference</classname> &amp;</type><parameter name="x"><paramtype>const double</paramtype></parameter></method>
2415 <method name="operator *="><type><classname>reference</classname> &amp;</type><parameter name="x"><paramtype>const double</paramtype></parameter></method>
2416 <method name="operator/="><type><classname>reference</classname> &amp;</type><parameter name="x"><paramtype>const double</paramtype></parameter></method>
2417 <method name="operator++"><type><classname>reference</classname> &amp;</type></method>
2418 </method-group>
2419 <constructor cv="noexcept"><parameter name="b"><paramtype>buffer_type &amp;</paramtype></parameter><parameter name="i"><paramtype>std::size_t</paramtype></parameter></constructor>
2420 <constructor><parameter name="x"><paramtype>const <classname>reference</classname> &amp;</paramtype></parameter></constructor>
2421 <copy-assignment><type><classname>reference</classname> &amp;</type><parameter name="x"><paramtype>const <classname>reference</classname> &amp;</paramtype></parameter></copy-assignment>
2422 <copy-assignment><type><classname>reference</classname> &amp;</type><parameter name="x"><paramtype>const <classname>const_reference</classname> &amp;</paramtype></parameter></copy-assignment>
2423 <copy-assignment><type><emphasis>unspecified</emphasis></type><template>
2424           <template-type-parameter name="U"/>
2425         </template><parameter name="x"><paramtype>const U &amp;</paramtype></parameter></copy-assignment>
2426 </class><typedef name="allocator_type"><type>Allocator</type></typedef>
2427 <typedef name="value_type"><type>double</type></typedef>
2428 <typedef name="large_int"><type><emphasis>unspecified</emphasis></type></typedef>
2429 <typedef name="const_iterator"><type>iterator_impl&lt; const value_type, <classname>const_reference</classname> &gt;</type></typedef>
2430 <typedef name="iterator"><type>iterator_impl&lt; value_type, <classname>reference</classname> &gt;</type></typedef>
2431 <data-member name="has_threading_support" specifiers="static"><type>constexpr bool</type></data-member>
2432 <method-group name="public member functions">
2433 <method name="get_allocator" cv="const"><type>allocator_type</type></method>
2434 <method name="reset"><type>void</type><parameter name="n"><paramtype>std::size_t</paramtype></parameter></method>
2435 <method name="size" cv="const noexcept"><type>std::size_t</type></method>
2436 <method name="operator[]" cv="noexcept"><type><classname>reference</classname></type><parameter name="i"><paramtype>std::size_t</paramtype></parameter></method>
2437 <method name="operator[]" cv="const noexcept"><type><classname>const_reference</classname></type><parameter name="i"><paramtype>std::size_t</paramtype></parameter></method>
2438 <method name="operator==" cv="const noexcept"><type>bool</type><parameter name="x"><paramtype>const <classname>unlimited_storage</classname> &amp;</paramtype></parameter></method>
2439 <method name="operator==" cv="const"><type>bool</type><template>
2440           <template-type-parameter name="Iterable"/>
2441         </template><parameter name="iterable"><paramtype>const Iterable &amp;</paramtype></parameter></method>
2442 <method name="operator *="><type><classname>unlimited_storage</classname> &amp;</type><parameter name="x"><paramtype>const double</paramtype></parameter></method>
2443 <method name="begin" cv="noexcept"><type>iterator</type></method>
2444 <method name="end" cv="noexcept"><type>iterator</type></method>
2445 <method name="begin" cv="const noexcept"><type>const_iterator</type></method>
2446 <method name="end" cv="const noexcept"><type>const_iterator</type></method>
2447 <method name="serialize"><type>void</type><template>
2448           <template-type-parameter name="Archive"/>
2449         </template><parameter name="ar"><paramtype>Archive &amp;</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
2450 </method-group>
2451 <constructor specifiers="explicit"><parameter name="a"><paramtype>const allocator_type &amp;</paramtype><default>{}</default></parameter></constructor>
2452 <constructor cv="= default"><parameter name=""><paramtype>const <classname>unlimited_storage</classname> &amp;</paramtype></parameter></constructor>
2453 <copy-assignment cv="= default"><type><classname>unlimited_storage</classname> &amp;</type><parameter name=""><paramtype>const <classname>unlimited_storage</classname> &amp;</paramtype></parameter></copy-assignment>
2454 <constructor cv="= default"><parameter name=""><paramtype><classname>unlimited_storage</classname> &amp;&amp;</paramtype></parameter></constructor>
2455 <copy-assignment cv="= default"><type><classname>unlimited_storage</classname> &amp;</type><parameter name=""><paramtype><classname>unlimited_storage</classname> &amp;&amp;</paramtype></parameter></copy-assignment>
2456 <constructor specifiers="explicit"><template>
2457           <template-type-parameter name="Iterable"/>
2458           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
2459         </template><parameter name="s"><paramtype>const Iterable &amp;</paramtype></parameter></constructor>
2460 <copy-assignment><type><classname>unlimited_storage</classname> &amp;</type><template>
2461           <template-type-parameter name="Iterable"/>
2462           <template-type-parameter name=""><default>detail::requires_iterable&lt;Iterable&gt;</default></template-type-parameter>
2463         </template><parameter name="s"><paramtype>const Iterable &amp;</paramtype></parameter></copy-assignment>
2464 <constructor><template>
2465           <template-type-parameter name="T"/>
2466         </template><parameter name="s"><paramtype>std::size_t</paramtype></parameter><parameter name="p"><paramtype>const T *</paramtype></parameter><parameter name="a"><paramtype>const allocator_type &amp;</paramtype><default>{}</default></parameter><purpose>implementation detail; used by unit tests, not part of generic storage interface </purpose></constructor>
2467 </class>
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492 </namespace>
2493 </namespace>
2494 </header>
2495 <header name="boost/histogram/unsafe_access.hpp">
2496 <namespace name="boost">
2497 <namespace name="histogram">
2498 <struct name="unsafe_access"><purpose>Unsafe read/write access to private data that potentially breaks consistency. </purpose><description><para>This struct enables access to private data of some classes. It is intended for library developers who need this to implement algorithms efficiently, for example, serialization. Users should not use this. If you are a user who absolutely needs this to get a specific effect, please submit an issue on Github. Perhaps the public interface is insufficient and should be extended for your use case.</para><para>Unlike the normal interface, the <classname alt="boost::histogram::unsafe_access">unsafe_access</classname> interface may change between versions. If your code relies on <classname alt="boost::histogram::unsafe_access">unsafe_access</classname>, it may or may not break when you update Boost. This is another reason to not use it unless you are ok with these conditions. </para></description><method-group name="public static functions">
2499 <method name="axes" specifiers="static"><type>auto &amp;</type><template>
2500           <template-type-parameter name="Histogram"/>
2501         </template><parameter name="hist"><paramtype>Histogram &amp;</paramtype><description><para>histogram. </para></description></parameter><purpose>Get axes. </purpose><description><para>
2502 </para></description></method>
2503 <method name="axes" specifiers="static"><type>const auto &amp;</type><template>
2504           <template-type-parameter name="Histogram"/>
2505         </template><parameter name="hist"><paramtype>const Histogram &amp;</paramtype><description><para>histogram. </para></description></parameter><purpose>Get axes. </purpose><description><para>
2506 </para></description></method>
2507 <method name="axis" specifiers="static"><type>decltype(auto)</type><template>
2508           <template-type-parameter name="Histogram"/>
2509           <template-nontype-parameter name="I"><type>unsigned</type><default>0</default><purpose><para>axis index (optional, default: 0). </para></purpose></template-nontype-parameter>
2510         </template><parameter name="hist"><paramtype>Histogram &amp;</paramtype><description><para>histogram. </para></description></parameter><parameter name=""><paramtype>std::integral_constant&lt; unsigned, I &gt;</paramtype><default>{}</default></parameter><purpose>Get mutable axis reference with compile-time number. </purpose><description><para>
2511
2512 </para></description></method>
2513 <method name="axis" specifiers="static"><type>decltype(auto)</type><template>
2514           <template-type-parameter name="Histogram"/>
2515         </template><parameter name="hist"><paramtype>Histogram &amp;</paramtype><description><para>histogram. </para></description></parameter><parameter name="i"><paramtype>unsigned</paramtype><description><para>axis index. </para></description></parameter><purpose>Get mutable axis reference with run-time number. </purpose><description><para>
2516 </para></description></method>
2517 <method name="storage" specifiers="static"><type>auto &amp;</type><template>
2518           <template-type-parameter name="Histogram"/>
2519         </template><parameter name="hist"><paramtype>Histogram &amp;</paramtype><description><para>histogram. </para></description></parameter><purpose>Get storage. </purpose><description><para>
2520 </para></description></method>
2521 <method name="storage" specifiers="static"><type>const auto &amp;</type><template>
2522           <template-type-parameter name="Histogram"/>
2523         </template><parameter name="hist"><paramtype>const Histogram &amp;</paramtype><description><para>histogram. </para></description></parameter><purpose>Get storage. </purpose><description><para>
2524 </para></description></method>
2525 <method name="offset" specifiers="static"><type>auto &amp;</type><template>
2526           <template-type-parameter name="Histogram"/>
2527         </template><parameter name="hist"><paramtype>Histogram &amp;</paramtype><description><para>histogram </para></description></parameter><purpose>Get index offset. </purpose><description><para>
2528 </para></description></method>
2529 <method name="offset" specifiers="static"><type>const auto &amp;</type><template>
2530           <template-type-parameter name="Histogram"/>
2531         </template><parameter name="hist"><paramtype>const Histogram &amp;</paramtype><description><para>histogram </para></description></parameter><purpose>Get index offset. </purpose><description><para>
2532 </para></description></method>
2533 <method name="unlimited_storage_buffer" specifiers="static"><type>constexpr auto &amp;</type><template>
2534           <template-type-parameter name="Allocator"/>
2535         </template><parameter name="storage"><paramtype><classname>unlimited_storage</classname>&lt; Allocator &gt; &amp;</paramtype><description><para>instance of <classname alt="boost::histogram::unlimited_storage">unlimited_storage</classname>. </para></description></parameter><purpose>Get buffer of <classname alt="boost::histogram::unlimited_storage">unlimited_storage</classname>. </purpose><description><para>
2536 </para></description></method>
2537 <method name="storage_adaptor_impl" specifiers="static"><type>constexpr auto &amp;</type><template>
2538           <template-type-parameter name="T"/>
2539         </template><parameter name="storage"><paramtype><classname>storage_adaptor</classname>&lt; T &gt; &amp;</paramtype><description><para>instance of <classname alt="boost::histogram::storage_adaptor">storage_adaptor</classname>. </para></description></parameter><purpose>Get implementation of <classname alt="boost::histogram::storage_adaptor">storage_adaptor</classname>. </purpose><description><para>
2540 </para></description></method>
2541 </method-group>
2542 </struct>
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567 </namespace>
2568 </namespace>
2569 </header>
2570 <header name="boost/histogram/weight.hpp">
2571 <namespace name="boost">
2572 <namespace name="histogram">
2573 <struct name="weight_type"><template>
2574       <template-type-parameter name="T"/>
2575     </template><purpose>Weight holder and type envelope. </purpose><description><para>You should not construct these directly, use the weight() helper function.</para><para>
2576 </para></description><data-member name="value"><type>T</type><purpose>Access underlying value. </purpose></data-member>
2577 <method-group name="public member functions">
2578 <method name="conversion-operator" cv="const"><type>weight_type&lt; U &gt;</type><template>
2579           <template-type-parameter name="U"/>
2580         </template><purpose>Allow implicit conversions of types when the underlying value type allows them. </purpose></method>
2581 </method-group>
2582 </struct><function name="weight"><type>auto</type><template>
2583           <template-type-parameter name="T"/>
2584         </template><parameter name="t"><paramtype>T &amp;&amp;</paramtype><description><para>argument to be forward to the histogram. </para></description></parameter><purpose>Helper function to mark argument as weight. </purpose><description><para>
2585 </para></description></function>
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610 </namespace>
2611 </namespace>
2612 </header>
2613 </library-reference>