<?xml version="1.0" standalone="yes"?>
<library-reference><header name="boost/histogram.hpp">
-<para>Includes all standard headers of the Boost.
histogram library. </para><para>Extra headers not automatically included are:<itemizedlist>
+<para>Includes all standard headers of the Boost.
Histogram library. </para><para>Extra headers not automatically included are:<itemizedlist>
<listitem><para><ulink url="histogram/reference.html#header.boost.histogram.ostream_hpp">boost/histogram/ostream.hpp</ulink></para>
</listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.axis.ostream_hpp">boost/histogram/axis/ostream.hpp</ulink></para>
</listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.accumulators.ostream_hpp">boost/histogram/accumulators/ostream.hpp</ulink></para>
-</listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.serialization_hpp">boost/histogram/serialization.hpp</ulink> </para>
+</listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.serialization_hpp">boost/histogram/serialization.hpp</ulink></para>
+</listitem><listitem><para><ulink url="histogram/reference.html#header.boost.histogram.display_hpp">boost/histogram/display.hpp</ulink> </para>
</listitem></itemizedlist>
</para></header>
<header name="boost/histogram/histogram.hpp">
<method name="for_each_axis" cv="const"><type>auto</type><template>
<template-type-parameter name="Unary"/>
</template><parameter name="unary"><paramtype>Unary &&</paramtype></parameter><purpose>Apply unary functor/function to each axis. </purpose></method>
+<method name="operator()"><type><emphasis>unspecified</emphasis></type><template>
+ <template-type-parameter name="Arg0"/>
+ <template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
+ </template><parameter name="arg0"><paramtype>const Arg0 &</paramtype></parameter><parameter name="args"><paramtype>const Args &...</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>
<method name="operator()"><type>iterator</type><template>
<template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
- </template><parameter name="ts"><paramtype>const Ts &...</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>
-<method name="operator()"><type>iterator</type><template>
+ </template><parameter name="args"><paramtype>const std::tuple< Ts... > &</paramtype></parameter><purpose>Fill histogram with values, an optional weight, and/or a sample from a <computeroutput>std::tuple</computeroutput>. </purpose></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="args"><paramtype>const Iterable &</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>
+</para></description></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-type-parameter name="T"/>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="args"><paramtype>const Iterable &</paramtype><description><para>iterable of values. </para></description></parameter><parameter name="weights"><paramtype>const <classname>weight_type</classname>< T > &</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>
+</para></description></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-type-parameter name="T"/>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="weights"><paramtype>const <classname>weight_type</classname>< T > &</paramtype><description><para>single weight or an iterable of weights. </para></description></parameter><parameter name="args"><paramtype>const Iterable &</paramtype><description><para>iterable of values. </para></description></parameter><purpose>Fill histogram with several values and weights at once. </purpose><description><para>
+</para></description></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="args"><paramtype>const Iterable &</paramtype><description><para>iterable of values. </para></description></parameter><parameter name="samples"><paramtype>const sample_type< std::tuple< Ts... >> &</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>
+</para></description></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-type-parameter name="T"/>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="samples"><paramtype>const sample_type< T > &</paramtype><description><para>single sample or an iterable of samples. </para></description></parameter><parameter name="args"><paramtype>const Iterable &</paramtype><description><para>iterable of values. </para></description></parameter><purpose>Fill histogram with several values and samples at once. </purpose><description><para>
+</para></description></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-type-parameter name="T"/>
<template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
- </template><parameter name="t"><paramtype>const std::tuple< Ts... > &</paramtype></parameter><purpose>Fill histogram with values, an optional weight, and/or a sample from a <computeroutput>std::tuple</computeroutput>. </purpose></method>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="args"><paramtype>const Iterable &</paramtype></parameter><parameter name="weights"><paramtype>const <classname>weight_type</classname>< T > &</paramtype></parameter><parameter name="samples"><paramtype>const sample_type< std::tuple< Ts... >> &</paramtype></parameter></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-type-parameter name="T"/>
+ <template-type-parameter name="U"/>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="samples"><paramtype>const sample_type< T > &</paramtype></parameter><parameter name="weights"><paramtype>const <classname>weight_type</classname>< U > &</paramtype></parameter><parameter name="args"><paramtype>const Iterable &</paramtype></parameter></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-type-parameter name="T"/>
+ <template-type-parameter name="U"/>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="weights"><paramtype>const <classname>weight_type</classname>< T > &</paramtype></parameter><parameter name="samples"><paramtype>const sample_type< U > &</paramtype></parameter><parameter name="args"><paramtype>const Iterable &</paramtype></parameter></method>
+<method name="fill"><type>void</type><template>
+ <template-type-parameter name="Iterable"/>
+ <template-type-parameter name="T"/>
+ <template-type-parameter name="U"/>
+ <template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
+ </template><parameter name="args"><paramtype>const Iterable &</paramtype></parameter><parameter name="samples"><paramtype>const sample_type< T > &</paramtype></parameter><parameter name="weights"><paramtype>const <classname>weight_type</classname>< U > &</paramtype></parameter></method>
<method name="at"><type>decltype(auto)</type><template>
<template-nontype-parameter name="Indices"><type>class...</type></template-nontype-parameter>
</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>
<template-nontype-parameter name="Indices"><type>class...</type></template-nontype-parameter>
</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>
<method name="at"><type>decltype(auto)</type><template>
- <template-nontype-parameter name="Indices"><type>typename...</type></template-nontype-parameter>
+ <template-nontype-parameter name="Indices"><type>class...</type></template-nontype-parameter>
</template><parameter name="is"><paramtype>const std::tuple< Indices... > &</paramtype></parameter><purpose>Access cell value at integral indices stored in <computeroutput>std::tuple</computeroutput>. </purpose></method>
<method name="at" cv="const"><type>decltype(auto)</type><template>
<template-nontype-parameter name="Indices"><type>typename...</type></template-nontype-parameter>
<template-type-parameter name="A"/>
<template-type-parameter name="S"/>
</template><parameter name="rhs"><paramtype>const <classname>histogram</classname>< A, S > &</paramtype></parameter><purpose>Negation of the equality operator. </purpose></method>
-<method name="operator+="><type><classname>histogram</classname> &</type><template>
+<method name="operator+="><type><emphasis>unspecified</emphasis></type><template>
<template-type-parameter name="A"/>
<template-type-parameter name="S"/>
- <template-type-parameter name=""><default>std::enable_if_t<detail::has_operator_radd< value_type, typename <classname alt="boost::histogram::histogram">histogram</classname><A, S>::value_type>::value></default></template-type-parameter>
</template><parameter name="rhs"><paramtype>const <classname>histogram</classname>< A, S > &</paramtype></parameter><purpose>Add values of another histogram. </purpose></method>
-<method name="operator-="><type><classname>histogram</classname> &</type><template>
+<method name="operator-="><type><emphasis>unspecified</emphasis></type><template>
<template-type-parameter name="A"/>
<template-type-parameter name="S"/>
- <template-type-parameter name=""><default>std::enable_if_t<detail::has_operator_rsub< value_type, typename <classname alt="boost::histogram::histogram">histogram</classname><A, S>::value_type>::value></default></template-type-parameter>
</template><parameter name="rhs"><paramtype>const <classname>histogram</classname>< A, S > &</paramtype></parameter><purpose>Subtract values of another histogram. </purpose></method>
-<method name="operator *="><type><classname>histogram</classname> &</type><template>
+<method name="operator *="><type><emphasis>unspecified</emphasis></type><template>
<template-type-parameter name="A"/>
<template-type-parameter name="S"/>
- <template-type-parameter name=""><default>std::enable_if_t<detail::has_operator_rmul< value_type, typename <classname alt="boost::histogram::histogram">histogram</classname><A, S>::value_type>::value></default></template-type-parameter>
</template><parameter name="rhs"><paramtype>const <classname>histogram</classname>< A, S > &</paramtype></parameter><purpose>Multiply by values of another histogram. </purpose></method>
-<method name="operator/="><type><classname>histogram</classname> &</type><template>
+<method name="operator/="><type><emphasis>unspecified</emphasis></type><template>
<template-type-parameter name="A"/>
<template-type-parameter name="S"/>
- <template-type-parameter name=""><default>std::enable_if_t<detail::has_operator_rdiv< value_type, typename <classname alt="boost::histogram::histogram">histogram</classname><A, S>::value_type>::value></default></template-type-parameter>
</template><parameter name="rhs"><paramtype>const <classname>histogram</classname>< A, S > &</paramtype></parameter><purpose>Divide by values of another histogram. </purpose></method>
-<method name="operator *="><type><classname>histogram</classname> &</type><template>
+<method name="operator *="><type><emphasis>unspecified</emphasis></type><template>
+ <template-type-parameter name="V"><default>value_type</default></template-type-parameter>
+ </template><parameter name="x"><paramtype>const double</paramtype></parameter><purpose>Multiply all values with a scalar. </purpose></method>
+<method name="operator *="><type><emphasis>unspecified</emphasis></type><template>
<template-type-parameter name="V"><default>value_type</default></template-type-parameter>
- <template-type-parameter name=""><default>std::enable_if_t<detail::has_operator_rmul<V, double>::value></default></template-type-parameter>
</template><parameter name="x"><paramtype>const double</paramtype></parameter><purpose>Multiply all values with a scalar. </purpose></method>
-<method name="operator/="><type><classname>histogram</classname> &</type><template>
+<method name="operator/="><type><emphasis>unspecified</emphasis></type><template>
<template-type-parameter name="V"><default>value_type</default></template-type-parameter>
- <template-type-parameter name=""><default>std::enable_if_t<detail::has_operator_rmul<V, double>::value></default></template-type-parameter>
</template><parameter name="x"><paramtype>const double</paramtype></parameter><purpose>Divide all values by a scalar. </purpose></method>
<method name="begin" cv="noexcept"><type>iterator</type><purpose>Return value iterator to the beginning of the histogram. </purpose></method>
<method name="end" cv="noexcept"><type>iterator</type><purpose>Return value iterator to the end in the histogram. </purpose></method>
<method name="end" cv="const noexcept"><type>const_iterator</type><purpose>Return value iterator to the end in the histogram (read-only). </purpose></method>
<method name="cbegin" cv="const noexcept"><type>const_iterator</type><purpose>Return value iterator to the beginning of the histogram (read-only). </purpose></method>
<method name="cend" cv="const noexcept"><type>const_iterator</type><purpose>Return value iterator to the end in the histogram (read-only). </purpose></method>
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name="ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"/>
-<constructor><parameter name="rhs"><paramtype>const <classname>histogram</classname> &</paramtype></parameter></constructor>
-<constructor><parameter name="rhs"><paramtype><classname>histogram</classname> &&</paramtype></parameter></constructor>
-<copy-assignment><type><classname>histogram</classname> &</type><parameter name="rhs"><paramtype><classname>histogram</classname> &&</paramtype></parameter></copy-assignment>
-<copy-assignment><type><classname>histogram</classname> &</type><parameter name="rhs"><paramtype>const <classname>histogram</classname> &</paramtype></parameter></copy-assignment>
<constructor specifiers="explicit"><template>
<template-type-parameter name="A"/>
<template-type-parameter name="S"/>
</template><parameter name="rhs"><paramtype>const <classname>histogram</classname>< A, S > &</paramtype></parameter></copy-assignment>
<constructor><template>
<template-type-parameter name="A"/>
- <template-type-parameter name="S"/>
- </template><parameter name="a"><paramtype>A &&</paramtype></parameter><parameter name="s"><paramtype>S &&</paramtype></parameter></constructor>
-<constructor specifiers="explicit"><template>
- <template-type-parameter name="A"/>
<template-type-parameter name=""><default>detail::requires_axes<A></default></template-type-parameter>
- </template><parameter name="a"><paramtype>A &&</paramtype></parameter></constructor>
-</class><struct name="sample_type"><template>
- <template-type-parameter name="T"/>
- </template><data-member name="value"><type>T</type></data-member>
-</struct><struct name="weight_type"><template>
- <template-type-parameter name="T"/>
- </template><data-member name="value"><type>T</type></data-member>
-</struct>
+ </template><parameter name="a"><paramtype>A &&</paramtype></parameter><parameter name="s"><paramtype>Storage</paramtype></parameter></constructor>
+<constructor specifiers="explicit"><parameter name="axes"><paramtype>Axes</paramtype></parameter></constructor>
+<constructor specifiers="explicit"><template>
+ <template-nontype-parameter name="As"><type>class...</type></template-nontype-parameter>
+ <template-type-parameter name=""><default>detail::requires_axes<std::tuple<std::decay_t<As>...>></default></template-type-parameter>
+ </template><parameter name="as"><paramtype>As &&...</paramtype></parameter></constructor>
+</class>
+
+
<template-type-parameter name="A"/>
<template-type-parameter name="S"/>
</template><parameter name="h"><paramtype>const <classname>histogram</classname>< A, S > &</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>
-<function name="weight"><type>auto</type><template>
- <template-type-parameter name="T"/>
- </template><parameter name="t"><paramtype>T &&</paramtype><description><para>argument to be forward to the histogram. </para></description></parameter><purpose>Helper function to mark argument as weight. </purpose><description><para>
-</para></description></function>
-<function name="sample"><type>auto</type><template>
- <template-nontype-parameter name="Ts"><type>typename...</type></template-nontype-parameter>
- </template><parameter name="ts"><paramtype>Ts &&...</paramtype><description><para>arguments to be forwarded to the accumulator. </para></description></parameter><purpose>Helper function to mark arguments as sample. </purpose><description><para>
-</para></description></function>
</namespace>
</namespace>
</header>
<header name="boost/histogram/accumulators.hpp">
-</header>
+<para>Includes all accumulator headers of the Boost.Histogram library. </para><para>Extra header not automatically included:<itemizedlist>
+<listitem><para><ulink url="histogram/reference.html#header.boost.histogram.accumulators.ostream_hpp">boost/histogram/accumulators/ostream.hpp</ulink> </para>
+</listitem></itemizedlist>
+</para></header>
<header name="boost/histogram/accumulators/mean.hpp">
<namespace name="boost">
<namespace name="histogram">
<class name="mean"><template>
<template-type-parameter name="RealType"/>
</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">
-<method name="operator()"><type>void</type><parameter name="x"><paramtype>const RealType &</paramtype></parameter></method>
-<method name="operator+="><type><classname>mean</classname> &</type><template>
+<method name="operator()" cv="noexcept"><type>void</type><parameter name="x"><paramtype>const RealType &</paramtype></parameter></method>
+<method name="operator()" cv="noexcept"><type>void</type><parameter name="w"><paramtype>const <classname>weight_type</classname>< RealType > &</paramtype></parameter><parameter name="x"><paramtype>const RealType &</paramtype></parameter></method>
+<method name="operator+=" cv="noexcept"><type><classname>mean</classname> &</type><template>
<template-type-parameter name="T"/>
</template><parameter name="rhs"><paramtype>const <classname>mean</classname>< T > &</paramtype></parameter></method>
-<method name="operator *="><type><classname>mean</classname> &</type><parameter name="s"><paramtype>const RealType &</paramtype></parameter></method>
+<method name="operator *="
cv="noexcept"><type><classname>mean</classname> &</type><parameter name="s"><paramtype>const RealType &</paramtype></parameter></method>
<method name="operator==" cv="const noexcept"><type>bool</type><template>
<template-type-parameter name="T"/>
</template><parameter name="rhs"><paramtype>const <classname>mean</classname>< T > &</paramtype></parameter></method>
<method name="operator!=" cv="const noexcept"><type>bool</type><template>
<template-type-parameter name="T"/>
</template><parameter name="rhs"><paramtype>const <classname>mean</classname>< T > &</paramtype></parameter></method>
-<method name="count" cv="const noexcept"><type>std::size_t</type></method>
+<method name="count" cv="const noexcept"><type>const RealType &</type></method>
<method name="value" cv="const noexcept"><type>const RealType &</type></method>
-<method name="variance" cv="const"><type>RealType</type></method>
+<method name="variance" cv="const noexcept"><type>RealType</type></method>
<method name="serialize"><type>void</type><template>
<template-type-parameter name="Archive"/>
- </template><parameter name="
"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+ </template><parameter name="
ar"><paramtype>Archive &</paramtype></parameter><parameter name="version"><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"/>
-<constructor
><parameter name="n"><paramtype>const std::size_t</paramtype></parameter><parameter name="mean"><paramtype>const RealType &</paramtype></parameter><parameter name="variance"><paramtype>const RealType &</paramtype></parameter></constructor>
+<constructor
cv="noexcept"><parameter name="n"><paramtype>const RealType &</paramtype></parameter><parameter name="mean"><paramtype>const RealType &</paramtype></parameter><parameter name="variance"><paramtype>const RealType &</paramtype></parameter></constructor>
</class></namespace>
<method name="conversion-operator" cv="const"><type>RealType</type></method>
<method name="serialize"><type>void</type><template>
<template-type-parameter name="Archive"/>
- </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+ </template><parameter name="
ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"/>
<constructor specifiers="explicit" cv="noexcept"><parameter name="value"><paramtype>const RealType &</paramtype></parameter><purpose>Initialize sum to value. </purpose></constructor>
+
</namespace>
<class name="thread_safe"><template>
<template-type-parameter name="T"><purpose><para>type to adapt, must be supported by std::atomic. </para></purpose></template-type-parameter>
</template><inherit access="public">std::atomic< T ></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>
-</para></description><typedef name="super_t"><type>std::atomic< T ></type></typedef>
+</para></description><typedef name="value_type"><type>T</type></typedef>
+<typedef name="super_t"><type>std::atomic< T ></type></typedef>
<method-group name="public member functions">
-<method name="operator+="><type>void</type><parameter name="arg"><paramtype>T</paramtype></parameter></method>
-<method name="operator++"><type>void</type></method>
+<method name="operator+="><type><classname>thread_safe</classname> &</type><parameter name="arg"><paramtype>const <classname>thread_safe</classname> &</paramtype></parameter></method>
+<method name="operator+="><type><classname>thread_safe</classname> &</type><parameter name="arg"><paramtype>value_type</paramtype></parameter></method>
+<method name="operator++"><type><classname>thread_safe</classname> &</type></method>
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name="ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="noexcept"/>
<constructor cv="noexcept"><parameter name="o"><paramtype>const <classname>thread_safe</classname> &</paramtype></parameter></constructor>
<copy-assignment cv="noexcept"><type><classname>thread_safe</classname> &</type><parameter name="o"><paramtype>const <classname>thread_safe</classname> &</paramtype></parameter></copy-assignment>
-<constructor><parameter name="arg"><paramtype>T</paramtype></parameter></constructor>
-<copy-assignment><type><classname>thread_safe</classname> &</type><parameter name="arg"><paramtype>T</paramtype></parameter></copy-assignment>
+<constructor><parameter name="arg"><paramtype>value_type</paramtype></parameter></constructor>
+<copy-assignment><type><classname>thread_safe</classname> &</type><parameter name="arg"><paramtype>value_type</paramtype></parameter></copy-assignment>
</class></namespace>
<template-type-parameter name="RealType"/>
</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">
<method name="operator()"><type>void</type><parameter name="x"><paramtype>const RealType &</paramtype></parameter></method>
-<method name="operator()"><type>void</type><parameter name="w"><paramtype>const
RealType &</paramtype></parameter><parameter name="x"><paramtype>const RealType &</paramtype></parameter></method>
+<method name="operator()"><type>void</type><parameter name="w"><paramtype>const
<classname>weight_type</classname>< RealType > &</paramtype></parameter><parameter name="x"><paramtype>const RealType &</paramtype></parameter></method>
<method name="operator+="><type><classname>weighted_mean</classname> &</type><template>
<template-type-parameter name="T"/>
</template><parameter name="rhs"><paramtype>const <classname>weighted_mean</classname>< T > &</paramtype></parameter></method>
<template-type-parameter name="T"/>
</template><parameter name="rhs"><paramtype>const T &</paramtype></parameter></method>
<method name="sum_of_weights" cv="const noexcept"><type>const RealType &</type></method>
+<method name="sum_of_weights_squared" cv="const noexcept"><type>const RealType &</type></method>
<method name="value" cv="const noexcept"><type>const RealType &</type></method>
<method name="variance" cv="const"><type>RealType</type></method>
<method name="serialize"><type>void</type><template>
<template-type-parameter name="Archive"/>
- </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+ </template><parameter name="
ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"/>
<constructor><parameter name="wsum"><paramtype>const RealType &</paramtype></parameter><parameter name="wsum2"><paramtype>const RealType &</paramtype></parameter><parameter name="mean"><paramtype>const RealType &</paramtype></parameter><parameter name="variance"><paramtype>const RealType &</paramtype></parameter></constructor>
</template></method>
<method name="serialize"><type>void</type><template>
<template-type-parameter name="Archive"/>
- </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+ </template><parameter name="
ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"/>
<constructor specifiers="explicit" cv="noexcept"><parameter name="value"><paramtype>const RealType &</paramtype></parameter></constructor>
</namespace>
</namespace>
</header>
+<header name="boost/histogram/algorithm.hpp">
+<para>Includes all algorithm headers of the Boost.Histogram library. </para></header>
+<header name="boost/histogram/algorithm/empty.hpp">
+<namespace name="boost">
+<namespace name="histogram">
+<namespace name="algorithm">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<function name="empty"><type>auto</type><template>
+ <template-type-parameter name="A"/>
+ <template-type-parameter name="S"/>
+ </template><parameter name="h"><paramtype>const <classname>histogram</classname>< A, S > &</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>
+</namespace>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</namespace>
+</namespace>
+</header>
<header name="boost/histogram/algorithm/project.hpp">
<namespace name="boost">
<namespace name="histogram">
<template-type-parameter name="Iterable"/>
<template-type-parameter name=""><default>detail::requires_iterable<Iterable></default></template-type-parameter>
</template><parameter name="h"><paramtype>const <classname>histogram</classname>< A, S > &</paramtype></parameter><parameter name="c"><paramtype>const Iterable &</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>
+
</namespace>
</para></description></function>
<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>
</para></description></function>
-<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>
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(). </purpose><description><para>
+<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>
</para></description></function>
<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>
</para></description></function>
<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>
</para></description></function>
-<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() (onvenience overload for single axis). </purpose><description><para>
+<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>
</para></description></function>
<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>
</para></description></function>
</para></description></function>
+
</namespace>
</namespace>
</header>
<header name="boost/histogram/axis.hpp">
-</header>
+<para>Includes all axis headers of the Boost.Histogram library. </para><para>Extra header not automatically included:<itemizedlist>
+<listitem><para><ulink url="histogram/reference.html#header.boost.histogram.axis.ostream_hpp">boost/histogram/axis/ostream.hpp</ulink> </para>
+</listitem></itemizedlist>
+</para></header>
<header name="boost/histogram/axis/category.hpp">
<namespace name="boost">
<namespace name="histogram">
<template-type-parameter name="MetaData"><purpose><para>type to store meta data. </para></purpose></template-type-parameter>
<template-type-parameter name="Options"><purpose><para>see boost::histogram::axis::option. </para></purpose></template-type-parameter>
<template-type-parameter name="Allocator"><purpose><para>allocator to use for dynamic memory management.</para></purpose></template-type-parameter>
- </template><inherit access="public">boost::histogram::axis::iterator_mixin< category< Value, MetaData, Options, Allocator > ></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>
+ </template><inherit access="public">boost::histogram::axis::iterator_mixin< category< Value, MetaData, Options, Allocator > ></inherit><
inherit access="public">boost::histogram::axis::metadata_base< MetaData ></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>
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">
<method name="index" cv="const noexcept"><type>index_type</type><parameter name="x"><paramtype>const value_type &</paramtype></parameter><purpose>Return index for value argument. </purpose></method>
<method name="update"><type>auto</type><parameter name="x"><paramtype>const value_type &</paramtype></parameter><purpose>Returns index and shift (if axis has grown) for the passed argument. </purpose></method>
-<method name="value" cv="const"><type>
decltype(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>
+<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>
<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>
<method name="size" cv="const noexcept"><type>index_type</type><purpose>Returns the number of bins, without over- or underflow. </purpose></method>
-<method name="metadata" cv="noexcept"><type>metadata_type &</type><purpose>Returns reference to metadata. </purpose></method>
-<method name="metadata" cv="const noexcept"><type>const metadata_type &</type><purpose>Returns reference to const metadata. </purpose></method>
<method name="operator==" cv="const noexcept"><type>bool</type><template>
<template-type-parameter name="V"/>
<template-type-parameter name="M"/>
<method name="get_allocator" cv="const"><type>auto</type></method>
<method name="serialize"><type>void</type><template>
<template-type-parameter name="Archive"/>
- </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+ </template><parameter name="
ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
-<constructor specifiers="explicit"><parameter name="alloc"><paramtype>allocator_type</paramtype><default>{}</default></parameter></constructor>
-<constructor cv="= default"><parameter name=""><paramtype>const <classname>category</classname> &</paramtype></parameter></constructor>
-<copy-assignment cv="= default"><type><classname>category</classname> &</type><parameter name=""><paramtype>const <classname>category</classname> &</paramtype></parameter></copy-assignment>
-<constructor cv="noexcept"><parameter name="o"><paramtype><classname>category</classname> &&</paramtype></parameter></constructor>
-<copy-assignment cv="noexcept"><type><classname>category</classname> &</type><parameter name="o"><paramtype><classname>category</classname> &&</paramtype></parameter></copy-assignment>
+<constructor cv="= default"/>
+<constructor specifiers="explicit"><parameter name="alloc"><paramtype>allocator_type</paramtype></parameter></constructor>
<constructor><template>
<template-type-parameter name="It"/>
<template-type-parameter name=""><default>detail::requires_iterator<It></default></template-type-parameter>
</para></description></constructor>
<method-group name="public static functions">
<method name="options" cv="noexcept" specifiers="static"><type>constexpr unsigned</type><purpose>Returns the options. </purpose></method>
+<method name="inclusive" cv="noexcept" specifiers="static"><type>constexpr bool</type><purpose>Whether the axis is inclusive (see axis::traits::is_inclusive). </purpose></method>
</method-group>
</class>
+
</namespace>
<template-type-parameter name="Value"><purpose><para>input value type. Must be integer or floating point. </para></purpose></template-type-parameter>
<template-type-parameter name="MetaData"><purpose><para>type to store meta data. </para></purpose></template-type-parameter>
<template-type-parameter name="Options"><purpose><para>see boost::histogram::axis::option (all values allowed). </para></purpose></template-type-parameter>
- </template><inherit access="public">boost::histogram::axis::iterator_mixin< integer< Value, MetaData, Options > ></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>
+ </template><inherit access="public">boost::histogram::axis::iterator_mixin< integer< Value, MetaData, Options > ></inherit><
inherit access="public">boost::histogram::axis::metadata_base< MetaData ></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>
</para></description><method-group name="public member functions">
<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>
<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>
<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>
<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>
<method name="size" cv="const noexcept"><type>index_type</type><purpose>Returns the number of bins, without over- or underflow. </purpose></method>
-<method name="metadata" cv="noexcept"><type>metadata_type &</type><purpose>Returns reference to metadata. </purpose></method>
-<method name="metadata" cv="const noexcept"><type>const metadata_type &</type><purpose>Returns reference to const metadata. </purpose></method>
<method name="operator==" cv="const noexcept"><type>bool</type><template>
<template-type-parameter name="V"/>
<template-type-parameter name="M"/>
</template><parameter name="o"><paramtype>const <classname>integer</classname>< V, M, O > &</paramtype></parameter></method>
<method name="serialize"><type>void</type><template>
<template-type-parameter name="Archive"/>
- </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+ </template><parameter name="
ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"/>
-<constructor cv="= default"><parameter name=""><paramtype>const <classname>integer</classname> &</paramtype></parameter></constructor>
-<copy-assignment cv="= default"><type><classname>integer</classname> &</type><parameter name=""><paramtype>const <classname>integer</classname> &</paramtype></parameter></copy-assignment>
-<constructor cv="noexcept"><parameter name="o"><paramtype><classname>integer</classname> &&</paramtype></parameter></constructor>
-<copy-assignment cv="noexcept"><type><classname>integer</classname> &</type><parameter name="o"><paramtype><classname>integer</classname> &&</paramtype></parameter></copy-assignment>
<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>
</para></description></constructor>
<constructor><parameter name="src"><paramtype>const <classname>integer</classname> &</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>
<method-group name="public static functions">
<method name="options" cv="noexcept" specifiers="static"><type>constexpr unsigned</type><purpose>Returns the options. </purpose></method>
+<method name="inclusive" cv="noexcept" specifiers="static"><type>constexpr bool</type><purpose>Whether the axis is inclusive (see axis::traits::is_inclusive). </purpose></method>
</method-group>
<method-group name="private member functions">
<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>
+
</namespace>
+
</namespace>
+
+</namespace>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</namespace>
+</namespace>
+</header>
+<header name="boost/histogram/axis/metadata_base.hpp">
+<namespace name="boost">
+<namespace name="histogram">
+<namespace name="axis">
+<class name="metadata_base"><template>
+ <template-type-parameter name="Metadata"/>
+ <template-type-parameter name="DetailMetadata"><default>detail::replace_default<Metadata, std::string></default></template-type-parameter>
+ </template><inherit access="private">empty_value< DetailMetadata ></inherit><purpose>Meta data holder with space optimization for empty meta data types. </purpose><method-group name="protected member functions">
+</method-group>
+<constructor cv="= default"/>
+<constructor cv="= default"><parameter name=""><paramtype>const <classname>metadata_base</classname> &</paramtype></parameter></constructor>
+<copy-assignment cv="= default"><type><classname>metadata_base</classname> &</type><parameter name=""><paramtype>const <classname>metadata_base</classname> &</paramtype></parameter></copy-assignment>
+<constructor cv="noexcept"><parameter name="o"><paramtype><classname>metadata_base</classname> &&</paramtype></parameter></constructor>
+<constructor cv="noexcept"><parameter name="o"><paramtype>metadata_type &&</paramtype></parameter></constructor>
+<copy-assignment cv="noexcept"><type><classname>metadata_base</classname> &</type><parameter name="o"><paramtype><classname>metadata_base</classname> &&</paramtype></parameter></copy-assignment>
+<method-group name="public member functions">
+<method name="metadata" cv="noexcept"><type>metadata_type &</type><purpose>Returns reference to metadata. </purpose></method>
+<method name="metadata" cv="const noexcept"><type>const metadata_type &</type><purpose>Returns reference to const metadata. </purpose></method>
+<method name="operator==" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>metadata_base</classname> &</paramtype></parameter></method>
+<method name="operator!=" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>metadata_base</classname> &</paramtype></parameter></method>
+</method-group>
+</class>
+
+
+
+
+
+
+
+
+
+
+
+
</namespace>
+
</namespace>
+
</namespace>
<template-type-parameter name="Transform"><purpose><para>builtin or user-defined transform type. </para></purpose></template-type-parameter>
<template-type-parameter name="MetaData"><purpose><para>type to store meta data. </para></purpose></template-type-parameter>
<template-type-parameter name="Options"><purpose><para>see boost::histogram::axis::option (all values allowed). </para></purpose></template-type-parameter>
- </template><inherit access="public">boost::histogram::axis::iterator_mixin< regular< Value, Transform, MetaData, Options > ></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>
+ </template><inherit access="public">boost::histogram::axis::iterator_mixin< regular< Value, Transform, MetaData, Options > ></inherit><
inherit access="public">boost::histogram::axis::metadata_base< MetaData ></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>
</para></description><method-group name="public member functions">
<method name="transform" cv="const noexcept"><type>const transform_type &</type><purpose>Return instance of the transform type. </purpose></method>
<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>
<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>
<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>
<method name="size" cv="const noexcept"><type>index_type</type><purpose>Returns the number of bins, without over- or underflow. </purpose></method>
-<method name="metadata" cv="noexcept"><type>metadata_type &</type><purpose>Returns reference to metadata. </purpose></method>
-<method name="metadata" cv="const noexcept"><type>const metadata_type &</type><purpose>Returns reference to const metadata. </purpose></method>
<method name="operator==" cv="const noexcept"><type>bool</type><template>
<template-type-parameter name="V"/>
<template-type-parameter name="T"/>
</template><parameter name="o"><paramtype>const <classname>regular</classname>< V, T, M, O > &</paramtype></parameter></method>
<method name="serialize"><type>void</type><template>
<template-type-parameter name="Archive"/>
- </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+ </template><parameter name="
ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"/>
-<constructor cv="= default"><parameter name=""><paramtype>const <classname>regular</classname> &</paramtype></parameter></constructor>
-<copy-assignment cv="= default"><type><classname>regular</classname> &</type><parameter name=""><paramtype>const <classname>regular</classname> &</paramtype></parameter></copy-assignment>
-<constructor cv="noexcept"><parameter name="o"><paramtype><classname>regular</classname> &&</paramtype></parameter></constructor>
-<copy-assignment cv="noexcept"><type><classname>regular</classname> &</type><parameter name="o"><paramtype><classname>regular</classname> &&</paramtype></parameter></copy-assignment>
<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>
</para></description></constructor>
<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>
</para></description></constructor>
<constructor><template>
<template-type-parameter name="T"/>
- </template><parameter name="trans"><paramtype>transform_type</paramtype><description><para>transform instance to use. </para></description></parameter><parameter name="step"><paramtype>
const step_type< T > &</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>
+ </template><parameter name="trans"><paramtype>transform_type</paramtype><description><para>transform instance to use. </para></description></parameter><parameter name="step"><paramtype>
step_type< T ></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>
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>
<constructor><template>
<template-type-parameter name="T"/>
- </template><parameter name="step"><paramtype>
const step_type< T > &</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>
+ </template><parameter name="step"><paramtype>
step_type< T ></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>
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>
<constructor><parameter name="src"><paramtype>const <classname>regular</classname> &</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>
<method-group name="public static functions">
<template-type-parameter name="T"/>
</template><parameter name="x"><paramtype>T &&</paramtype></parameter><purpose>Pass-through. </purpose></method>
</method-group>
+<method-group name="public member functions">
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+</method-group>
</struct><struct name="log"><purpose>Log transform for equidistant bins in log-space. </purpose><method-group name="public static functions">
<method name="forward" specifiers="static"><type>T</type><template>
<template-type-parameter name="T"/>
<template-type-parameter name="T"/>
</template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns exp(x) for internal value x. </purpose></method>
</method-group>
+<method-group name="public member functions">
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+</method-group>
</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>
<method-group name="public member functions">
<method name="forward" cv="const"><type>auto</type><template>
<template-type-parameter name="T"/>
</template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns pow(x, 1/power) of external value x. </purpose></method>
<method name="operator==" cv="const noexcept"><type>bool</type><parameter name="o"><paramtype>const <classname>pow</classname> &</paramtype></parameter></method>
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name="ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor specifiers="explicit"><parameter name="p"><paramtype>double</paramtype></parameter><purpose>Make transform with index p. </purpose></constructor>
<constructor cv="= default"/>
<template-type-parameter name="T"/>
</template><parameter name="x"><paramtype>T</paramtype></parameter><purpose>Returns x^2 of internal value x. </purpose></method>
</method-group>
+<method-group name="public member functions">
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+</method-group>
</struct></namespace>
-<function name="step"><type>auto</type><template>
+
+<function name="step"><type>step_type< T ></type><template>
<template-type-parameter name="T"/>
- </template><parameter name="t"><paramtype>T
&&</paramtype></parameter><purpose>Helper function to mark argument as step size. </purpose></function>
+ </template><parameter name="t"><paramtype>T</paramtype></parameter><purpose>Helper function to mark argument as step size. </purpose></function>
</namespace>
<namespace name="histogram">
<namespace name="axis">
<namespace name="traits">
-<struct name="is_reducible"><template>
+<struct name="is_continuous"><template>
+ <template-type-parameter name="Axis"/>
+ </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>
<template-type-parameter name="Axis"><purpose><para>axis type. </para></purpose></template-type-parameter>
- </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, it accepts an axis type and represents std::true_type or std::false_type, depending on whether the axis can be reduced with boost::histogram::algorithm::reduce().</para><para>
+ </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>
+</para></description></struct><struct name="static_is_inclusive"><template>
+ <template-type-parameter name="Axis"/>
+ </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<Axis> and checks whether the underflow and overflow bits are present.</para><para>
</para></description></struct><struct name="static_options"><template>
<template-type-parameter name="Axis"><purpose><para>axis type </para></purpose></template-type-parameter>
- </template><purpose>Get static axis options for axis type. </purpose><description><para>Doxygen does not render this well. This is a meta-function, it accepts an axis type and represents its <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>
-</para></description></struct><function name="metadata"><type>decltype(auto)</type><template>
+ </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>
+</para></description></struct><struct name="value_type"><template>
+ <template-type-parameter name="Axis"/>
+ </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>
<template-type-parameter name="Axis"/>
- </template><parameter name="axis"><paramtype>
Axis &&</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>
+ </template><parameter name="axis"><paramtype>
const Axis &</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<Axis>::value.</para><para>
</para></description></function>
-<function name="options"><type>constexpr unsigned</type><template>
+<function name="options"><type>unsigned</type><template>
+ <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
+ </template><parameter name="axis"><paramtype>const <classname>variant</classname>< Ts... > &</paramtype></parameter></function>
+<function name="inclusive"><type>constexpr bool</type><template>
<template-type-parameter name="Axis"/>
- </template><parameter name="axis"><paramtype>const Axis &</paramtype><description><para>any axis instance </para></description></parameter><purpose>Returns
axis options as unsigned integer. </purpose><description><para>If axis.options() is valid, return the result. Otherwise, return boost::histogram::axis::traits::static_options<decltype(axis)>::value.</para><para>
+ </template><parameter name="axis"><paramtype>const Axis &</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>
</para></description></function>
-<function name="extent"><type>constexpr index_type</type><template>
+<function name="inclusive"><type>bool</type><template>
+ <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
+ </template><parameter name="axis"><paramtype>const <classname>variant</classname>< Ts... > &</paramtype></parameter></function>
+<function name="extent"><type>index_type</type><template>
<template-type-parameter name="Axis"/>
</template><parameter name="axis"><paramtype>const Axis &</paramtype><description><para>any axis instance </para></description></parameter><purpose>Returns axis size plus any extra bins for under- and overflow. </purpose><description><para>
</para></description></function>
+<function name="metadata"><type>decltype(auto)</type><template>
+ <template-type-parameter name="Axis"/>
+ </template><parameter name="axis"><paramtype>Axis &&</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>
+</para></description></function>
<function name="value"><type>decltype(auto)</type><template>
<template-type-parameter name="Axis"/>
</template><parameter name="axis"><paramtype>const Axis &</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>
<function name="index"><type>axis::index_type</type><template>
<template-type-parameter name="Axis"/>
<template-type-parameter name="U"/>
- <template-type-parameter name="_V"><default>std::decay_t<detail::arg_type<decltype(&Axis::index)>></default></template-type-parameter>
</template><parameter name="axis"><paramtype>const Axis &</paramtype><description><para>any axis instance </para></description></parameter><parameter name="value"><paramtype>const U &</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>
</para></description></function>
<function name="index"><type>axis::index_type</type><template>
<template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
<template-type-parameter name="U"/>
</template><parameter name="axis"><paramtype>const <classname>variant</classname>< Ts... > &</paramtype></parameter><parameter name="value"><paramtype>const U &</paramtype></parameter></function>
+<function name="rank"><type>constexpr unsigned</type><template>
+ <template-type-parameter name="Axis"/>
+ </template><parameter name="axis"><paramtype>const Axis &</paramtype><description><para>any axis instance </para></description></parameter><purpose>Return axis rank (how many arguments it processes). </purpose><description><para>
+</para></description></function>
+<function name="rank"><type>unsigned</type><template>
+ <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
+ </template><parameter name="axis"><paramtype>const <classname>axis::variant</classname>< Ts... > &</paramtype></parameter></function>
<function name="update"><type>std::pair< index_type, index_type ></type><template>
<template-type-parameter name="Axis"/>
<template-type-parameter name="U"/>
- <template-type-parameter name="_V"><default>std::decay_t<detail::arg_type<decltype(&Axis::index)>></default></template-type-parameter>
</template><parameter name="axis"><paramtype>Axis &</paramtype><description><para>any axis instance </para></description></parameter><parameter name="value"><paramtype>const U &</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<decltype(axis)> 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>
</para></description></function>
<function name="update"><type>std::pair< index_type, index_type ></type><template>
+
</namespace>
<template-type-parameter name="MetaData"><purpose><para>type to store meta data. </para></purpose></template-type-parameter>
<template-type-parameter name="Options"><purpose><para>see boost::histogram::axis::option (all values allowed). </para></purpose></template-type-parameter>
<template-type-parameter name="Allocator"><purpose><para>allocator to use for dynamic memory management. </para></purpose></template-type-parameter>
- </template><inherit access="public">boost::histogram::axis::iterator_mixin< variable< Value, MetaData, Options, Allocator > ></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>
+ </template><inherit access="public">boost::histogram::axis::iterator_mixin< variable< Value, MetaData, Options, Allocator > ></inherit><
inherit access="public">boost::histogram::axis::metadata_base< MetaData ></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>
</para></description><method-group name="public member functions">
<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>
<method name="update" cv="noexcept"><type>auto</type><parameter name="x"><paramtype>value_type</paramtype></parameter></method>
<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>
<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>
<method name="size" cv="const noexcept"><type>index_type</type><purpose>Returns the number of bins, without over- or underflow. </purpose></method>
-<method name="metadata" cv="noexcept"><type>metadata_type &</type><purpose>Returns reference to metadata. </purpose></method>
-<method name="metadata" cv="const noexcept"><type>const metadata_type &</type><purpose>Returns reference to const metadata. </purpose></method>
<method name="operator==" cv="const noexcept"><type>bool</type><template>
<template-type-parameter name="V"/>
<template-type-parameter name="M"/>
<method name="get_allocator" cv="const"><type>auto</type><purpose>Return allocator instance. </purpose></method>
<method name="serialize"><type>void</type><template>
<template-type-parameter name="Archive"/>
- </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+ </template><parameter name="
ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
-<constructor specifiers="explicit"><parameter name="alloc"><paramtype>allocator_type</paramtype><default>{}</default></parameter></constructor>
-<constructor cv="= default"><parameter name=""><paramtype>const <classname>variable</classname> &</paramtype></parameter></constructor>
-<copy-assignment cv="= default"><type><classname>variable</classname> &</type><parameter name=""><paramtype>const <classname>variable</classname> &</paramtype></parameter></copy-assignment>
-<constructor cv="noexcept"><parameter name="o"><paramtype><classname>variable</classname> &&</paramtype></parameter></constructor>
-<copy-assignment cv="noexcept"><type><classname>variable</classname> &</type><parameter name="o"><paramtype><classname>variable</classname> &&</paramtype></parameter></copy-assignment>
+<constructor cv="= default"/>
+<constructor specifiers="explicit"><parameter name="alloc"><paramtype>allocator_type</paramtype></parameter></constructor>
<constructor><template>
<template-type-parameter name="It"/>
<template-type-parameter name=""><default>detail::requires_iterator<It></default></template-type-parameter>
+
</namespace>
</template><inherit access="public">boost::histogram::axis::iterator_mixin< variant< Ts... > ></inherit><purpose>Polymorphic axis type. </purpose><method-group name="public member functions">
<method name="size" cv="const"><type>index_type</type><purpose>Return size of axis. </purpose></method>
<method name="options" cv="const"><type>unsigned</type><purpose>Return options of axis or option::none_t if axis has no options. </purpose></method>
+<method name="inclusive" cv="const"><type>bool</type><purpose>Returns true if the axis is inclusive or false. </purpose></method>
<method name="metadata" cv="const"><type>const metadata_type &</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>
<method name="metadata"><type>metadata_type &</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>
<method name="index" cv="const"><type>index_type</type><template>
<method name="operator!=" cv="const"><type>bool</type><template>
<template-type-parameter name="T"/>
</template><parameter name="t"><paramtype>const T &</paramtype></parameter><purpose>The negation of operator==. </purpose></method>
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name="ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"/>
<constructor cv="= default"><parameter name=""><paramtype>const <classname>variant</classname> &</paramtype></parameter></constructor>
<template-type-parameter name="Visitor"/>
<template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
</template><parameter name="vis"><paramtype>Visitor &&</paramtype></parameter><parameter name="var"><paramtype>const <classname>variant</classname>< Us... > &</paramtype></parameter><purpose>Apply visitor to variant (const reference). </purpose></function>
-<function name="get_if"><type>T *</type><template>
+<function name="get_if"><type>auto</type><template>
<template-type-parameter name="T"/>
<template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
</template><parameter name="v"><paramtype><classname>variant</classname>< Us... > *</paramtype></parameter><purpose>Returns pointer to T in variant or null pointer if type does not match. </purpose></function>
-<function name="get_if"><type>const T *</type><template>
+<function name="get_if"><type>auto</type><template>
<template-type-parameter name="T"/>
<template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
</template><parameter name="v"><paramtype>const <classname>variant</classname>< Us... > *</paramtype></parameter><purpose>Returns pointer to const T in variant or null pointer if type does not match. </purpose></function>
<template-type-parameter name="T"/>
<template-nontype-parameter name="Us"><type>class...</type></template-nontype-parameter>
</template><parameter name="v"><paramtype>const <classname>variant</classname>< Us... > &</paramtype></parameter><purpose>Return const reference to T, throws unspecified exception if type does not match. </purpose></function>
+<function name="visit"><type>decltype(auto)</type><template>
+ <template-type-parameter name="Visitor"/>
+ <template-type-parameter name="T"/>
+ </template><parameter name="vis"><paramtype>Visitor &&</paramtype></parameter><parameter name="var"><paramtype>T &&</paramtype></parameter></function>
<function name="get"><type>decltype(auto)</type><template>
<template-type-parameter name="T"/>
<template-type-parameter name="U"/>
</template><parameter name="u"><paramtype>U &&</paramtype></parameter></function>
-<function name="get_if"><type>T *</type><template>
+<function name="get_if"><type>auto</type><template>
<template-type-parameter name="T"/>
<template-type-parameter name="U"/>
</template><parameter name="u"><paramtype>U *</paramtype></parameter></function>
-<function name="get_if"><type>const T *</type><template>
+<function name="get_if"><type>auto</type><template>
<template-type-parameter name="T"/>
<template-type-parameter name="U"/>
</template><parameter name="u"><paramtype>const U *</paramtype></parameter></function>
<para>Forward declarations, tag types and type aliases. </para><namespace name="boost">
<namespace name="histogram">
<namespace name="axis">
-<struct name="null_type"><purpose>Empty metadata type. </purpose></struct><typedef name="index_type"><purpose>Integral type for axis indices. </purpose><type>int</type></typedef>
+<struct name="null_type"><purpose>Empty metadata type. </purpose><method-group name="public member functions">
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name=""><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
+</method-group>
+</struct><typedef name="index_type"><purpose>Integral type for axis indices. </purpose><type>int</type></typedef>
<typedef name="real_index_type"><purpose>Real type for axis indices. </purpose><type>double</type></typedef>
+<typedef name="empty_type"><purpose>Another alias for an empty metadata type. </purpose><type><classname>null_type</classname></type></typedef>
+
<namespace name="histogram">
<class name="indexed_range"><template>
<template-type-parameter name="Histogram"/>
- </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>
Pointer-like class to access value and index of current cell. </purpose><description><para>Its methods provide access to the current indices and bins and it acts like a pointer to the cell value. 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. The accessor is coupled to its parent iterator. Moving the parent iterator forward also updates the linked accessor. Accessors are not copyable. They cannot be stored in containers, but range_iterators 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">
+ </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">
<method name="operator *" cv="const noexcept"><type>const_reference</type></method>
</method-group>
<method-group name="private member functions">
<method-group name="private member functions">
</method-group>
<constructor><parameter name="h"><paramtype>histogram_type *</paramtype></parameter></constructor>
-</class><typedef name="value_iterator"><type>decltype(std::declval< histogram_type >().begin())</type></typedef>
-<typedef name="value_reference"><type>typename value_iterator::reference</type></typedef>
-<typedef name="value_type"><type>typename value_iterator::value_type</type></typedef>
+</class><typedef name="value_iterator"><type>std::conditional_t< std::is_const< histogram_type >::value, typename histogram_type::const_iterator, typename histogram_type::iterator ></type></typedef>
+<typedef name="value_reference"><type>typename std::iterator_traits< value_iterator >::reference</type></typedef>
+<typedef name="value_type"><type>typename std::iterator_traits< value_iterator >::value_type</type></typedef>
<typedef name="range_iterator"><purpose>deprecated </purpose><type><classname>iterator</classname></type></typedef>
<method-group name="public member functions">
<method name="begin" cv="noexcept"><type><classname>iterator</classname></type></method>
+
+
<function name="indexed"><type>auto</type><template>
<template-type-parameter name="Histogram"/>
</template><parameter name="hist"><paramtype>Histogram &&</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&& x : indexed(hist)) { ... }
-
-
</namespace>
</namespace>
</header>
+
+
<function name="make_histogram_with"><type>auto</type><template>
<template-type-parameter name="Storage"/>
<template-type-parameter name="Axis"/>
-
-
</namespace>
</namespace>
</header>
<header name="boost/histogram/make_profile.hpp">
<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">
<namespace name="histogram">
+
+
<function name="make_profile"><type>auto</type><template>
<template-type-parameter name="Axis"/>
<template-nontype-parameter name="Axes"><type>typename...</type></template-nontype-parameter>
-
-
</namespace>
</namespace>
</header>
<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>
<header name="boost/histogram/axis/ostream.hpp">
<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>
+<header name="boost/histogram/sample.hpp">
+<namespace name="boost">
+<namespace name="histogram">
+<struct name="sample_type"><template>
+ <template-type-parameter name="T"/>
+ </template><data-member name="value"><type>T</type></data-member>
+</struct>
+<function name="sample"><type>auto</type><template>
+ <template-nontype-parameter name="Ts"><type>class...</type></template-nontype-parameter>
+ </template><parameter name="ts"><paramtype>Ts &&...</paramtype><description><para>arguments to be forwarded to the accumulator. </para></description></parameter><purpose>Helper function to mark arguments as sample. </purpose><description><para>
+</para></description></function>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</namespace>
+</namespace>
+</header>
<header name="boost/histogram/serialization.hpp">
-<para>Implemenations of the serialization functions using <ulink url="https://www.boost.org/doc/libs/develop/libs/serialization/doc/index.html">Boost.Serialization</ulink>. </para></header>
+<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>
<header name="boost/histogram/storage_adaptor.hpp">
<namespace name="boost">
<namespace name="histogram">
<template-type-parameter name="U"/>
<template-type-parameter name=""><default>detail::requires_iterable<U></default></template-type-parameter>
</template><parameter name="u"><paramtype>const U &</paramtype></parameter></method>
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name="ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor cv="= default"><parameter name=""><paramtype><classname>storage_adaptor</classname> &&</paramtype></parameter></constructor>
<constructor cv="= default"><parameter name=""><paramtype>const <classname>storage_adaptor</classname> &</paramtype></parameter></constructor>
<method name="end" cv="noexcept"><type>iterator</type></method>
<method name="begin" cv="const noexcept"><type>const_iterator</type></method>
<method name="end" cv="const noexcept"><type>const_iterator</type></method>
+<method name="serialize"><type>void</type><template>
+ <template-type-parameter name="Archive"/>
+ </template><parameter name="ar"><paramtype>Archive &</paramtype></parameter><parameter name=""><paramtype>unsigned</paramtype></parameter></method>
</method-group>
<constructor specifiers="explicit"><parameter name="a"><paramtype>const allocator_type &</paramtype><default>{}</default></parameter></constructor>
<constructor cv="= default"><parameter name=""><paramtype>const <classname>unlimited_storage</classname> &</paramtype></parameter></constructor>
<template-type-parameter name="Histogram"/>
</template><parameter name="hist"><paramtype>const Histogram &</paramtype><description><para>histogram. </para></description></parameter><purpose>Get storage. </purpose><description><para>
</para></description></method>
+<method name="offset" specifiers="static"><type>auto &</type><template>
+ <template-type-parameter name="Histogram"/>
+ </template><parameter name="hist"><paramtype>Histogram &</paramtype><description><para>histogram </para></description></parameter><purpose>Get index offset. </purpose><description><para>
+</para></description></method>
+<method name="offset" specifiers="static"><type>const auto &</type><template>
+ <template-type-parameter name="Histogram"/>
+ </template><parameter name="hist"><paramtype>const Histogram &</paramtype><description><para>histogram </para></description></parameter><purpose>Get index offset. </purpose><description><para>
+</para></description></method>
<method name="unlimited_storage_buffer" specifiers="static"><type>constexpr auto &</type><template>
<template-type-parameter name="Allocator"/>
</template><parameter name="storage"><paramtype><classname>unlimited_storage</classname>< Allocator > &</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>
</namespace>
</namespace>
</header>
+<header name="boost/histogram/weight.hpp">
+<namespace name="boost">
+<namespace name="histogram">
+<struct name="weight_type"><template>
+ <template-type-parameter name="T"/>
+ </template><purpose>Weight holder and type envelope. </purpose><description><para>You should not construct these directly, use the weight() helper function.</para><para>
+</para></description><data-member name="value"><type>T</type><purpose>Access underlying value. </purpose></data-member>
+<method-group name="public member functions">
+<method name="conversion-operator" cv="const"><type>weight_type< U ></type><template>
+ <template-type-parameter name="U"/>
+ </template><purpose>Allow implicit conversions of types when the underlying value type allows them. </purpose></method>
+</method-group>
+</struct><function name="weight"><type>auto</type><template>
+ <template-type-parameter name="T"/>
+ </template><parameter name="t"><paramtype>T &&</paramtype><description><para>argument to be forward to the histogram. </para></description></parameter><purpose>Helper function to mark argument as weight. </purpose><description><para>
+</para></description></function>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</namespace>
+</namespace>
+</header>
</library-reference>
\ No newline at end of file
projects / platform / upstream / boost.git / blobdiff