VariableBinAxis.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Base/Axis/VariableBinAxis.cpp
//! @brief     Implements VariableBinAxis class.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "Base/Axis/VariableBinAxis.h"
#include "Base/Axis/Bin.h"
#include "Base/Util/Algorithms.h"
#include <algorithm>
#include <iomanip>
 
VariableBinAxis::VariableBinAxis(const std::string& name, const std::vector<double>& bin_boundaries)
    : IAxis(name)
    , m_nbins(bin_boundaries.size() - 1)
{
    setBinBoundaries(bin_boundaries);
}
 
VariableBinAxis::VariableBinAxis(const std::string& name, size_t nbins)
    : IAxis(name)
    , m_nbins(nbins)
{
}
 
VariableBinAxis* VariableBinAxis::clone() const
{
    auto* result = new VariableBinAxis(axisName(), m_bin_boundaries);
    return result;
}
 
double VariableBinAxis::operator[](size_t index) const
{
    return bin(index).center();
}
 
Bin1D VariableBinAxis::bin(size_t index) const
{
    if (index >= m_nbins)
        throw std::runtime_error("VariableBinAxis::bin() -> Error. Wrong index.");
 
    Bin1D result(m_bin_boundaries[index], m_bin_boundaries[index + 1]);
    return result;
}
 
double VariableBinAxis::min() const
{
    return m_bin_boundaries.front();
}
 
double VariableBinAxis::max() const
{
    return m_bin_boundaries.back();
}
 
double VariableBinAxis::binCenter(size_t index) const
{
    return bin(index).center();
}
 
size_t VariableBinAxis::findClosestIndex(double value) const
{
    if (m_bin_boundaries.size() < 2)
        throw std::runtime_error("VariableBinAxis::findClosestIndex() -> Error! "
                                 "VariableBinAxis not  correctly initialized");
    if (value < min())
        return 0;
    if (value >= max())
        return m_nbins - 1;
 
    auto top_limit = std::lower_bound(m_bin_boundaries.begin(), m_bin_boundaries.end(), value);
    if (*top_limit != value)
        --top_limit;
    size_t nbin = top_limit - m_bin_boundaries.begin();
    return nbin;
}
 
std::vector<double> VariableBinAxis::binCenters() const
{
    std::vector<double> result;
    result.resize(size(), 0.0);
    for (size_t i = 0; i < size(); ++i)
        result[i] = bin(i).center();
    return result;
}
 
void VariableBinAxis::clip(double lower, double upper)
{
    if (lower >= upper)
        throw std::runtime_error("VariableBinAxis::clip() -> Error. "
                                 "'lower' should be smaller than 'upper'");
 
    if (lower < min())
        lower = bin(0).center();
    if (upper >= max())
        upper = bin(size() - 1).center();
 
    const size_t nbin1 = findClosestIndex(lower);
    const size_t nbin2 = findClosestIndex(upper);
    const size_t new_nbins = nbin2 - nbin1 + 1;
 
    std::vector<double> new_boundaries;
    for (size_t i = 0; i < new_nbins + 1; ++i)
        new_boundaries.push_back(m_bin_boundaries[nbin1 + i]);
 
    m_nbins = new_nbins;
    setBinBoundaries(new_boundaries);
}
 
void VariableBinAxis::print(std::ostream& ostr) const
{
    ostr << "VariableBinAxis(\"" << axisName() << "\", " << size() << ", [";
    for (size_t i = 0; i < m_bin_boundaries.size(); ++i) {
        ostr << std::setprecision(std::numeric_limits<double>::digits10 + 2) << m_bin_boundaries[i];
        if (i != m_bin_boundaries.size() - 1)
            ostr << ", ";
    }
    ostr << "])";
}
 
bool VariableBinAxis::equals(const IAxis& other) const
{
    if (!IAxis::equals(other))
        return false;
    if (const auto* p_other_cast = dynamic_cast<const VariableBinAxis*>(&other)) {
        if (size() != p_other_cast->size())
            return false;
        for (size_t i = 0; i < m_bin_boundaries.size(); ++i) {
            if (!BaseUtils::algo::almostEqual(m_bin_boundaries[i],
                                              p_other_cast->m_bin_boundaries[i]))
                return false;
        }
        return true;
    }
    return false;
}
 
void VariableBinAxis::setBinBoundaries(const std::vector<double>& bin_boundaries)
{
    // checking that values are sorted
    std::vector<double> vec_sorted = bin_boundaries;
    std::sort(vec_sorted.begin(), vec_sorted.end());
    for (size_t i = 0; i < bin_boundaries.size(); ++i) {
        if (vec_sorted[i] != bin_boundaries[i])
            throw std::runtime_error("VariableBinAxis::setBinBoundaries() -> Error. "
                                     "Array with bin edges is not sorted.");
    }
 
    std::vector<double> vec = bin_boundaries;
    vec.erase(std::unique(vec.begin(), vec.end()), vec.end());
 
    if (vec.size() != bin_boundaries.size())
        throw std::runtime_error("VariableBinAxis::setBinBoundaries() -> Error. "
                                 "Array with bin edges contains repeating values.");
 
    m_bin_boundaries = bin_boundaries;
}