mirror of
https://github.com/boostorg/histogram.git
synced 2025-05-09 23:04:07 +00:00
10c19df918
* Added fraction accumulator * Added binomial proportion interval computers: Wald, Wilson Score, Clopper Pearson, Jeffreys * Width of intervals for all classes can be set via deviation or confidence_level * Support valarray in histogram::fill * Add fraction and count to user guide Co-authored-by: Hans Dembinski <hans.dembinski@gmail.com> Co-authored-by: Hans Dembinski <HDembinski@users.noreply.github.com>
382 lines
19 KiB
C++
382 lines
19 KiB
C++
// Copyright 2019 Przemyslaw Bartosik
|
|
// Copyright 2019 Hans Dembinski
|
|
//
|
|
// Distributed under the Boost Software License, Version 1.0.
|
|
// (See accompanying file LICENSE_1_0.txt
|
|
// or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
|
|
#include <boost/core/lightweight_test.hpp>
|
|
#include <boost/histogram/accumulators/count.hpp>
|
|
#include <boost/histogram/accumulators/mean.hpp>
|
|
#include <boost/histogram/accumulators/ostream.hpp>
|
|
#include <boost/histogram/accumulators/sum.hpp>
|
|
#include <boost/histogram/accumulators/weighted_sum.hpp>
|
|
#include <boost/histogram/axis/category.hpp>
|
|
#include <boost/histogram/axis/integer.hpp>
|
|
#include <boost/histogram/axis/option.hpp>
|
|
#include <boost/histogram/axis/regular.hpp>
|
|
#include <boost/histogram/make_histogram.hpp>
|
|
#include <boost/histogram/ostream.hpp>
|
|
#include <limits>
|
|
#include <sstream>
|
|
#include <string>
|
|
#include "histogram.hpp"
|
|
#include "throw_exception.hpp"
|
|
|
|
using namespace boost::histogram;
|
|
|
|
template <class Histogram>
|
|
auto str(const Histogram& h, const unsigned width = 0) {
|
|
std::ostringstream os;
|
|
// BEGIN and END make nicer error messages
|
|
os << "BEGIN\n" << std::setw(width) << h << "END";
|
|
return os.str();
|
|
}
|
|
|
|
template <class Tag>
|
|
void run_tests() {
|
|
using R = axis::regular<>;
|
|
using R2 =
|
|
axis::regular<double, boost::use_default, axis::null_type, axis::option::none_t>;
|
|
using R3 = axis::regular<double, axis::transform::log>;
|
|
using C = axis::category<std::string>;
|
|
using I = axis::integer<>;
|
|
|
|
// regular
|
|
{
|
|
auto h = make(Tag(), R(3, -0.5, 1.0));
|
|
h.at(0) = 1;
|
|
h.at(1) = 10;
|
|
h.at(2) = 5;
|
|
|
|
const auto expected =
|
|
"BEGIN\n"
|
|
"histogram(regular(3, -0.5, 1, options=underflow | overflow))\n"
|
|
" ┌────────────────────────────────────────────────────────────┐\n"
|
|
"[-inf, -0.5) 0 │ │\n"
|
|
"[-0.5, 0) 1 │█████▉ │\n"
|
|
"[ 0, 0.5) 10 │███████████████████████████████████████████████████████████ │\n"
|
|
"[ 0.5, 1) 5 │█████████████████████████████▌ │\n"
|
|
"[ 1, inf) 0 │ │\n"
|
|
" └────────────────────────────────────────────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected);
|
|
}
|
|
|
|
// regular, narrow
|
|
{
|
|
auto h = make(Tag(), R2(3, -0.5, 1.0));
|
|
h.at(0) = 1;
|
|
h.at(1) = 10;
|
|
h.at(2) = 5;
|
|
|
|
const auto expected = "BEGIN\n"
|
|
"histogram(regular(3, -0.5, 1, options=none))\n"
|
|
" ┌───────────────────────┐\n"
|
|
"[-0.5, 0) 1 │██▎ │\n"
|
|
"[ 0, 0.5) 10 │██████████████████████ │\n"
|
|
"[ 0.5, 1) 5 │███████████ │\n"
|
|
" └───────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h, 40).c_str(), expected);
|
|
|
|
// too narrow
|
|
BOOST_TEST_CSTR_EQ(str(h, 10).c_str(),
|
|
"BEGIN\n"
|
|
"histogram(regular(3, -0.5, 1, options=none))END");
|
|
}
|
|
|
|
// regular with accumulators::count
|
|
{
|
|
auto h =
|
|
make_s(Tag(), dense_storage<accumulators::count<double>>(), R2(3, -0.5, 1.0));
|
|
h.at(0) = 1;
|
|
h.at(1) = 10;
|
|
h.at(2) = 5;
|
|
|
|
const auto expected = "BEGIN\n"
|
|
"histogram(regular(3, -0.5, 1, options=none))\n"
|
|
" ┌───────────────────────┐\n"
|
|
"[-0.5, 0) 1 │██▎ │\n"
|
|
"[ 0, 0.5) 10 │██████████████████████ │\n"
|
|
"[ 0.5, 1) 5 │███████████ │\n"
|
|
" └───────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h, 40).c_str(), expected);
|
|
}
|
|
|
|
// regular with thread-safe accumulators::count
|
|
{
|
|
auto h = make_s(Tag(), dense_storage<accumulators::count<double, true>>(),
|
|
R2(3, -0.5, 1.0));
|
|
h.at(0) = 1;
|
|
h.at(1) = 10;
|
|
h.at(2) = 5;
|
|
|
|
const auto expected = "BEGIN\n"
|
|
"histogram(regular(3, -0.5, 1, options=none))\n"
|
|
" ┌───────────────────────┐\n"
|
|
"[-0.5, 0) 1 │██▎ │\n"
|
|
"[ 0, 0.5) 10 │██████████████████████ │\n"
|
|
"[ 0.5, 1) 5 │███████████ │\n"
|
|
" └───────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h, 40).c_str(), expected);
|
|
}
|
|
|
|
// regular with accumulators::sum
|
|
{
|
|
auto h = make_s(Tag(), dense_storage<accumulators::sum<double>>(), R2(3, -0.5, 1.0));
|
|
h.at(0) = 1;
|
|
h.at(1) = 10;
|
|
h.at(2) = 5;
|
|
|
|
const auto expected = "BEGIN\n"
|
|
"histogram(regular(3, -0.5, 1, options=none))\n"
|
|
" ┌───────────────────────┐\n"
|
|
"[-0.5, 0) 1 │██▎ │\n"
|
|
"[ 0, 0.5) 10 │██████████████████████ │\n"
|
|
"[ 0.5, 1) 5 │███████████ │\n"
|
|
" └───────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h, 40).c_str(), expected);
|
|
}
|
|
|
|
// regular with accumulators::weighted_sum
|
|
{
|
|
auto h = make_s(Tag(), dense_storage<accumulators::weighted_sum<double>>(),
|
|
R2(3, -0.5, 1.0));
|
|
h.at(0) = 1;
|
|
h.at(1) = 10;
|
|
h.at(2) = 5;
|
|
|
|
const auto expected = "BEGIN\n"
|
|
"histogram(regular(3, -0.5, 1, options=none))\n"
|
|
" ┌───────────────────────┐\n"
|
|
"[-0.5, 0) 1 │██▎ │\n"
|
|
"[ 0, 0.5) 10 │██████████████████████ │\n"
|
|
"[ 0.5, 1) 5 │███████████ │\n"
|
|
" └───────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h, 40).c_str(), expected);
|
|
}
|
|
|
|
// regular2
|
|
{
|
|
auto h = make(Tag(), R2(3, -0.5, 1.0));
|
|
h.at(0) = 1;
|
|
h.at(1) = -5;
|
|
h.at(2) = 2;
|
|
|
|
const auto expected =
|
|
"BEGIN\n"
|
|
"histogram(regular(3, -0.5, 1, options=none))\n"
|
|
" ┌─────────────────────────────────────────────────────────────┐\n"
|
|
"[-0.5, 0) 1 │ ████████▋ │\n"
|
|
"[ 0, 0.5) -5 │███████████████████████████████████████████ │\n"
|
|
"[ 0.5, 1) 2 │ █████████████████▏│\n"
|
|
" └─────────────────────────────────────────────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected);
|
|
}
|
|
|
|
// regular with log
|
|
{
|
|
auto h = make(Tag(), R3(6, 1e-3, 1e3, "foo"));
|
|
|
|
const auto expected =
|
|
"BEGIN\n"
|
|
"histogram(regular(transform::log{}, 6, 0.001, 1000, metadata=\"foo\", "
|
|
"options=underflow | overflow))\n"
|
|
" ┌───────────────────────────────────────────────────────────┐\n"
|
|
"[ 0, 0.001) 0 │ │\n"
|
|
"[0.001, 0.01) 0 │ │\n"
|
|
"[ 0.01, 0.1) 0 │ │\n"
|
|
"[ 0.1, 1) 0 │ │\n"
|
|
"[ 1, 10) 0 │ │\n"
|
|
"[ 10, 100) 0 │ │\n"
|
|
"[ 100, 1000) 0 │ │\n"
|
|
"[ 1000, inf) 0 │ │\n"
|
|
" └───────────────────────────────────────────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected);
|
|
}
|
|
|
|
// subsampling
|
|
{
|
|
auto h = make(Tag(), I(-8, 9));
|
|
for (int i = -8; i < 9; ++i) h.at(i + 8) = i;
|
|
|
|
const auto expected = "BEGIN\n"
|
|
"histogram(integer(-8, 9, options=underflow | overflow))\n"
|
|
" ┌───┐\n"
|
|
"-9 0 │ │\n"
|
|
"-8 -8 │█ │\n"
|
|
"-7 -7 │█ │\n"
|
|
"-6 -6 │█ │\n"
|
|
"-5 -5 │█ │\n"
|
|
"-4 -4 │█ │\n"
|
|
"-3 -3 │ │\n"
|
|
"-2 -2 │ │\n"
|
|
"-1 -1 │ │\n"
|
|
" 0 0 │ │\n"
|
|
" 1 1 │ ▏ │\n"
|
|
" 2 2 │ ▎ │\n"
|
|
" 3 3 │ ▍ │\n"
|
|
" 4 4 │ ▌ │\n"
|
|
" 5 5 │ ▋ │\n"
|
|
" 6 6 │ ▊ │\n"
|
|
" 7 7 │ ▉ │\n"
|
|
" 8 8 │ █ │\n"
|
|
" 9 0 │ │\n"
|
|
" └───┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h, 11).c_str(), expected);
|
|
}
|
|
|
|
// integer
|
|
{
|
|
auto h = make(Tag(), I(-8, 9));
|
|
for (int i = -8; i < 9; ++i) h.at(i + 8) = i;
|
|
|
|
const auto expected =
|
|
"BEGIN\n"
|
|
"histogram(integer(-8, 9, options=underflow | overflow))\n"
|
|
" ┌──────────────────────────────────────────────────────────────────────┐\n"
|
|
"-9 0 │ │\n"
|
|
"-8 -8 │███████████████████████████████████ │\n"
|
|
"-7 -7 │ ██████████████████████████████ │\n"
|
|
"-6 -6 │ ██████████████████████████ │\n"
|
|
"-5 -5 │ ██████████████████████ │\n"
|
|
"-4 -4 │ █████████████████ │\n"
|
|
"-3 -3 │ █████████████ │\n"
|
|
"-2 -2 │ █████████ │\n"
|
|
"-1 -1 │ ████ │\n"
|
|
" 0 0 │ │\n"
|
|
" 1 1 │ ████▍ │\n"
|
|
" 2 2 │ ████████▋ │\n"
|
|
" 3 3 │ ████████████▉ │\n"
|
|
" 4 4 │ █████████████████▎ │\n"
|
|
" 5 5 │ █████████████████████▌ │\n"
|
|
" 6 6 │ █████████████████████████▉ │\n"
|
|
" 7 7 │ ██████████████████████████████▎ │\n"
|
|
" 8 8 │ ██████████████████████████████████▌│\n"
|
|
" 9 0 │ │\n"
|
|
" └──────────────────────────────────────────────────────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected);
|
|
}
|
|
|
|
// category<string>
|
|
{
|
|
auto h = make(Tag(), C({"a", "bb", "ccc", "dddd"}));
|
|
h.at(0) = 1.23;
|
|
h.at(1) = 1;
|
|
h.at(2) = 1.2345789e-3;
|
|
h.at(3) = 1.2345789e-12;
|
|
h.at(4) = std::numeric_limits<double>::quiet_NaN();
|
|
|
|
const auto expected =
|
|
"BEGIN\n"
|
|
"histogram(category(\"a\", \"bb\", \"ccc\", \"dddd\", options=overflow))\n"
|
|
" ┌────────────────────────────────────────────────────────────┐\n"
|
|
" a 1.23 │███████████████████████████████████████████████████████████ │\n"
|
|
" bb 1 │████████████████████████████████████████████████ │\n"
|
|
" ccc 0.001235 │ │\n"
|
|
" dddd 1.235e-12 │ │\n"
|
|
"other nan │ │\n"
|
|
" └────────────────────────────────────────────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected);
|
|
}
|
|
|
|
// histogram with axis that has no value method
|
|
{
|
|
struct minimal_axis {
|
|
int index(int x) const { return x % 2; }
|
|
int size() const { return 2; }
|
|
};
|
|
|
|
auto h = make(Tag(), minimal_axis{});
|
|
h.at(0) = 3;
|
|
h.at(1) = 4;
|
|
|
|
const auto expected =
|
|
"BEGIN\n"
|
|
"histogram(" +
|
|
detail::type_name<minimal_axis>() +
|
|
")\n"
|
|
" ┌────────────────────────────────────────────────────────────────────────┐\n"
|
|
"0 3 │█████████████████████████████████████████████████████▎ │\n"
|
|
"1 4 │███████████████████████████████████████████████████████████████████████ │\n"
|
|
" └────────────────────────────────────────────────────────────────────────┘\n"
|
|
"END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected.c_str());
|
|
}
|
|
|
|
// fallback for 2D
|
|
{
|
|
auto h = make(Tag(), R(1, -1, 1), R(2, -4, 7));
|
|
h.at(-1, 0) = 1000;
|
|
h.at(-1, -1) = 123;
|
|
h.at(1, 0) = 1.23456789;
|
|
h.at(-1, 2) = std::numeric_limits<double>::quiet_NaN();
|
|
|
|
const auto expected =
|
|
"BEGIN\n"
|
|
"histogram(\n"
|
|
" regular(1, -1, 1, options=underflow | overflow)\n"
|
|
" regular(2, -4, 7, options=underflow | overflow)\n"
|
|
" (-1 -1): 123 ( 0 -1): 0 ( 1 -1): 0 (-1 0): 1000 \n"
|
|
" ( 0 0): 0 ( 1 0): 1.235 (-1 1): 0 ( 0 1): 0 \n"
|
|
" ( 1 1): 0 (-1 2): nan ( 0 2): 0 ( 1 2): 0 \n"
|
|
")END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected);
|
|
}
|
|
|
|
// fallback for profile
|
|
{
|
|
auto h = make_s(Tag(), profile_storage(), R(1, -1, 1));
|
|
h.at(0) = accumulators::mean<>(10, 100, 1000);
|
|
|
|
const auto expected = "BEGIN\n"
|
|
"histogram(\n"
|
|
" regular(1, -1, 1, options=underflow | overflow)\n"
|
|
" (-1): mean(0, 0, -0) ( 0): mean(10, 100, 1000)\n"
|
|
" ( 1): mean(0, 0, -0) \n"
|
|
")END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected);
|
|
}
|
|
}
|
|
|
|
int main() {
|
|
run_tests<static_tag>();
|
|
run_tests<dynamic_tag>();
|
|
|
|
{
|
|
// cannot make empty static histogram
|
|
auto h = histogram<std::vector<axis::regular<>>>();
|
|
|
|
const auto expected = "BEGIN\n"
|
|
"histogram()END";
|
|
|
|
BOOST_TEST_CSTR_EQ(str(h).c_str(), expected);
|
|
}
|
|
|
|
return boost::report_errors();
|
|
}
|