From 4c09b07dbcb9173100fc35d04bf15bf6c8fd4fb7 Mon Sep 17 00:00:00 2001 From: Hans Dembinski Date: Fri, 13 Oct 2017 18:10:10 +0200 Subject: [PATCH] update --- doc/autodoc.xml | 610 +++++++++--------- doc/concepts.qbk | 2 +- .../boost/histogram/adaptive_storage.html | 223 ++----- doc/html/boost/histogram/array_storage.html | 120 ++++ doc/html/boost/histogram/axis/axis_base.html | 61 ++ .../axis/axis_base__idm272931662048.html | 115 ++++ .../axis/axis_base__idm272931684640.html | 115 ++++ .../axis/axis_base_f_idm27630255200.html | 115 ++++ .../axis/axis_base_t_idm27630232864.html | 115 ++++ .../boost/histogram/axis/axis_iterator.html | 89 +++ doc/html/boost/histogram/axis/bin.html | 55 ++ doc/html/boost/histogram/axis/category.html | 140 ++++ doc/html/boost/histogram/axis/circular.html | 155 +++++ doc/html/boost/histogram/axis/integer.html | 140 ++++ doc/html/boost/histogram/axis/real_bin.html | 56 ++ doc/html/boost/histogram/axis/regular.html | 154 +++++ .../histogram/axis/transform/identity.html | 66 ++ .../boost/histogram/axis/transform/log.html | 66 ++ .../boost/histogram/axis/transform/sqrt.html | 66 ++ doc/html/boost/histogram/axis/variable.html | 150 +++++ doc/html/boost/histogram/count.html | 72 +++ doc/html/boost/histogram/histogram.html | 6 +- .../histogram/histogram_D_idm27629951904.html | 245 +++++++ .../lin_visitor.html | 77 +++ .../histogram/histogram_S_idm27629806656.html | 223 +++++++ .../shape_assign_helper.html | 66 ++ .../histogram/histogram__idm272931226048.html | 223 +++++++ .../shape_assign_helper.html | 66 ++ .../histogram/histogram__idm272931380992.html | 245 +++++++ .../lin_visitor.html | 77 +++ doc/html/boost/histogram/weight.html | 24 +- doc/html/histogram/benchmarks.html | 9 +- doc/html/histogram/changelog.html | 9 +- doc/html/histogram/concepts.html | 36 +- doc/html/histogram/motivation.html | 46 +- doc/html/histogram/rationale.html | 28 +- doc/html/histogram/reference.html | 161 ++--- doc/html/histogram/user_guide.html | 147 +++-- doc/html/histogram_HTML.manifest | 50 +- doc/html/index.html | 6 +- 40 files changed, 3693 insertions(+), 736 deletions(-) create mode 100644 doc/html/boost/histogram/array_storage.html create mode 100644 doc/html/boost/histogram/axis/axis_base.html create mode 100644 doc/html/boost/histogram/axis/axis_base__idm272931662048.html create mode 100644 doc/html/boost/histogram/axis/axis_base__idm272931684640.html create mode 100644 doc/html/boost/histogram/axis/axis_base_f_idm27630255200.html create mode 100644 doc/html/boost/histogram/axis/axis_base_t_idm27630232864.html create mode 100644 doc/html/boost/histogram/axis/axis_iterator.html create mode 100644 doc/html/boost/histogram/axis/bin.html create mode 100644 doc/html/boost/histogram/axis/category.html create mode 100644 doc/html/boost/histogram/axis/circular.html create mode 100644 doc/html/boost/histogram/axis/integer.html create mode 100644 doc/html/boost/histogram/axis/real_bin.html create mode 100644 doc/html/boost/histogram/axis/regular.html create mode 100644 doc/html/boost/histogram/axis/transform/identity.html create mode 100644 doc/html/boost/histogram/axis/transform/log.html create mode 100644 doc/html/boost/histogram/axis/transform/sqrt.html create mode 100644 doc/html/boost/histogram/axis/variable.html create mode 100644 doc/html/boost/histogram/count.html create mode 100644 doc/html/boost/histogram/histogram_D_idm27629951904.html create mode 100644 doc/html/boost/histogram/histogram_D_idm27629951904/lin_visitor.html create mode 100644 doc/html/boost/histogram/histogram_S_idm27629806656.html create mode 100644 doc/html/boost/histogram/histogram_S_idm27629806656/shape_assign_helper.html create mode 100644 doc/html/boost/histogram/histogram__idm272931226048.html create mode 100644 doc/html/boost/histogram/histogram__idm272931226048/shape_assign_helper.html create mode 100644 doc/html/boost/histogram/histogram__idm272931380992.html create mode 100644 doc/html/boost/histogram/histogram__idm272931380992/lin_visitor.html diff --git a/doc/autodoc.xml b/doc/autodoc.xml index 3ffd1332..6d534a1f 100644 --- a/doc/autodoc.xml +++ b/doc/autodoc.xml @@ -1,25 +1,22 @@ -
-Includes all standard headers of the Boost.histogram library. The library consists of two histogram implementations, a static and a dynamic one. If you need to configure histograms at runtime, choose the dynamic one, otherwise use the static one. The static one is faster, and a little more convenient, since some errors can be caught at compile time and you don't need to worry about type conversions.You can freely mix the implementations in your code, they are convertible into each other, and there is a common interface for both. To the extend of what is technically possible, the library has been designed to allow you to write code that is agnostic of the implementation variant.
-
-
-
+
+ Common base class for axes. false + Common base class for all axes. falseSpecialization without overflow/underflow bins. intReturns the number of bins, excluding overflow/underflow. intReturns the number of bins, including overflow/underflow. boolReturns whether axis has extra overflow and underflow bins. -const std::string &Returns the axis label, which is a name or description. -voidconst std::string &Change the label of an axis. +string_viewReturns the axis label, which is a name or description. +voidstring_viewChange the label of an axis. boolconst axis_base & -unsignedstd::string +unsignedstring_view const axis_base & axis_base &const axis_base & @@ -31,17 +28,17 @@ Archive &unsigned true + trueSpecialization with overflow/underflow bins. intReturns the number of bins, excluding overflow/underflow. intReturns the number of bins, including overflow/underflow. boolReturns whether axis has extra overflow and underflow bins. -const std::string &Returns the axis label, which is a name or description. -voidconst std::string &Change the label of an axis. +string_viewReturns the axis label, which is a name or description. +voidstring_viewChange the label of an axis. boolconst axis_base & -unsignedstd::stringbool +unsignedstring_viewbool const axis_base & axis_base &const axis_base & @@ -75,71 +72,71 @@ int Value -boost::histogram::axis_base< false >boost::operators< category_axis >An axis for enumerated categories. The axis stores the category labels, and expects that they are addressed using an integer from 0 to n-1. There are no underflow/overflow bins for this axis. Binning is a O(1) operation. BOOST_HISTOGRAM_STRING_VIEW -axis_iterator< category_axis > +boost::histogram::axis::axis_base< false >boost::operators< category >An axis for enumerated categories. The axis stores the category labels, and expects that they are addressed using an integer from 0 to n-1. There are no underflow/overflow bins for this axis. Binning is a O(1) operation. string_view +axis_iterator< category > intintReturns the bin index for the passed argument. Performs a range check. value_typeintReturns the category for the bin index. -boolconst category_axis & +boolconst category & const_iterator const_iterator IteratorIteratorconst std::string &std::string() -const std::initializer_list< std::string > &sequence of labeled categories. const std::string &std::string()Construct from a list of strings. + IteratorIteratorstring_viewstring_view() +const std::initializer_list< std::string > &sequence of labeled categories. string_viewstring_view()Construct from a list of strings. -const category_axis & -category_axis &const category_axis & -category_axis && -category_axis &category_axis && +const category & +category &const category & +category && +category &category && voidArchive &unsigned -boost::histogram::axis::axis_base< false >boost::operators< regular< RealType > >Axis for real-valued angles. The axis is circular and wraps around reaching the perimeter value. Therefore, there are no overflow/underflow bins for this axis. Binning is a O(1) operation. RealType +axis_iterator< circular > intvalue_typeReturns the bin index for the passed argument. value_typeintReturns the starting edge of the bin. -boolconst circular_axis & +boolconst circular & value_type value_type const_iterator const_iterator -unsignednumber of bins. value_type0.0starting phase. value_typemath::double_constants::two_pirange after which value wraps around. const std::string &std::string()description of the axis. Constructor for n bins with an optional offset. +unsignednumber of bins. value_type0.0starting phase. value_typemath::double_constants::two_pirange after which value wraps around. string_viewstring_view()description of the axis. Constructor for n bins with an optional offset. -const circular_axis & -circular_axis &const circular_axis & -circular_axis && -circular_axis &circular_axis && +const circular & +circular &const circular & +circular && +circular &circular && voidArchive &unsigned -boost::histogram::axis_base< true >boost::operators< integer_axis >An axis for a contiguous range of integers. Binning is a O(1) operation. This axis operates faster than a regular_axis. int -axis_iterator< integer_axis > +boost::histogram::axis::axis_base< true >boost::operators< integer >An axis for a contiguous range of integers. Binning is a O(1) operation. This axis operates faster than a regular. int +axis_iterator< integer > intvalue_typeReturns the bin index for the passed argument. value_typeintReturns the integer that is mapped to the bin index. -boolconst integer_axis & +boolconst integer & const_iterator const_iterator -value_typesmallest integer of the covered range. value_typelargest integer of the covered range. const std::string &std::string()booltrueConstruct axis over integer range [min, max]. +value_typesmallest integer of the covered range. value_typelargest integer of the covered range. string_viewstring_view()booltrueConstruct axis over integer range [min, max]. -const integer_axis & -integer_axis &const integer_axis & -integer_axis && -integer_axis &integer_axis && +const integer & +integer &const integer & +integer && +integer &integer && voidint Value Value -boost::histogram::axis::axis_base< true >boost::operators< regular< RealType, Transform > >Axis for binning real-valued data into equidistant bins. The simplest and common binning strategy. Very fast. Binning is a O(1) operation. RealType +axis_iterator< regular > intvalue_typeReturns the bin index for the passed argument. value_typeintReturns the starting edge of the bin. -boolconst regular_axis & +boolconst regular & const_iterator const_iterator -unsignednumber of bins. value_typelow edge of first bin. value_typehigh edge of last bin. const std::string &std::string()description of the axis. booltruewhether to add under-/overflow bins. Construct axis with n bins over range [min, max). +unsignednumber of bins. value_typelow edge of first bin. value_typehigh edge of last bin. string_viewstring_view()description of the axis. booltruewhether to add under-/overflow bins. Construct axis with n bins over range [min, max). -const regular_axis & -regular_axis &const regular_axis & -regular_axis && -regular_axis &regular_axis && +const regular & +regular &const regular & +regular && +regular &regular && voidArchive &unsigned -boost::histogram::axis::axis_base< true >boost::operators< variable< RealType > >An axis for real-valued data and bins of varying width. Binning is a O(log(N)) operation. If speed matters and the problem domain allows it, prefer a regular. RealType +axis_iterator< variable > intvalue_typeReturns the bin index for the passed argument. value_typeintReturns the starting edge of the bin. -boolconst variable_axis & +boolconst variable & const_iterator const_iterator -const std::initializer_list< value_type > &sequence of bin edges. const std::string &std::string()description of the axis. booltruewhether to add under-/overflow bins. Construct an axis from bin edges. +const std::initializer_list< value_type > &sequence of bin edges. string_viewstring_view()description of the axis. booltruewhether to add under-/overflow bins. Construct an axis from bin edges. IteratorIteratorconst std::string &std::string()booltrue + IteratorIteratorstring_viewstring_view()booltrue -const variable_axis & -variable_axis &const variable_axis & -variable_axis && -variable_axis &variable_axis && +const variable & +variable &const variable & +variable && +variable &variable && voidstd::ostream &const regular< RealType > & std::ostream &std::ostream &const circular_axis< RealType > & + std::ostream &const circular< RealType > & std::ostream &std::ostream &const variable_axis< RealType > & -std::ostream &std::ostream &const integer_axis & -std::ostream &std::ostream &const category_axis & + std::ostream &const variable< RealType > & +std::ostream &std::ostream &const integer & +std::ostream &std::ostream &const category & + + + + @@ -288,10 +293,48 @@
+
+
-mpl::int_< 0 >const Args &... voidmpl::false_const Args &... + mpl::int_< 1 >const Args &... +voidmpl::int_< 2 >const Args &... +voidstd::size_t &std::size_t & voidstd::size_t &std::size_t &const First &const Rest &... -voidstd::size_t &std::size_t &X &const count &const Rest &... voidstd::size_t &std::size_t &Iterator +histogramconst std::vector< bool > & voidArchive &unsigned - - - unspecifiedAxes &&... @@ -497,6 +558,7 @@ + @@ -510,7 +572,15 @@ StaticAxesStoragetypename Storage::value_type + StaticAxesStoragestd::vector< unsigned >::iterator + +voidconst Axis & + +typename fusion::result_of::size< Axes >::type +typename fusion::result_of::as_vector< Axes >::type +typename Storage::value_type boolmpl::int_< N >Get N-th axis. constexpr std::add_const< typename fusion::result_of::value_at_c< axes_type, 0 >::type >::type & voidconst Axis &... +axes_type && mpl::int_< 0 >const Args &... voidmpl::true_const Args &... + mpl::int_< 1 >const Args &... +voidmpl::int_< 2 >const Args &... +voidstd::size_t &std::size_t & voidstd::size_t &std::size_t &const First &const Rest &... -voidstd::size_t &std::size_t &X &const count &const Rest &... +voidH &const std::vector< bool > & voidArchive &unsigned @@ -608,16 +695,14 @@ - - - -histogram< Static, mpl::vector< Axes... > >Axes &&...default static type factory -histogram< Static, mpl::vector< Axes... >, Storage >Axis &&...static type factory with variable storage type + @@ -647,9 +732,6 @@ - - - std::ostream &Archive &array_storage< Container > &unsigned + @@ -743,135 +829,67 @@
-static_visitor< void >const std::size_t & -const Value & -buffer_type & + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +T -voidArray & -voidarray< void > & -voidarray< mp_int > & -voidarray< weight > & - -const std::size_t &const Value &buffer_type & -static_visitor< void >const std::size_t & -const Value & -buffer_type & - -voidArray & -voidarray< void > & -voidarray< mp_int > & -voidarray< weight > & - -const std::size_t &const Value &buffer_type & -static_visitor< bool > -boolconst Array1 &const Array2 & -boolconst Array &const array< void > & -boolconst array< void > &const Array & -boolconst array< void > &const array< void > & - -static_visitor< bool >const S & - -boolconst Array & -boolconst array< mp_int > & -boolconst array< weight > & -boolconst array< void > & - -const S & -static_visitor< void >const std::size_t & -buffer_type & - -voidArray & -voidarray< void > & -voidarray< mp_int > & -voidarray< weight > & - -const std::size_t &buffer_type & -static_visitor< std::size_t > -std::size_tconst Array & - -static_visitor< value_type >const std::size_t & - -value_typeconst Array & -value_typeconst array< void > & -value_typeconst array< weight > & - -const std::size_t & -static_visitor< value_type >const std::size_t & - -value_typeconst Array & -value_typeconst array< void > & -value_typeconst array< weight > & - -const std::size_t & -static_visitor< void >const std::size_t & -const value_type & -buffer_type & - -voidArray & -voidarray< void > & -voidarray< weight > & - -const std::size_t &const value_type &buffer_type & -double - -std::size_t -voidstd::size_t -voidstd::size_tvalue_type -value_typestd::size_t -value_typestd::size_t -adaptive_storage &const S & -boolconst adaptive_storage & -boolconst S & +std::size_t +voidstd::size_t +voidstd::size_tconst Value & +voidstd::size_tconst value_type &const value_type & +value_typestd::size_t +value_typestd::size_t std::size_t -const adaptive_storage & -adaptive_storage &const adaptive_storage & -adaptive_storage && -adaptive_storage &adaptive_storage && +const array_storage & +array_storage &const array_storage & +array_storage && +array_storage &array_storage && const S & -adaptive_storage &const S & +array_storage &const S & + const S & +voidstd::size_t +voidstd::size_t voidArchive &unsigned @@ -897,81 +915,47 @@ + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + boolconst S &const adaptive_storage< Allocator > & - - - - - - -
-
- - -typename Container::value_type - -std::size_t -voidstd::size_t -voidstd::size_tvalue_type -value_typestd::size_t -voidconst OtherStorage & -boolconst container_storage< C > & - -std::size_t - -const container_storage & -container_storage &const container_storage & -container_storage && -container_storage &container_storage && -const OtherStorage & -container_storage &const OtherStorage & - -voidArchive &unsigned - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + detail::is_storage<S1> + detail::is_storage<S2> + const S1 &const S2 & +boolconst S1 &const S2 &
@@ -986,9 +970,6 @@ - - - intconst A & @@ -1021,13 +1002,14 @@ doubleconst boost::variant< Axes... > &const int -A::value_type