AttLimits.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Fit/Param/AttLimits.cpp
//! @brief     Implements 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)
//
//  ************************************************************************************************
 
#include "Fit/Param/AttLimits.h"
#include <iomanip>
#include <sstream>
 
AttLimits::AttLimits()
    : m_limits(RealLimits::limitless())
    , m_att_fixed(Attributes::free())
{
}
 
AttLimits::AttLimits(const RealLimits& limits, const Attributes& fixedAttr)
    : m_limits(limits)
    , m_att_fixed(fixedAttr)
{
}
 
AttLimits AttLimits::limitless()
{
    return AttLimits();
}
 
AttLimits AttLimits::lowerLimited(double bound_value)
{
    return AttLimits(RealLimits::lowerLimited(bound_value), Attributes::free());
}
 
AttLimits AttLimits::positive()
{
    return AttLimits(RealLimits::positive(), Attributes::free());
}
 
AttLimits AttLimits::nonnegative()
{
    return AttLimits(RealLimits::nonnegative(), Attributes::free());
}
 
AttLimits AttLimits::upperLimited(double bound_value)
{
    return AttLimits(RealLimits::upperLimited(bound_value), Attributes::free());
}
 
AttLimits AttLimits::limited(double left_bound_value, double right_bound_value)
{
    return AttLimits(RealLimits::limited(left_bound_value, right_bound_value), Attributes::free());
}
 
AttLimits AttLimits::fixed()
{
    return AttLimits(RealLimits::limitless(), Attributes::fixed());
}
 
bool AttLimits::isFixed() const
{
    return m_att_fixed.isFixed();
}
 
bool AttLimits::isLimited() const
{
    return m_att_fixed.isFree() && m_limits.hasLowerAndUpperLimits();
}
 
bool AttLimits::isUpperLimited() const
{
    return m_att_fixed.isFree() && !m_limits.hasLowerLimit() && m_limits.hasUpperLimit();
}
 
bool AttLimits::isLowerLimited() const
{
    return m_att_fixed.isFree() && m_limits.hasLowerLimit() && !m_limits.hasUpperLimit();
}
 
bool AttLimits::isLimitless() const
{
    return m_att_fixed.isFree() && !m_limits.hasLowerLimit() && !m_limits.hasUpperLimit();
}
 
double AttLimits::lowerLimit() const
{
    return m_limits.lowerLimit();
}
 
double AttLimits::upperLimit() const
{
    return m_limits.upperLimit();
}
 
void AttLimits::setFixed(bool isFixed)
{
    m_limits.removeLimits();
    m_att_fixed.setFixed(isFixed);
}
 
bool AttLimits::operator==(const AttLimits& other) const
{
    return m_limits == other.m_limits && m_att_fixed == other.m_att_fixed;
}
 
bool AttLimits::operator!=(const AttLimits& other) const
{
    return !(*this == other);
}
 
std::string AttLimits::toString() const
{
    std::ostringstream result;
 
    if (isFixed())
        result << "fixed";
    else if (isLimitless())
        result << "free";
    else if (isLowerLimited())
        result << "lowerLimited(" << std::scientific << std::setprecision(2) << lowerLimit() << ")";
    else if (isUpperLimited())
        result << "upperLimited(" << std::scientific << std::setprecision(2) << upperLimit() << ")";
    else if (isLimited())
        result << "limited(" << std::scientific << std::setprecision(2) << lowerLimit() << ","
               << std::scientific << std::setprecision(2) << upperLimit() << ")";
 
    return result.str();
}