RealLimits Class Reference

Collaboration diagram for RealLimits:

Public Member Functions
	RealLimits ()
bool	hasLowerLimit () const
double	lowerLimit () const
void	setLowerLimit (double value)
void	removeLowerLimit ()
bool	hasUpperLimit () const
double	upperLimit () const
void	setUpperLimit (double value)
void	removeUpperLimit ()
bool	hasLowerAndUpperLimits () const
void	setLimits (double xmin, double xmax)
void	removeLimits ()
bool	isInRange (double value) const
std::string	toString () const
bool	operator== (const RealLimits &other) const
bool	operator!= (const RealLimits &other) const
bool	isLimitless () const
bool	isPositive () const
bool	isNonnegative () const
bool	isLowerLimited () const
bool	isUpperLimited () const
bool	isLimited () const

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

Protected Member Functions
	RealLimits (bool has_lower_limit, bool has_upper_limit, double lower_limit, double upper_limit)

Protected Attributes
bool	m_has_lower_limit
bool	m_has_upper_limit
double	m_lower_limit
double	m_upper_limit

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

Detailed Description

Limits for a real fit parameter.

Definition at line 24 of file RealLimits.h.

Constructor & Destructor Documentation

RealLimits() [1/2]

RealLimits::RealLimits

(

)

Definition at line 21 of file RealLimits.cpp.

    : m_has_lower_limit(false), m_has_upper_limit(false), m_lower_limit(0.), m_upper_limit(0.)
{
}

Referenced by limited(), limitless(), lowerLimited(), and upperLimited().

RealLimits() [2/2]

RealLimits::RealLimits ( bool  has_lower_limit, bool  has_upper_limit, double  lower_limit, double  upper_limit  )

protected

Definition at line 26 of file RealLimits.cpp.

    : m_has_lower_limit(has_lower_limit), m_has_upper_limit(has_upper_limit),
      m_lower_limit(lower_limit), m_upper_limit(upper_limit)
{
}

Member Function Documentation

hasLowerLimit()

bool RealLimits::hasLowerLimit

(

)

const

if has lower limit

Definition at line 33 of file RealLimits.cpp.

{
    return m_has_lower_limit;
}

References m_has_lower_limit.

Referenced by IDistribution1D::adjustMinMaxForLimits(), isInRange(), isLimited(), AttLimits::isLimitless(), isLimitless(), AttLimits::isLowerLimited(), isLowerLimited(), isNonnegative(), isPositive(), AttLimits::isUpperLimited(), and isUpperLimited().

lowerLimit()

double RealLimits::lowerLimit

(

)

const

Returns lower limit.

Definition at line 38 of file RealLimits.cpp.

{
    return m_lower_limit;
}

References m_lower_limit.

Referenced by IDistribution1D::adjustMinMaxForLimits(), RangedDistribution::checkInitialization(), isNonnegative(), isPositive(), AttLimits::lowerLimit(), pyfmt::printRealLimits(), and toString().

setLowerLimit()

void RealLimits::setLowerLimit

(

double

value

)

Sets lower limit.

Definition at line 43 of file RealLimits.cpp.

{
    m_lower_limit = value;
    m_has_lower_limit = true;
}

References m_has_lower_limit, and m_lower_limit.

Referenced by setLimits().

removeLowerLimit()

void RealLimits::removeLowerLimit

(

)

remove lower limit

Definition at line 49 of file RealLimits.cpp.

{
    m_lower_limit = 0.;
    m_has_lower_limit = false;
}

References m_has_lower_limit, and m_lower_limit.

Referenced by removeLimits().

hasUpperLimit()

bool RealLimits::hasUpperLimit

(

)

const

if has upper limit

Definition at line 55 of file RealLimits.cpp.

{
    return m_has_upper_limit;
}

References m_has_upper_limit.

Referenced by IDistribution1D::adjustMinMaxForLimits(), isInRange(), isLimited(), AttLimits::isLimitless(), isLimitless(), AttLimits::isLowerLimited(), isLowerLimited(), isNonnegative(), isPositive(), AttLimits::isUpperLimited(), and isUpperLimited().

upperLimit()

double RealLimits::upperLimit

(

)

const

Returns upper limit.

Definition at line 60 of file RealLimits.cpp.

{
    return m_upper_limit;
}

References m_upper_limit.

Referenced by IDistribution1D::adjustMinMaxForLimits(), RangedDistribution::checkInitialization(), pyfmt::printRealLimits(), toString(), and AttLimits::upperLimit().

setUpperLimit()

void RealLimits::setUpperLimit

(

double

value

)

Sets upper limit.

Definition at line 65 of file RealLimits.cpp.

{
    m_upper_limit = value;
    m_has_upper_limit = true;
}

References m_has_upper_limit, and m_upper_limit.

Referenced by setLimits().

removeUpperLimit()

void RealLimits::removeUpperLimit

(

)

remove upper limit

Definition at line 71 of file RealLimits.cpp.

{
    m_upper_limit = 0.;
    m_has_upper_limit = false;
}

References m_has_upper_limit, and m_upper_limit.

Referenced by removeLimits().

hasLowerAndUpperLimits()

bool RealLimits::hasLowerAndUpperLimits

(

)

const

if has lower and upper limit

Definition at line 77 of file RealLimits.cpp.

{
    return (m_has_lower_limit && m_has_upper_limit);
}

References m_has_lower_limit, and m_has_upper_limit.

Referenced by RangedDistribution::checkInitialization(), and AttLimits::isLimited().

setLimits()

void RealLimits::setLimits	(	double	xmin,
		double	xmax
	)

Sets lower and upper limits.

Definition at line 82 of file RealLimits.cpp.

{
    setLowerLimit(xmin);
    setUpperLimit(xmax);
}

References setLowerLimit(), and setUpperLimit().

Here is the call graph for this function:

removeLimits()

void RealLimits::removeLimits

(

)

remove limits

Definition at line 88 of file RealLimits.cpp.

{
    removeLowerLimit();
    removeUpperLimit();
}

References removeLowerLimit(), and removeUpperLimit().

Referenced by AttLimits::setFixed().

Here is the call graph for this function:

isInRange()

bool RealLimits::isInRange

(

double

value

)

const

returns true if proposed value is in limits range

Definition at line 94 of file RealLimits.cpp.

{
    if (hasLowerLimit() && value < m_lower_limit)
        return false;
    if (hasUpperLimit() && value >= m_upper_limit)
        return false;
    return true;
}

References hasLowerLimit(), hasUpperLimit(), m_lower_limit, and m_upper_limit.

Referenced by DepthProbeSimulation::generateSimulationElements(), RealParameter::RealParameter(), and RealParameter::setValue().

Here is the call graph for this function:

lowerLimited()

RealLimits RealLimits::lowerLimited ( double  bound_value )

static

Creates an object bounded from the left.

Definition at line 103 of file RealLimits.cpp.

{
    return RealLimits(true, false, bound_value, 0.);
}

References RealLimits().

Referenced by AttLimits::lowerLimited(), nonnegative(), and positive().

Here is the call graph for this function:

positive()

RealLimits RealLimits::positive ( )

static

Creates an object which can have only positive values (>0., zero is not included)

Definition at line 108 of file RealLimits.cpp.

{
    return lowerLimited(std::numeric_limits<double>::min());
}

References lowerLimited().

Referenced by AttLimits::positive(), and RealParameter::setPositive().

Here is the call graph for this function:

nonnegative()

RealLimits RealLimits::nonnegative ( )

static

Creates an object which can have only positive values with 0. included.

Definition at line 113 of file RealLimits.cpp.

{
    return lowerLimited(0.);
}

References lowerLimited().

Referenced by AttLimits::nonnegative(), and RealParameter::setNonnegative().

Here is the call graph for this function:

upperLimited()

RealLimits RealLimits::upperLimited ( double  bound_value )

static

Creates an object bounded from the right.

Definition at line 118 of file RealLimits.cpp.

{
    return RealLimits(false, true, 0., bound_value);
}

References RealLimits().

Referenced by AttLimits::upperLimited().

Here is the call graph for this function:

limited()

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

static

Creates an object bounded from the left and right.

Definition at line 123 of file RealLimits.cpp.

{
    return RealLimits(true, true, left_bound_value, right_bound_value);
}

References RealLimits().

Referenced by SpheresWithLimitsDistributionBuilder::buildSample(), ConesWithLimitsDistributionBuilder::buildSample(), LinkedBoxDistributionBuilder::buildSample(), DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), AttLimits::limited(), and RealParameter::setLimited().

Here is the call graph for this function:

limitless()

RealLimits RealLimits::limitless ( )

static

Creates an object withoud bounds (default)

Definition at line 128 of file RealLimits.cpp.

{
    return RealLimits();
}

References RealLimits().

Referenced by AttLimits::fixed().

Here is the call graph for this function:

toString()

std::string RealLimits::toString

(

)

const

Definition at line 133 of file RealLimits.cpp.

{
    std::ostringstream result;
 
    if (isLimitless())
        result << "unlimited";
 
    else if (isPositive())
        result << "positive";
 
    else if (isNonnegative())
        result << "nonnegative";
 
    else if (isLowerLimited())
        result << "lowerLimited(" << std::fixed << std::setprecision(2) << lowerLimit() << ")";
 
    else if (isUpperLimited())
        result << "upperLimited(" << std::fixed << std::setprecision(2) << upperLimit() << ")";
 
    else if (isLimited())
        result << "limited(" << std::fixed << std::setprecision(2) << lowerLimit() << ","
               << std::fixed << std::setprecision(2) << upperLimit() << ")";
 
    return result.str();
}

References isLimited(), isLimitless(), isLowerLimited(), isNonnegative(), isPositive(), isUpperLimited(), lowerLimit(), and upperLimit().

Here is the call graph for this function:

operator==()

bool RealLimits::operator==

(

const RealLimits &

other

)

const

Definition at line 159 of file RealLimits.cpp.

{
    return (m_has_lower_limit == other.m_has_lower_limit)
           && (m_has_upper_limit == other.m_has_upper_limit)
           && (m_lower_limit == other.m_lower_limit) && (m_upper_limit == other.m_upper_limit);
}

References m_has_lower_limit, m_has_upper_limit, m_lower_limit, and m_upper_limit.

operator!=()

bool RealLimits::operator!=

(

const RealLimits &

other

)

const

Definition at line 166 of file RealLimits.cpp.

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

isLimitless()

bool RealLimits::isLimitless

(

)

const

Definition at line 171 of file RealLimits.cpp.

{
    return !hasLowerLimit() && !hasUpperLimit();
}

References hasLowerLimit(), and hasUpperLimit().

Referenced by pyfmt::printRealLimits(), pyfmt::printRealLimitsArg(), RangedDistribution::pyString(), and toString().

Here is the call graph for this function:

isPositive()

bool RealLimits::isPositive

(

)

const

Definition at line 176 of file RealLimits.cpp.

{
    return hasLowerLimit() && !hasUpperLimit()
           && lowerLimit() == std::numeric_limits<double>::min();
}

References hasLowerLimit(), hasUpperLimit(), and lowerLimit().

Referenced by pyfmt::printRealLimits(), and toString().

Here is the call graph for this function:

isNonnegative()

bool RealLimits::isNonnegative

(

)

const

Definition at line 182 of file RealLimits.cpp.

{
    return hasLowerLimit() && !hasUpperLimit() && lowerLimit() == 0.0;
}

References hasLowerLimit(), hasUpperLimit(), and lowerLimit().

Referenced by pyfmt::printRealLimits(), and toString().

Here is the call graph for this function:

isLowerLimited()

bool RealLimits::isLowerLimited

(

)

const

Definition at line 187 of file RealLimits.cpp.

{
    return hasLowerLimit() && !hasUpperLimit();
}

References hasLowerLimit(), and hasUpperLimit().

Referenced by pyfmt::printRealLimits(), and toString().

Here is the call graph for this function:

isUpperLimited()

bool RealLimits::isUpperLimited

(

)

const

Definition at line 192 of file RealLimits.cpp.

{
    return !hasLowerLimit() && hasUpperLimit();
}

References hasLowerLimit(), and hasUpperLimit().

Referenced by pyfmt::printRealLimits(), and toString().

Here is the call graph for this function:

isLimited()

bool RealLimits::isLimited

(

)

const

Definition at line 197 of file RealLimits.cpp.

{
    return hasLowerLimit() && hasUpperLimit();
}

References hasLowerLimit(), and hasUpperLimit().

Referenced by pyfmt::printRealLimits(), and toString().

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

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

friend

Prints class.

Definition at line 86 of file RealLimits.h.

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

Member Data Documentation

m_has_lower_limit

bool RealLimits::m_has_lower_limit

protected

Definition at line 105 of file RealLimits.h.

Referenced by hasLowerAndUpperLimits(), hasLowerLimit(), operator==(), removeLowerLimit(), and setLowerLimit().

m_has_upper_limit

bool RealLimits::m_has_upper_limit

protected

parameter has lower bound

Definition at line 106 of file RealLimits.h.

Referenced by hasLowerAndUpperLimits(), hasUpperLimit(), operator==(), removeUpperLimit(), and setUpperLimit().

m_lower_limit

double RealLimits::m_lower_limit

protected

parameter has upper bound

Definition at line 107 of file RealLimits.h.

Referenced by isInRange(), lowerLimit(), operator==(), removeLowerLimit(), and setLowerLimit().

m_upper_limit

double RealLimits::m_upper_limit

protected

minimum allowed value

Definition at line 108 of file RealLimits.h.

Referenced by isInRange(), operator==(), removeUpperLimit(), setUpperLimit(), and upperLimit().

---

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

• /home/www/ba/Fit/Tools/RealLimits.h
• /home/www/ba/Fit/Tools/RealLimits.cpp