BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
AttLimits Class Reference

Description

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

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)
 

Friends

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

Constructor & Destructor Documentation

◆ AttLimits()

AttLimits::AttLimits ( )

Member Function Documentation

◆ fixed()

static AttLimits AttLimits::fixed ( )
static

◆ isFixed()

bool AttLimits::isFixed ( ) const

◆ isLimited()

bool AttLimits::isLimited ( ) const

◆ isLimitless()

bool AttLimits::isLimitless ( ) const

◆ isLowerLimited()

bool AttLimits::isLowerLimited ( ) const

◆ isUpperLimited()

bool AttLimits::isUpperLimited ( ) const

◆ limited()

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

◆ limitless()

static AttLimits AttLimits::limitless ( )
static

◆ lowerLimit()

double AttLimits::lowerLimit ( ) const

◆ lowerLimited()

static AttLimits AttLimits::lowerLimited ( double  bound_value)
static

◆ nonnegative()

static AttLimits AttLimits::nonnegative ( )
static

◆ operator!=()

bool AttLimits::operator!= ( const AttLimits other) const

◆ operator==()

bool AttLimits::operator== ( const AttLimits other) const

◆ positive()

static AttLimits AttLimits::positive ( )
static

◆ setFixed()

void AttLimits::setFixed ( bool  isFixed)

◆ toString()

std::string AttLimits::toString ( ) const

◆ upperLimit()

double AttLimits::upperLimit ( ) const

◆ upperLimited()

static AttLimits AttLimits::upperLimited ( double  bound_value)
static

Friends And Related Function Documentation

◆ operator<<

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