IAxis.h

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Base/Axis/IAxis.h
//! @brief     Defines interface IAxis.
//!
//! @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)
//
//  ************************************************************************************************

#ifndef USER_API
#ifndef BORNAGAIN_BASE_AXIS_IAXIS_H
#define BORNAGAIN_BASE_AXIS_IAXIS_H

#include <string>
#include <utility>
#include <vector>

class Bin1D;

//! Abstract base class for one-dimensional axes.

class IAxis {
public:
    IAxis(std::string name)
        : m_name(std::move(name))
    {
    }
    IAxis(const IAxis&) = delete;
    virtual ~IAxis();

    virtual IAxis* clone() const = 0;

    //! Sets the axis label
    void setAxisName(std::string name) { m_name = name; }

    //! Returns the number of bins
    virtual size_t size() const = 0;

    //! Returns value of first point of axis
    virtual double lowerBound() const = 0;

    //! Returns value of last point of axis
    virtual double upperBound() const = 0;

    //! Returns lower and upper bound in a pair.
    //! first is lower, second is upper.
    std::pair<double, double> bounds() const;

    //! Returns distance from first to last point
    double span() const;

    //! Returns midpoint of axis
    double center() const;

    //! Returns the label of the axis
    std::string axisName() const { return m_name; }

    virtual std::vector<double> binCenters() const;

    virtual std::vector<double> binBoundaries() const;

    //! indexed accessor retrieves a sample
    virtual double operator[](size_t index) const = 0;

    //! retrieve a 1d bin for the given index
    virtual Bin1D bin(size_t index) const = 0;

    virtual double binCenter(size_t index) const = 0;

    //! find bin index which is best match for given value
    virtual size_t findClosestIndex(double value) const = 0;

    //! Returns true if axis contains given point
    virtual bool contains(double value) const;

    //! Clips this axis to the given values
    virtual void clip(double lower, double upper);

    //! Convenience overload to clip this axis to the given values.
    //! bounds.first is lower, bounds.second is upper value.
    void clip(std::pair<double, double> bounds);

    //! test for equality
    bool operator==(const IAxis& right) const { return equals(right); }
    bool operator!=(const IAxis& right) const { return !(*this == right); }

    friend std::ostream& operator<<(std::ostream& ostr, const IAxis& m)
    {
        m.print(ostr);
        return ostr;
    }

protected:
    virtual void print(std::ostream& ostr) const = 0;
    virtual bool equals(const IAxis& other) const; // overloaded in child classes

private:
    std::string m_name; //!< axis name
};

#endif // BORNAGAIN_BASE_AXIS_IAXIS_H
#endif // USER_API