histogram.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_MATH_HISTOGRAM_H_
#define GENESIS_UTILS_MATH_HISTOGRAM_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2021 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 <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include <cstddef>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
class Histogram;
bool equal_ranges( Histogram const& lhs, Histogram const& rhs );
void swap( Histogram& lhs, Histogram& rhs );
 
// =================================================================================================
//     Histogram
// =================================================================================================
 
class Histogram
{
    // -------------------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------------------
 
public:
 
    enum class OutOfRangeBehaviour {
        kSqueeze,
        kIgnore,
        kThrow
    };
 
    typedef std::vector<double>::iterator       iterator;
    typedef std::vector<double>::const_iterator const_iterator;
 
    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------
 
    Histogram() = default;
 
    explicit Histogram(
        size_t num_bins
    );
 
    Histogram(
        size_t num_bins,
        double range_min,
        double range_max
    );
 
    explicit Histogram(
        const std::vector<double>& ranges
    );
 
    ~Histogram() = default;
 
    Histogram(Histogram const&) = default;
    Histogram(Histogram&&)      = default;
 
    Histogram& operator= (Histogram const&) = default;
    Histogram& operator= (Histogram&&)      = default;
 
    friend void swap( Histogram& lhs, Histogram& rhs );
 
    // -------------------------------------------------------------------------
    //     General Methods
    // -------------------------------------------------------------------------
 
    void set_ranges( const std::vector<double>& ranges );
 
    void set_uniform_ranges( const double min, const double max );
 
    void clear();
 
    OutOfRangeBehaviour out_of_range_behaviour() const;
 
    void                out_of_range_behaviour( OutOfRangeBehaviour v );
 
    // -------------------------------------------------------------------------
    //     Comparison
    // -------------------------------------------------------------------------
 
    bool operator== ( Histogram const& rhs );
 
    friend bool equal_ranges (Histogram const& lhs, Histogram const& rhs);
 
    // -------------------------------------------------------------------------
    //     Bin Access
    // -------------------------------------------------------------------------
 
    double& at( size_t bin_num );
 
    double at( size_t bin_num ) const;
 
    double& operator [] ( size_t bin_num );
 
    double operator [] ( size_t bin_num ) const;
 
    // -------------------------------------------------------------------------
    //     Bin Iterators
    // -------------------------------------------------------------------------
 
    iterator begin();
 
    iterator end();
 
    const_iterator begin() const;
 
    const_iterator end() const;
 
    const_iterator cbegin() const;
 
    const_iterator cend() const;
 
    // -------------------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------------------
 
    size_t bins() const;
 
    std::pair<double, double> bin_range( size_t bin_num ) const;
 
    double bin_midpoint( size_t bin_num ) const;
 
    double bin_width( size_t bin_num ) const;
 
    long find_bin( double x ) const;
 
    double range_min() const;
 
    double range_max() const;
 
    bool check_range( double x ) const;
 
    // -------------------------------------------------------------------------
    //     Modifiers
    // -------------------------------------------------------------------------
 
    long increment( double x );
 
    long accumulate( double x, double weight );
 
    void increment_bin( size_t bin );
 
    void accumulate_bin( size_t bin, double weight );
 
    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------
 
private:
 
    std::vector<double> bins_;
    std::vector<double> ranges_;
 
    OutOfRangeBehaviour out_of_range_behaviour_ = OutOfRangeBehaviour::kThrow;
};
 
} // namespace utils
} // namespace genesis
 
#endif // include guard