accumulator.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_MATH_HISTOGRAM_ACCUMULATOR_H_
#define GENESIS_UTILS_MATH_HISTOGRAM_ACCUMULATOR_H_

/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2019 Lucas Czech and HITS gGmbH

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/

#include <map>
#include <utility>
#include <vector>

namespace genesis {
namespace utils {

// =================================================================================================
//     Forward Declarations
// =================================================================================================

class Histogram;

// =================================================================================================
//     Histogram Accumulator
// =================================================================================================

class HistogramAccumulator
{
    // -------------------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------------------

public:

    typedef std::map<double, double>::const_iterator const_iterator;

    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------

    HistogramAccumulator () {}

    explicit HistogramAccumulator (const std::vector<double>& values, double weight = 1.0);

    explicit HistogramAccumulator (const std::vector<std::pair<double,double>>& weighted_values);

    ~HistogramAccumulator() = default;

    HistogramAccumulator(HistogramAccumulator const&) = default;
    HistogramAccumulator(HistogramAccumulator&&)      = default;

    HistogramAccumulator& operator= (HistogramAccumulator const&) = default;
    HistogramAccumulator& operator= (HistogramAccumulator&&)      = default;

    void swap (HistogramAccumulator& other);

    // -------------------------------------------------------------------------
    //     Accessors
    // -------------------------------------------------------------------------

    const_iterator begin() const;

    const_iterator end() const;

    // -------------------------------------------------------------------------
    //     Modifiers
    // -------------------------------------------------------------------------

    void clear();

    void increment (double x);

    void accumulate (double x, double weight);

    // -------------------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------------------

    double min() const;

    double max() const;

    size_t size() const;

    bool empty() const;

    size_t added_values() const;

    // -------------------------------------------------------------------------
    //     Factory Methods
    // -------------------------------------------------------------------------

    Histogram build_uniform_ranges_histogram (
        size_t num_bins,
        bool   integer_ranges = false
    ) const;

    Histogram build_uniform_ranges_histogram (
        size_t num_bins,
        double min,
        double max
    ) const;

    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------

private:

    std::map<double, double> values_;
    size_t                   added_values_ = 0;
};

// =================================================================================================
//     Basic Operators
// =================================================================================================

inline void swap( HistogramAccumulator& lhs, HistogramAccumulator& rhs )
{
    lhs.swap(rhs);
}

} // namespace utils
} // namespace genesis

#endif // include guard