| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185 |
- // (C) Copyright Nick Thompson 2018.
- // (C) Copyright Matt Borland 2020.
- // Use, modification and distribution are subject to 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)
- #ifndef BOOST_MATH_STATISTICS_UNIVARIATE_STATISTICS_HPP
- #define BOOST_MATH_STATISTICS_UNIVARIATE_STATISTICS_HPP
- #include <boost/math/statistics/detail/single_pass.hpp>
- #include <boost/math/tools/config.hpp>
- #include <boost/math/tools/assert.hpp>
- #include <algorithm>
- #include <iterator>
- #include <tuple>
- #include <cmath>
- #include <vector>
- #include <type_traits>
- #include <utility>
- #include <numeric>
- #include <list>
- #ifdef BOOST_MATH_EXEC_COMPATIBLE
- #include <execution>
- namespace boost::math::statistics {
- template<class ExecutionPolicy, class ForwardIterator>
- inline auto mean(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- using Real = typename std::iterator_traits<ForwardIterator>::value_type;
- BOOST_MATH_ASSERT_MSG(first != last, "At least one sample is required to compute the mean.");
- if constexpr (std::is_integral_v<Real>)
- {
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- return detail::mean_sequential_impl<double>(first, last);
- }
- else
- {
- return std::reduce(exec, first, last, 0.0) / std::distance(first, last);
- }
- }
- else
- {
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- return detail::mean_sequential_impl<Real>(first, last);
- }
- else
- {
- return std::reduce(exec, first, last, Real(0.0)) / Real(std::distance(first, last));
- }
- }
- }
- template<class ExecutionPolicy, class Container>
- inline auto mean(ExecutionPolicy&& exec, Container const & v)
- {
- return mean(exec, std::cbegin(v), std::cend(v));
- }
- template<class ForwardIterator>
- inline auto mean(ForwardIterator first, ForwardIterator last)
- {
- return mean(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto mean(Container const & v)
- {
- return mean(std::execution::seq, std::cbegin(v), std::cend(v));
- }
- template<class ExecutionPolicy, class ForwardIterator>
- inline auto variance(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- using Real = typename std::iterator_traits<ForwardIterator>::value_type;
- if constexpr (std::is_integral_v<Real>)
- {
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- return std::get<2>(detail::variance_sequential_impl<std::tuple<double, double, double, double>>(first, last));
- }
- else
- {
- const auto results = detail::first_four_moments_parallel_impl<std::tuple<double, double, double, double, double>>(first, last);
- return std::get<1>(results) / std::get<4>(results);
- }
- }
- else
- {
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- return std::get<2>(detail::variance_sequential_impl<std::tuple<Real, Real, Real, Real>>(first, last));
- }
- else
- {
- const auto results = detail::first_four_moments_parallel_impl<std::tuple<Real, Real, Real, Real, Real>>(first, last);
- return std::get<1>(results) / std::get<4>(results);
- }
- }
- }
- template<class ExecutionPolicy, class Container>
- inline auto variance(ExecutionPolicy&& exec, Container const & v)
- {
- return variance(exec, std::cbegin(v), std::cend(v));
- }
- template<class ForwardIterator>
- inline auto variance(ForwardIterator first, ForwardIterator last)
- {
- return variance(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto variance(Container const & v)
- {
- return variance(std::execution::seq, std::cbegin(v), std::cend(v));
- }
- template<class ExecutionPolicy, class ForwardIterator>
- inline auto sample_variance(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- const auto n = std::distance(first, last);
- BOOST_MATH_ASSERT_MSG(n > 1, "At least two samples are required to compute the sample variance.");
- return n*variance(exec, first, last)/(n-1);
- }
- template<class ExecutionPolicy, class Container>
- inline auto sample_variance(ExecutionPolicy&& exec, Container const & v)
- {
- return sample_variance(exec, std::cbegin(v), std::cend(v));
- }
- template<class ForwardIterator>
- inline auto sample_variance(ForwardIterator first, ForwardIterator last)
- {
- return sample_variance(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto sample_variance(Container const & v)
- {
- return sample_variance(std::execution::seq, std::cbegin(v), std::cend(v));
- }
- template<class ExecutionPolicy, class ForwardIterator>
- inline auto mean_and_sample_variance(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- using Real = typename std::iterator_traits<ForwardIterator>::value_type;
- if constexpr (std::is_integral_v<Real>)
- {
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- const auto results = detail::variance_sequential_impl<std::tuple<double, double, double, double>>(first, last);
- return std::make_pair(std::get<0>(results), std::get<2>(results)*std::get<3>(results)/(std::get<3>(results)-1.0));
- }
- else
- {
- const auto results = detail::first_four_moments_parallel_impl<std::tuple<double, double, double, double, double>>(first, last);
- return std::make_pair(std::get<0>(results), std::get<1>(results) / (std::get<4>(results)-1.0));
- }
- }
- else
- {
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- const auto results = detail::variance_sequential_impl<std::tuple<Real, Real, Real, Real>>(first, last);
- return std::make_pair(std::get<0>(results), std::get<2>(results)*std::get<3>(results)/(std::get<3>(results)-Real(1)));
- }
- else
- {
- const auto results = detail::first_four_moments_parallel_impl<std::tuple<Real, Real, Real, Real, Real>>(first, last);
- return std::make_pair(std::get<0>(results), std::get<1>(results) / (std::get<4>(results)-Real(1)));
- }
- }
- }
- template<class ExecutionPolicy, class Container>
- inline auto mean_and_sample_variance(ExecutionPolicy&& exec, Container const & v)
- {
- return mean_and_sample_variance(exec, std::cbegin(v), std::cend(v));
- }
- template<class ForwardIterator>
- inline auto mean_and_sample_variance(ForwardIterator first, ForwardIterator last)
- {
- return mean_and_sample_variance(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto mean_and_sample_variance(Container const & v)
- {
- return mean_and_sample_variance(std::execution::seq, std::cbegin(v), std::cend(v));
- }
- template<class ExecutionPolicy, class ForwardIterator>
- inline auto first_four_moments(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- using Real = typename std::iterator_traits<ForwardIterator>::value_type;
- if constexpr (std::is_integral_v<Real>)
- {
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- const auto results = detail::first_four_moments_sequential_impl<std::tuple<double, double, double, double, double>>(first, last);
- return std::make_tuple(std::get<0>(results), std::get<1>(results) / std::get<4>(results), std::get<2>(results) / std::get<4>(results),
- std::get<3>(results) / std::get<4>(results));
- }
- else
- {
- const auto results = detail::first_four_moments_parallel_impl<std::tuple<double, double, double, double, double>>(first, last);
- return std::make_tuple(std::get<0>(results), std::get<1>(results) / std::get<4>(results), std::get<2>(results) / std::get<4>(results),
- std::get<3>(results) / std::get<4>(results));
- }
- }
- else
- {
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- const auto results = detail::first_four_moments_sequential_impl<std::tuple<Real, Real, Real, Real, Real>>(first, last);
- return std::make_tuple(std::get<0>(results), std::get<1>(results) / std::get<4>(results), std::get<2>(results) / std::get<4>(results),
- std::get<3>(results) / std::get<4>(results));
- }
- else
- {
- const auto results = detail::first_four_moments_parallel_impl<std::tuple<Real, Real, Real, Real, Real>>(first, last);
- return std::make_tuple(std::get<0>(results), std::get<1>(results) / std::get<4>(results), std::get<2>(results) / std::get<4>(results),
- std::get<3>(results) / std::get<4>(results));
- }
- }
- }
- template<class ExecutionPolicy, class Container>
- inline auto first_four_moments(ExecutionPolicy&& exec, Container const & v)
- {
- return first_four_moments(exec, std::cbegin(v), std::cend(v));
- }
- template<class ForwardIterator>
- inline auto first_four_moments(ForwardIterator first, ForwardIterator last)
- {
- return first_four_moments(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto first_four_moments(Container const & v)
- {
- return first_four_moments(std::execution::seq, std::cbegin(v), std::cend(v));
- }
- // https://prod.sandia.gov/techlib-noauth/access-control.cgi/2008/086212.pdf
- template<class ExecutionPolicy, class ForwardIterator>
- inline auto skewness(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- using Real = typename std::iterator_traits<ForwardIterator>::value_type;
- using std::sqrt;
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- if constexpr (std::is_integral_v<Real>)
- {
- return detail::skewness_sequential_impl<double>(first, last);
- }
- else
- {
- return detail::skewness_sequential_impl<Real>(first, last);
- }
- }
- else
- {
- const auto [M1, M2, M3, M4] = first_four_moments(exec, first, last);
- const auto n = std::distance(first, last);
- const auto var = M2/(n-1);
- if (M2 == 0)
- {
- // The limit is technically undefined, but the interpretation here is clear:
- // A constant dataset has no skewness.
- if constexpr (std::is_integral_v<Real>)
- {
- return static_cast<double>(0);
- }
- else
- {
- return Real(0);
- }
- }
- else
- {
- return M3/(M2*sqrt(var)) / Real(2);
- }
- }
- }
- template<class ExecutionPolicy, class Container>
- inline auto skewness(ExecutionPolicy&& exec, Container & v)
- {
- return skewness(exec, std::cbegin(v), std::cend(v));
- }
- template<class ForwardIterator>
- inline auto skewness(ForwardIterator first, ForwardIterator last)
- {
- return skewness(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto skewness(Container const & v)
- {
- return skewness(std::execution::seq, std::cbegin(v), std::cend(v));
- }
- // Follows equation 1.6 of:
- // https://prod.sandia.gov/techlib-noauth/access-control.cgi/2008/086212.pdf
- template<class ExecutionPolicy, class ForwardIterator>
- inline auto kurtosis(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- const auto [M1, M2, M3, M4] = first_four_moments(exec, first, last);
- if (M2 == 0)
- {
- return M2;
- }
- return M4/(M2*M2);
- }
- template<class ExecutionPolicy, class Container>
- inline auto kurtosis(ExecutionPolicy&& exec, Container const & v)
- {
- return kurtosis(exec, std::cbegin(v), std::cend(v));
- }
- template<class ForwardIterator>
- inline auto kurtosis(ForwardIterator first, ForwardIterator last)
- {
- return kurtosis(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto kurtosis(Container const & v)
- {
- return kurtosis(std::execution::seq, std::cbegin(v), std::cend(v));
- }
- template<class ExecutionPolicy, class ForwardIterator>
- inline auto excess_kurtosis(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- return kurtosis(exec, first, last) - 3;
- }
- template<class ExecutionPolicy, class Container>
- inline auto excess_kurtosis(ExecutionPolicy&& exec, Container const & v)
- {
- return excess_kurtosis(exec, std::cbegin(v), std::cend(v));
- }
- template<class ForwardIterator>
- inline auto excess_kurtosis(ForwardIterator first, ForwardIterator last)
- {
- return excess_kurtosis(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto excess_kurtosis(Container const & v)
- {
- return excess_kurtosis(std::execution::seq, std::cbegin(v), std::cend(v));
- }
- template<class ExecutionPolicy, class RandomAccessIterator>
- auto median(ExecutionPolicy&& exec, RandomAccessIterator first, RandomAccessIterator last)
- {
- const auto num_elems = std::distance(first, last);
- BOOST_MATH_ASSERT_MSG(num_elems > 0, "The median of a zero length vector is undefined.");
- if (num_elems & 1)
- {
- auto middle = first + (num_elems - 1)/2;
- std::nth_element(exec, first, middle, last);
- return *middle;
- }
- else
- {
- auto middle = first + num_elems/2 - 1;
- std::nth_element(exec, first, middle, last);
- std::nth_element(exec, middle, middle+1, last);
- return (*middle + *(middle+1))/2;
- }
- }
- template<class ExecutionPolicy, class RandomAccessContainer>
- inline auto median(ExecutionPolicy&& exec, RandomAccessContainer & v)
- {
- return median(exec, std::begin(v), std::end(v));
- }
- template<class RandomAccessIterator>
- inline auto median(RandomAccessIterator first, RandomAccessIterator last)
- {
- return median(std::execution::seq, first, last);
- }
- template<class RandomAccessContainer>
- inline auto median(RandomAccessContainer & v)
- {
- return median(std::execution::seq, std::begin(v), std::end(v));
- }
- #if 0
- //
- // Parallel gini calculation is curently broken, see:
- // https://github.com/boostorg/math/issues/585
- // We will fix this at a later date, for now just use a serial implementation:
- //
- template<class ExecutionPolicy, class RandomAccessIterator>
- inline auto gini_coefficient(ExecutionPolicy&& exec, RandomAccessIterator first, RandomAccessIterator last)
- {
- using Real = typename std::iterator_traits<RandomAccessIterator>::value_type;
- if(!std::is_sorted(exec, first, last))
- {
- std::sort(exec, first, last);
- }
- if constexpr (std::is_same_v<std::remove_reference_t<decltype(exec)>, decltype(std::execution::seq)>)
- {
- if constexpr (std::is_integral_v<Real>)
- {
- return detail::gini_coefficient_sequential_impl<double>(first, last);
- }
- else
- {
- return detail::gini_coefficient_sequential_impl<Real>(first, last);
- }
- }
- else if constexpr (std::is_integral_v<Real>)
- {
- return detail::gini_coefficient_parallel_impl<double>(exec, first, last);
- }
- else
- {
- return detail::gini_coefficient_parallel_impl<Real>(exec, first, last);
- }
- }
- #else
- template<class ExecutionPolicy, class RandomAccessIterator>
- inline auto gini_coefficient(ExecutionPolicy&& exec, RandomAccessIterator first, RandomAccessIterator last)
- {
- using Real = typename std::iterator_traits<RandomAccessIterator>::value_type;
- if (!std::is_sorted(exec, first, last))
- {
- std::sort(exec, first, last);
- }
- if constexpr (std::is_integral_v<Real>)
- {
- return detail::gini_coefficient_sequential_impl<double>(first, last);
- }
- else
- {
- return detail::gini_coefficient_sequential_impl<Real>(first, last);
- }
- }
- #endif
- template<class ExecutionPolicy, class RandomAccessContainer>
- inline auto gini_coefficient(ExecutionPolicy&& exec, RandomAccessContainer & v)
- {
- return gini_coefficient(exec, std::begin(v), std::end(v));
- }
- template<class RandomAccessIterator>
- inline auto gini_coefficient(RandomAccessIterator first, RandomAccessIterator last)
- {
- return gini_coefficient(std::execution::seq, first, last);
- }
- template<class RandomAccessContainer>
- inline auto gini_coefficient(RandomAccessContainer & v)
- {
- return gini_coefficient(std::execution::seq, std::begin(v), std::end(v));
- }
- template<class ExecutionPolicy, class RandomAccessIterator>
- inline auto sample_gini_coefficient(ExecutionPolicy&& exec, RandomAccessIterator first, RandomAccessIterator last)
- {
- const auto n = std::distance(first, last);
- return n*gini_coefficient(exec, first, last)/(n-1);
- }
- template<class ExecutionPolicy, class RandomAccessContainer>
- inline auto sample_gini_coefficient(ExecutionPolicy&& exec, RandomAccessContainer & v)
- {
- return sample_gini_coefficient(exec, std::begin(v), std::end(v));
- }
- template<class RandomAccessIterator>
- inline auto sample_gini_coefficient(RandomAccessIterator first, RandomAccessIterator last)
- {
- return sample_gini_coefficient(std::execution::seq, first, last);
- }
- template<class RandomAccessContainer>
- inline auto sample_gini_coefficient(RandomAccessContainer & v)
- {
- return sample_gini_coefficient(std::execution::seq, std::begin(v), std::end(v));
- }
- template<class ExecutionPolicy, class RandomAccessIterator>
- auto median_absolute_deviation(ExecutionPolicy&& exec, RandomAccessIterator first, RandomAccessIterator last,
- typename std::iterator_traits<RandomAccessIterator>::value_type center=std::numeric_limits<typename std::iterator_traits<RandomAccessIterator>::value_type>::quiet_NaN())
- {
- using std::abs;
- using Real = typename std::iterator_traits<RandomAccessIterator>::value_type;
- using std::isnan;
- if (isnan(center))
- {
- center = boost::math::statistics::median(exec, first, last);
- }
- const auto num_elems = std::distance(first, last);
- BOOST_MATH_ASSERT_MSG(num_elems > 0, "The median of a zero-length vector is undefined.");
- auto comparator = [¢er](Real a, Real b) { return abs(a-center) < abs(b-center);};
- if (num_elems & 1)
- {
- auto middle = first + (num_elems - 1)/2;
- std::nth_element(exec, first, middle, last, comparator);
- return abs(*middle-center);
- }
- else
- {
- auto middle = first + num_elems/2 - 1;
- std::nth_element(exec, first, middle, last, comparator);
- std::nth_element(exec, middle, middle+1, last, comparator);
- return (abs(*middle-center) + abs(*(middle+1)-center))/abs(static_cast<Real>(2));
- }
- }
- template<class ExecutionPolicy, class RandomAccessContainer>
- inline auto median_absolute_deviation(ExecutionPolicy&& exec, RandomAccessContainer & v,
- typename RandomAccessContainer::value_type center=std::numeric_limits<typename RandomAccessContainer::value_type>::quiet_NaN())
- {
- return median_absolute_deviation(exec, std::begin(v), std::end(v), center);
- }
- template<class RandomAccessIterator>
- inline auto median_absolute_deviation(RandomAccessIterator first, RandomAccessIterator last,
- typename RandomAccessIterator::value_type center=std::numeric_limits<typename RandomAccessIterator::value_type>::quiet_NaN())
- {
- return median_absolute_deviation(std::execution::seq, first, last, center);
- }
- template<class RandomAccessContainer>
- inline auto median_absolute_deviation(RandomAccessContainer & v,
- typename RandomAccessContainer::value_type center=std::numeric_limits<typename RandomAccessContainer::value_type>::quiet_NaN())
- {
- return median_absolute_deviation(std::execution::seq, std::begin(v), std::end(v), center);
- }
- template<class ExecutionPolicy, class ForwardIterator>
- auto interquartile_range(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- using Real = typename std::iterator_traits<ForwardIterator>::value_type;
- static_assert(!std::is_integral_v<Real>, "Integer values have not yet been implemented.");
- auto m = std::distance(first,last);
- BOOST_MATH_ASSERT_MSG(m >= 3, "At least 3 samples are required to compute the interquartile range.");
- auto k = m/4;
- auto j = m - (4*k);
- // m = 4k+j.
- // If j = 0 or j = 1, then there are an even number of samples below the median, and an even number above the median.
- // Then we must average adjacent elements to get the quartiles.
- // If j = 2 or j = 3, there are an odd number of samples above and below the median, these elements may be directly extracted to get the quartiles.
- if (j==2 || j==3)
- {
- auto q1 = first + k;
- auto q3 = first + 3*k + j - 1;
- std::nth_element(exec, first, q1, last);
- Real Q1 = *q1;
- std::nth_element(exec, q1, q3, last);
- Real Q3 = *q3;
- return Q3 - Q1;
- } else {
- // j == 0 or j==1:
- auto q1 = first + k - 1;
- auto q3 = first + 3*k - 1 + j;
- std::nth_element(exec, first, q1, last);
- Real a = *q1;
- std::nth_element(exec, q1, q1 + 1, last);
- Real b = *(q1 + 1);
- Real Q1 = (a+b)/2;
- std::nth_element(exec, q1, q3, last);
- a = *q3;
- std::nth_element(exec, q3, q3 + 1, last);
- b = *(q3 + 1);
- Real Q3 = (a+b)/2;
- return Q3 - Q1;
- }
- }
- template<class ExecutionPolicy, class RandomAccessContainer>
- inline auto interquartile_range(ExecutionPolicy&& exec, RandomAccessContainer & v)
- {
- return interquartile_range(exec, std::begin(v), std::end(v));
- }
- template<class RandomAccessIterator>
- inline auto interquartile_range(RandomAccessIterator first, RandomAccessIterator last)
- {
- return interquartile_range(std::execution::seq, first, last);
- }
- template<class RandomAccessContainer>
- inline auto interquartile_range(RandomAccessContainer & v)
- {
- return interquartile_range(std::execution::seq, std::begin(v), std::end(v));
- }
- template<class ExecutionPolicy, class ForwardIterator, class OutputIterator>
- inline OutputIterator mode(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last, OutputIterator output)
- {
- if(!std::is_sorted(exec, first, last))
- {
- if constexpr (std::is_same_v<typename std::iterator_traits<ForwardIterator>::iterator_category(), std::random_access_iterator_tag>)
- {
- std::sort(exec, first, last);
- }
- else
- {
- BOOST_MATH_ASSERT("Data must be sorted for sequential mode calculation");
- }
- }
- return detail::mode_impl(first, last, output);
- }
- template<class ExecutionPolicy, class Container, class OutputIterator>
- inline OutputIterator mode(ExecutionPolicy&& exec, Container & v, OutputIterator output)
- {
- return mode(exec, std::begin(v), std::end(v), output);
- }
- template<class ForwardIterator, class OutputIterator>
- inline OutputIterator mode(ForwardIterator first, ForwardIterator last, OutputIterator output)
- {
- return mode(std::execution::seq, first, last, output);
- }
- // Requires enable_if_t to not clash with impl that returns std::list
- // Very ugly. std::is_execution_policy_v returns false for the std::execution objects and decltype of the objects (e.g. std::execution::seq)
- template<class Container, class OutputIterator, std::enable_if_t<!std::is_convertible_v<std::execution::sequenced_policy, Container> &&
- !std::is_convertible_v<std::execution::parallel_unsequenced_policy, Container> &&
- !std::is_convertible_v<std::execution::parallel_policy, Container>
- #if __cpp_lib_execution > 201900
- && !std::is_convertible_v<std::execution::unsequenced_policy, Container>
- #endif
- , bool> = true>
- inline OutputIterator mode(Container & v, OutputIterator output)
- {
- return mode(std::execution::seq, std::begin(v), std::end(v), output);
- }
- // std::list is the return type for the proposed STL stats library
- template<class ExecutionPolicy, class ForwardIterator, class Real = typename std::iterator_traits<ForwardIterator>::value_type>
- inline auto mode(ExecutionPolicy&& exec, ForwardIterator first, ForwardIterator last)
- {
- std::list<Real> modes;
- mode(exec, first, last, std::inserter(modes, modes.begin()));
- return modes;
- }
- template<class ExecutionPolicy, class Container>
- inline auto mode(ExecutionPolicy&& exec, Container & v)
- {
- return mode(exec, std::begin(v), std::end(v));
- }
- template<class ForwardIterator>
- inline auto mode(ForwardIterator first, ForwardIterator last)
- {
- return mode(std::execution::seq, first, last);
- }
- template<class Container>
- inline auto mode(Container & v)
- {
- return mode(std::execution::seq, std::begin(v), std::end(v));
- }
- } // Namespace boost::math::statistics
- #else // Backwards compatible bindings for C++11 or execution is not implemented
- namespace boost { namespace math { namespace statistics {
- template<bool B, class T = void>
- using enable_if_t = typename std::enable_if<B, T>::type;
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double mean(const ForwardIterator first, const ForwardIterator last)
- {
- BOOST_MATH_ASSERT_MSG(first != last, "At least one sample is required to compute the mean.");
- return detail::mean_sequential_impl<double>(first, last);
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double mean(const Container& c)
- {
- return mean(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real mean(const ForwardIterator first, const ForwardIterator last)
- {
- BOOST_MATH_ASSERT_MSG(first != last, "At least one sample is required to compute the mean.");
- return detail::mean_sequential_impl<Real>(first, last);
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real mean(const Container& c)
- {
- return mean(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double variance(const ForwardIterator first, const ForwardIterator last)
- {
- return std::get<2>(detail::variance_sequential_impl<std::tuple<double, double, double, double>>(first, last));
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double variance(const Container& c)
- {
- return variance(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real variance(const ForwardIterator first, const ForwardIterator last)
- {
- return std::get<2>(detail::variance_sequential_impl<std::tuple<Real, Real, Real, Real>>(first, last));
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real variance(const Container& c)
- {
- return variance(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double sample_variance(const ForwardIterator first, const ForwardIterator last)
- {
- const auto n = std::distance(first, last);
- BOOST_MATH_ASSERT_MSG(n > 1, "At least two samples are required to compute the sample variance.");
- return n*variance(first, last)/(n-1);
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double sample_variance(const Container& c)
- {
- return sample_variance(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real sample_variance(const ForwardIterator first, const ForwardIterator last)
- {
- const auto n = std::distance(first, last);
- BOOST_MATH_ASSERT_MSG(n > 1, "At least two samples are required to compute the sample variance.");
- return n*variance(first, last)/(n-1);
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real sample_variance(const Container& c)
- {
- return sample_variance(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline std::pair<double, double> mean_and_sample_variance(const ForwardIterator first, const ForwardIterator last)
- {
- const auto results = detail::variance_sequential_impl<std::tuple<double, double, double, double>>(first, last);
- return std::make_pair(std::get<0>(results), std::get<3>(results)*std::get<2>(results)/(std::get<3>(results)-1.0));
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline std::pair<double, double> mean_and_sample_variance(const Container& c)
- {
- return mean_and_sample_variance(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline std::pair<Real, Real> mean_and_sample_variance(const ForwardIterator first, const ForwardIterator last)
- {
- const auto results = detail::variance_sequential_impl<std::tuple<Real, Real, Real, Real>>(first, last);
- return std::make_pair(std::get<0>(results), std::get<3>(results)*std::get<2>(results)/(std::get<3>(results)-Real(1)));
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline std::pair<Real, Real> mean_and_sample_variance(const Container& c)
- {
- return mean_and_sample_variance(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline std::tuple<double, double, double, double> first_four_moments(const ForwardIterator first, const ForwardIterator last)
- {
- const auto results = detail::first_four_moments_sequential_impl<std::tuple<double, double, double, double, double>>(first, last);
- return std::make_tuple(std::get<0>(results), std::get<1>(results) / std::get<4>(results), std::get<2>(results) / std::get<4>(results),
- std::get<3>(results) / std::get<4>(results));
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline std::tuple<double, double, double, double> first_four_moments(const Container& c)
- {
- return first_four_moments(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline std::tuple<Real, Real, Real, Real> first_four_moments(const ForwardIterator first, const ForwardIterator last)
- {
- const auto results = detail::first_four_moments_sequential_impl<std::tuple<Real, Real, Real, Real, Real>>(first, last);
- return std::make_tuple(std::get<0>(results), std::get<1>(results) / std::get<4>(results), std::get<2>(results) / std::get<4>(results),
- std::get<3>(results) / std::get<4>(results));
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline std::tuple<Real, Real, Real, Real> first_four_moments(const Container& c)
- {
- return first_four_moments(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double skewness(const ForwardIterator first, const ForwardIterator last)
- {
- return detail::skewness_sequential_impl<double>(first, last);
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double skewness(const Container& c)
- {
- return skewness(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real skewness(const ForwardIterator first, const ForwardIterator last)
- {
- return detail::skewness_sequential_impl<Real>(first, last);
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real skewness(const Container& c)
- {
- return skewness(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double kurtosis(const ForwardIterator first, const ForwardIterator last)
- {
- std::tuple<double, double, double, double> M = first_four_moments(first, last);
- if(std::get<1>(M) == 0)
- {
- return std::get<1>(M);
- }
- else
- {
- return std::get<3>(M)/(std::get<1>(M)*std::get<1>(M));
- }
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double kurtosis(const Container& c)
- {
- return kurtosis(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real kurtosis(const ForwardIterator first, const ForwardIterator last)
- {
- std::tuple<Real, Real, Real, Real> M = first_four_moments(first, last);
- if(std::get<1>(M) == 0)
- {
- return std::get<1>(M);
- }
- else
- {
- return std::get<3>(M)/(std::get<1>(M)*std::get<1>(M));
- }
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real kurtosis(const Container& c)
- {
- return kurtosis(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double excess_kurtosis(const ForwardIterator first, const ForwardIterator last)
- {
- return kurtosis(first, last) - 3;
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double excess_kurtosis(const Container& c)
- {
- return excess_kurtosis(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real excess_kurtosis(const ForwardIterator first, const ForwardIterator last)
- {
- return kurtosis(first, last) - 3;
- }
- template<class Container, typename Real = typename Container::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real excess_kurtosis(const Container& c)
- {
- return excess_kurtosis(std::begin(c), std::end(c));
- }
- template<class RandomAccessIterator, typename Real = typename std::iterator_traits<RandomAccessIterator>::value_type>
- Real median(RandomAccessIterator first, RandomAccessIterator last)
- {
- const auto num_elems = std::distance(first, last);
- BOOST_MATH_ASSERT_MSG(num_elems > 0, "The median of a zero length vector is undefined.");
- if (num_elems & 1)
- {
- auto middle = first + (num_elems - 1)/2;
- std::nth_element(first, middle, last);
- return *middle;
- }
- else
- {
- auto middle = first + num_elems/2 - 1;
- std::nth_element(first, middle, last);
- std::nth_element(middle, middle+1, last);
- return (*middle + *(middle+1))/2;
- }
- }
- template<class RandomAccessContainer, typename Real = typename RandomAccessContainer::value_type>
- inline Real median(RandomAccessContainer& c)
- {
- return median(std::begin(c), std::end(c));
- }
- template<class RandomAccessIterator, typename Real = typename std::iterator_traits<RandomAccessIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double gini_coefficient(RandomAccessIterator first, RandomAccessIterator last)
- {
- if(!std::is_sorted(first, last))
- {
- std::sort(first, last);
- }
- return detail::gini_coefficient_sequential_impl<double>(first, last);
- }
- template<class RandomAccessContainer, typename Real = typename RandomAccessContainer::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double gini_coefficient(RandomAccessContainer& c)
- {
- return gini_coefficient(std::begin(c), std::end(c));
- }
- template<class RandomAccessIterator, typename Real = typename std::iterator_traits<RandomAccessIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real gini_coefficient(RandomAccessIterator first, RandomAccessIterator last)
- {
- if(!std::is_sorted(first, last))
- {
- std::sort(first, last);
- }
- return detail::gini_coefficient_sequential_impl<Real>(first, last);
- }
- template<class RandomAccessContainer, typename Real = typename RandomAccessContainer::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real gini_coefficient(RandomAccessContainer& c)
- {
- return gini_coefficient(std::begin(c), std::end(c));
- }
- template<class RandomAccessIterator, typename Real = typename std::iterator_traits<RandomAccessIterator>::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double sample_gini_coefficient(RandomAccessIterator first, RandomAccessIterator last)
- {
- const auto n = std::distance(first, last);
- return n*gini_coefficient(first, last)/(n-1);
- }
- template<class RandomAccessContainer, typename Real = typename RandomAccessContainer::value_type,
- enable_if_t<std::is_integral<Real>::value, bool> = true>
- inline double sample_gini_coefficient(RandomAccessContainer& c)
- {
- return sample_gini_coefficient(std::begin(c), std::end(c));
- }
- template<class RandomAccessIterator, typename Real = typename std::iterator_traits<RandomAccessIterator>::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real sample_gini_coefficient(RandomAccessIterator first, RandomAccessIterator last)
- {
- const auto n = std::distance(first, last);
- return n*gini_coefficient(first, last)/(n-1);
- }
- template<class RandomAccessContainer, typename Real = typename RandomAccessContainer::value_type,
- enable_if_t<!std::is_integral<Real>::value, bool> = true>
- inline Real sample_gini_coefficient(RandomAccessContainer& c)
- {
- return sample_gini_coefficient(std::begin(c), std::end(c));
- }
- template<class RandomAccessIterator, typename Real = typename std::iterator_traits<RandomAccessIterator>::value_type>
- Real median_absolute_deviation(RandomAccessIterator first, RandomAccessIterator last,
- typename std::iterator_traits<RandomAccessIterator>::value_type center=std::numeric_limits<typename std::iterator_traits<RandomAccessIterator>::value_type>::quiet_NaN())
- {
- using std::abs;
- using std::isnan;
- if (isnan(center))
- {
- center = boost::math::statistics::median(first, last);
- }
- const auto num_elems = std::distance(first, last);
- BOOST_MATH_ASSERT_MSG(num_elems > 0, "The median of a zero-length vector is undefined.");
- auto comparator = [¢er](Real a, Real b) { return abs(a-center) < abs(b-center);};
- if (num_elems & 1)
- {
- auto middle = first + (num_elems - 1)/2;
- std::nth_element(first, middle, last, comparator);
- return abs(*middle-center);
- }
- else
- {
- auto middle = first + num_elems/2 - 1;
- std::nth_element(first, middle, last, comparator);
- std::nth_element(middle, middle+1, last, comparator);
- return (abs(*middle-center) + abs(*(middle+1)-center))/abs(static_cast<Real>(2));
- }
- }
- template<class RandomAccessContainer, typename Real = typename RandomAccessContainer::value_type>
- inline Real median_absolute_deviation(RandomAccessContainer& c,
- typename RandomAccessContainer::value_type center=std::numeric_limits<typename RandomAccessContainer::value_type>::quiet_NaN())
- {
- return median_absolute_deviation(std::begin(c), std::end(c), center);
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type>
- Real interquartile_range(ForwardIterator first, ForwardIterator last)
- {
- static_assert(!std::is_integral<Real>::value, "Integer values have not yet been implemented.");
- auto m = std::distance(first,last);
- BOOST_MATH_ASSERT_MSG(m >= 3, "At least 3 samples are required to compute the interquartile range.");
- auto k = m/4;
- auto j = m - (4*k);
- // m = 4k+j.
- // If j = 0 or j = 1, then there are an even number of samples below the median, and an even number above the median.
- // Then we must average adjacent elements to get the quartiles.
- // If j = 2 or j = 3, there are an odd number of samples above and below the median, these elements may be directly extracted to get the quartiles.
- if (j==2 || j==3)
- {
- auto q1 = first + k;
- auto q3 = first + 3*k + j - 1;
- std::nth_element(first, q1, last);
- Real Q1 = *q1;
- std::nth_element(q1, q3, last);
- Real Q3 = *q3;
- return Q3 - Q1;
- }
- else
- {
- // j == 0 or j==1:
- auto q1 = first + k - 1;
- auto q3 = first + 3*k - 1 + j;
- std::nth_element(first, q1, last);
- Real a = *q1;
- std::nth_element(q1, q1 + 1, last);
- Real b = *(q1 + 1);
- Real Q1 = (a+b)/2;
- std::nth_element(q1, q3, last);
- a = *q3;
- std::nth_element(q3, q3 + 1, last);
- b = *(q3 + 1);
- Real Q3 = (a+b)/2;
- return Q3 - Q1;
- }
- }
- template<class Container, typename Real = typename Container::value_type>
- Real interquartile_range(Container& c)
- {
- return interquartile_range(std::begin(c), std::end(c));
- }
- template<class ForwardIterator, class OutputIterator,
- enable_if_t<std::is_same<typename std::iterator_traits<ForwardIterator>::iterator_category(), std::random_access_iterator_tag>::value, bool> = true>
- inline OutputIterator mode(ForwardIterator first, ForwardIterator last, OutputIterator output)
- {
- if(!std::is_sorted(first, last))
- {
- std::sort(first, last);
- }
- return detail::mode_impl(first, last, output);
- }
- template<class ForwardIterator, class OutputIterator,
- enable_if_t<!std::is_same<typename std::iterator_traits<ForwardIterator>::iterator_category(), std::random_access_iterator_tag>::value, bool> = true>
- inline OutputIterator mode(ForwardIterator first, ForwardIterator last, OutputIterator output)
- {
- if(!std::is_sorted(first, last))
- {
- BOOST_MATH_ASSERT("Data must be sorted for mode calculation");
- }
- return detail::mode_impl(first, last, output);
- }
- template<class Container, class OutputIterator>
- inline OutputIterator mode(Container& c, OutputIterator output)
- {
- return mode(std::begin(c), std::end(c), output);
- }
- template<class ForwardIterator, typename Real = typename std::iterator_traits<ForwardIterator>::value_type>
- inline std::list<Real> mode(ForwardIterator first, ForwardIterator last)
- {
- std::list<Real> modes;
- mode(first, last, std::inserter(modes, modes.begin()));
- return modes;
- }
- template<class Container, typename Real = typename Container::value_type>
- inline std::list<Real> mode(Container& c)
- {
- return mode(std::begin(c), std::end(c));
- }
- }}}
- #endif
- #endif // BOOST_MATH_STATISTICS_UNIVARIATE_STATISTICS_HPP
|