AttLimits.h

Go to the documentation of this file.

// ************************************************************************** //
//
//  BornAgain: simulate and fit scattering at grazing incidence
//
//! @file      Fit/Tools/AttLimits.h
//! @brief     Defines and implements class AttLimits.
//!
//! @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 BORNAGAIN_FIT_TOOLS_ATTLIMITS_H
#define BORNAGAIN_FIT_TOOLS_ATTLIMITS_H
 
#include "Fit/Tools/Attributes.h"
#include "Fit/Tools/RealLimits.h"
#include <string>
 
//! Attributes and limits of a fit parameter, and coupling between these properties.
//! @ingroup fitting
 
class AttLimits
{
public:
    AttLimits();
 
    static AttLimits limitless();
    static AttLimits lowerLimited(double bound_value);
    static AttLimits positive();
    static AttLimits nonnegative();
    static AttLimits upperLimited(double bound_value);
    static AttLimits limited(double left_bound_value, double right_bound_value);
    static AttLimits fixed();
 
    bool isFixed() const;
    bool isLimited() const;
    bool isUpperLimited() const;
    bool isLowerLimited() const;
    bool isLimitless() const;
 
    double lowerLimit() const;
    double upperLimit() const;
 
    void setFixed(bool isFixed);
 
    bool operator==(const AttLimits& other) const;
    bool operator!=(const AttLimits& other) const;
 
    std::string toString() const;
 
    friend std::ostream& operator<<(std::ostream& ostr, const AttLimits& m)
    {
        ostr << m.toString();
        return ostr;
    }
 
private:
    AttLimits(const RealLimits& limits, const Attributes& fixedAttr);
 
    RealLimits m_limits;
    Attributes m_att_fixed;
};
 
#endif // BORNAGAIN_FIT_TOOLS_ATTLIMITS_H