BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
RealLimits Class Reference
Fitting

Limits for a real fit parameter. More...

Public Member Functions

bool hasLowerLimit () const
 if has lower limit
 
double lowerLimit () const
 Returns lower limit.
 
void setLowerLimit (double value)
 Sets lower limit.
 
void removeLowerLimit ()
 remove lower limit
 
bool hasUpperLimit () const
 if has upper limit
 
double upperLimit () const
 Returns upper limit.
 
void setUpperLimit (double value)
 Sets upper limit.
 
void removeUpperLimit ()
 remove upper limit
 
bool hasLowerAndUpperLimits () const
 if has lower and upper limit
 
void setLimits (double xmin, double xmax)
 Sets lower and upper limits.
 
void removeLimits ()
 remove limits
 
bool isInRange (double value) const
 returns true if proposed value is in limits range
 
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)
 Creates an object bounded from the left.
 
static RealLimits positive ()
 Creates an object which can have only positive values (>0., zero is not included)
 
static RealLimits nonnegative ()
 Creates an object which can have only positive values with 0. included.
 
static RealLimits upperLimited (double bound_value)
 Creates an object bounded from the right.
 
static RealLimits limited (double left_bound_value, double right_bound_value)
 Creates an object bounded from the left and right.
 
static RealLimits limitless ()
 Creates an object withoud bounds (default)
 

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
 parameter has lower bound
 
double m_lower_limit
 parameter has upper bound
 
double m_upper_limit
 minimum allowed value
 

Friends

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

Detailed Description

Limits for a real fit parameter.

Definition at line 24 of file RealLimits.h.

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