fix doc example typo
[boost.git] / boost / accumulators / statistics / min.hpp
blobb386f2b0fe70fb215547687c3c290e901c70b61b
1 ///////////////////////////////////////////////////////////////////////////////
2 // min.hpp
3 //
4 // Copyright 2005 Eric Niebler. Distributed under the Boost
5 // Software License, Version 1.0. (See accompanying file
6 // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
8 #ifndef BOOST_ACCUMULATORS_STATISTICS_MIN_HPP_EAN_28_10_2005
9 #define BOOST_ACCUMULATORS_STATISTICS_MIN_HPP_EAN_28_10_2005
11 #include <limits>
12 #include <boost/mpl/placeholders.hpp>
13 #include <boost/accumulators/framework/accumulator_base.hpp>
14 #include <boost/accumulators/framework/extractor.hpp>
15 #include <boost/accumulators/framework/parameters/sample.hpp>
16 #include <boost/accumulators/numeric/functional.hpp>
17 #include <boost/accumulators/framework/depends_on.hpp>
18 #include <boost/accumulators/statistics_fwd.hpp>
20 namespace boost { namespace accumulators
23 namespace impl
25 ///////////////////////////////////////////////////////////////////////////////
26 // min_impl
27 template<typename Sample>
28 struct min_impl
29 : accumulator_base
31 // for boost::result_of
32 typedef Sample result_type;
34 template<typename Args>
35 min_impl(Args const &args)
36 : min_(numeric::as_max(args[sample | Sample()]))
40 template<typename Args>
41 void operator ()(Args const &args)
43 numeric::min_assign(this->min_, args[sample]);
46 result_type result(dont_care) const
48 return this->min_;
51 private:
52 Sample min_;
55 } // namespace impl
57 ///////////////////////////////////////////////////////////////////////////////
58 // tag::min
60 namespace tag
62 struct min
63 : depends_on<>
65 /// INTERNAL ONLY
66 ///
67 typedef accumulators::impl::min_impl<mpl::_1> impl;
71 ///////////////////////////////////////////////////////////////////////////////
72 // extract::min
74 namespace extract
76 extractor<tag::min> const min = {};
79 using extract::min;
81 }} // namespace boost::accumulators
83 #endif