AttLimits Class Reference

Attributes and limits of a fit parameter, and coupling between these properties. More...

Collaboration diagram for AttLimits:

Public Member Functions
	AttLimits ()
bool	isFixed () const
bool	isLimited () const
bool	isLimitless () const
bool	isLowerLimited () const
bool	isUpperLimited () const
double	lowerLimit () const
bool	operator!= (const AttLimits &other) const
bool	operator== (const AttLimits &other) const
void	setFixed (bool isFixed)
std::string	toString () const
double	upperLimit () const

Static Public Member Functions
static AttLimits	fixed ()
static AttLimits	limited (double left_bound_value, double right_bound_value)
static AttLimits	limitless ()
static AttLimits	lowerLimited (double bound_value)
static AttLimits	nonnegative ()
static AttLimits	positive ()
static AttLimits	upperLimited (double bound_value)

Private Member Functions
	AttLimits (const RealLimits &limits, const Attributes &fixedAttr)

Private Attributes
Attributes	m_att_fixed
RealLimits	m_limits

Friends
std::ostream &	operator<< (std::ostream &ostr, const AttLimits &m)

Detailed Description

Attributes and limits of a fit parameter, and coupling between these properties.

Definition at line 25 of file AttLimits.h.

Constructor & Destructor Documentation

AttLimits() [1/2]

AttLimits::AttLimits

(

)

Definition at line 19 of file AttLimits.cpp.

: m_limits(RealLimits::limitless()), m_att_fixed(Attributes::free()) {}

Referenced by fixed(), limited(), limitless(), lowerLimited(), nonnegative(), positive(), and upperLimited().

AttLimits() [2/2]

AttLimits::AttLimits ( const RealLimits &  limits, const Attributes &  fixedAttr  )

private

Definition at line 21 of file AttLimits.cpp.

    : m_limits(limits), m_att_fixed(fixedAttr)
{
}

Member Function Documentation

fixed()

AttLimits AttLimits::fixed ( )

static

Definition at line 56 of file AttLimits.cpp.

{
    return AttLimits(RealLimits::limitless(), Attributes::fixed());
}

References AttLimits(), Attributes::fixed(), and RealLimits::limitless().

Referenced by FitParameterItem::attLimits().

Here is the call graph for this function:

isFixed()

bool AttLimits::isFixed

(

)

const

Definition at line 61 of file AttLimits.cpp.

{
    return m_att_fixed.isFixed();
}

References Attributes::isFixed(), and m_att_fixed.

Referenced by setFixed(), MinimizerAdapter::setParameter(), GeneticMinimizer::setParameter(), and toString().

Here is the call graph for this function:

isLimited()

bool AttLimits::isLimited

(

)

const

Definition at line 66 of file AttLimits.cpp.

{
    return m_att_fixed.isFree() && m_limits.hasLowerAndUpperLimits();
}

References RealLimits::hasLowerAndUpperLimits(), Attributes::isFree(), m_att_fixed, and m_limits.

Referenced by MinimizerAdapter::setParameter(), GeneticMinimizer::setParameter(), and toString().

Here is the call graph for this function:

isLimitless()

bool AttLimits::isLimitless

(

)

const

Definition at line 81 of file AttLimits.cpp.

{
    return m_att_fixed.isFree() && !m_limits.hasLowerLimit() && !m_limits.hasUpperLimit();
}

References RealLimits::hasLowerLimit(), RealLimits::hasUpperLimit(), Attributes::isFree(), m_att_fixed, and m_limits.

Referenced by MinimizerAdapter::setParameter(), and toString().

Here is the call graph for this function:

isLowerLimited()

bool AttLimits::isLowerLimited

(

)

const

Definition at line 76 of file AttLimits.cpp.

{
    return m_att_fixed.isFree() && m_limits.hasLowerLimit() && !m_limits.hasUpperLimit();
}

References RealLimits::hasLowerLimit(), RealLimits::hasUpperLimit(), Attributes::isFree(), m_att_fixed, and m_limits.

Referenced by MinimizerAdapter::setParameter(), and toString().

Here is the call graph for this function:

isUpperLimited()

bool AttLimits::isUpperLimited

(

)

const

Definition at line 71 of file AttLimits.cpp.

{
    return m_att_fixed.isFree() && !m_limits.hasLowerLimit() && m_limits.hasUpperLimit();
}

References RealLimits::hasLowerLimit(), RealLimits::hasUpperLimit(), Attributes::isFree(), m_att_fixed, and m_limits.

Referenced by MinimizerAdapter::setParameter(), and toString().

Here is the call graph for this function:

limited()

AttLimits AttLimits::limited ( double  left_bound_value, double  right_bound_value  )

static

Definition at line 51 of file AttLimits.cpp.

{
    return AttLimits(RealLimits::limited(left_bound_value, right_bound_value), Attributes::free());
}

References AttLimits(), Attributes::free(), and RealLimits::limited().

Referenced by FitParameterItem::attLimits().

Here is the call graph for this function:

limitless()

AttLimits AttLimits::limitless ( )

static

Definition at line 26 of file AttLimits.cpp.

{
    return AttLimits();
}

References AttLimits().

Referenced by FitParameterItem::attLimits().

Here is the call graph for this function:

lowerLimit()

double AttLimits::lowerLimit

(

)

const

Definition at line 86 of file AttLimits.cpp.

{
    return m_limits.lowerLimit();
}

References RealLimits::lowerLimit(), and m_limits.

Referenced by MinimizerAdapter::setParameter(), and toString().

Here is the call graph for this function:

lowerLimited()

AttLimits AttLimits::lowerLimited ( double  bound_value )

static

Definition at line 31 of file AttLimits.cpp.

{
    return AttLimits(RealLimits::lowerLimited(bound_value), Attributes::free());
}

References AttLimits(), Attributes::free(), and RealLimits::lowerLimited().

Referenced by FitParameterItem::attLimits().

Here is the call graph for this function:

nonnegative()

AttLimits AttLimits::nonnegative ( )

static

Definition at line 41 of file AttLimits.cpp.

{
    return AttLimits(RealLimits::nonnegative(), Attributes::free());
}

References AttLimits(), Attributes::free(), and RealLimits::nonnegative().

Here is the call graph for this function:

operator!=()

bool AttLimits::operator!=

(

const AttLimits &

other

)

const

Definition at line 107 of file AttLimits.cpp.

{
    return !(*this == other);
}

operator==()

bool AttLimits::operator==

(

const AttLimits &

other

)

const

Definition at line 102 of file AttLimits.cpp.

{
    return m_limits == other.m_limits && m_att_fixed == other.m_att_fixed;
}

References m_att_fixed, and m_limits.

positive()

AttLimits AttLimits::positive ( )

static

Definition at line 36 of file AttLimits.cpp.

{
    return AttLimits(RealLimits::positive(), Attributes::free());
}

References AttLimits(), Attributes::free(), and RealLimits::positive().

Here is the call graph for this function:

setFixed()

void AttLimits::setFixed

(

bool

isFixed

)

Definition at line 96 of file AttLimits.cpp.

{
    m_limits.removeLimits();
    m_att_fixed.setFixed(isFixed);
}

References isFixed(), m_att_fixed, m_limits, RealLimits::removeLimits(), and Attributes::setFixed().

Here is the call graph for this function:

toString()

std::string AttLimits::toString

(

)

const

Definition at line 112 of file AttLimits.cpp.

{
    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();
}

References isFixed(), isLimited(), isLimitless(), isLowerLimited(), isUpperLimited(), lowerLimit(), StringUtils::scientific(), and upperLimit().

Referenced by GeneticMinimizer::setParameter().

Here is the call graph for this function:

upperLimit()

double AttLimits::upperLimit

(

)

const

Definition at line 91 of file AttLimits.cpp.

{
    return m_limits.upperLimit();
}

References m_limits, and RealLimits::upperLimit().

Referenced by MinimizerAdapter::setParameter(), and toString().

Here is the call graph for this function:

upperLimited()

AttLimits AttLimits::upperLimited ( double  bound_value )

static

Definition at line 46 of file AttLimits.cpp.

{
    return AttLimits(RealLimits::upperLimited(bound_value), Attributes::free());
}

References AttLimits(), Attributes::free(), and RealLimits::upperLimited().

Referenced by FitParameterItem::attLimits().

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  ostr, const AttLimits &  m  )

friend

Definition at line 53 of file AttLimits.h.

    {
        ostr << m.toString();
        return ostr;
    }

Member Data Documentation

m_att_fixed

Attributes AttLimits::m_att_fixed

private

Definition at line 63 of file AttLimits.h.

Referenced by isFixed(), isLimited(), isLimitless(), isLowerLimited(), isUpperLimited(), operator==(), and setFixed().

m_limits

RealLimits AttLimits::m_limits

private

Definition at line 62 of file AttLimits.h.

Referenced by isLimited(), isLimitless(), isLowerLimited(), isUpperLimited(), lowerLimit(), operator==(), setFixed(), and upperLimit().

---

The documentation for this class was generated from the following files:

• /home/www/ba/Fit/Param/AttLimits.h
• /home/www/ba/Fit/Param/AttLimits.cpp