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

Description

A fittable parameter with value, error, step, and limits.

Public Member Functions

 Parameter ()
 
 Parameter (std::string name, double value, const AttLimits &limits=AttLimits::limitless(), double step=0.0)
 Fit parameter constructor. More...
 
double error () const
 
AttLimits limits () const
 
std::string name () const
 
void setError (double value)
 
void setValue (double value)
 
double startValue () const
 
double step () const
 
double value () const
 

Constructor & Destructor Documentation

◆ Parameter() [1/2]

mumufit::Parameter::Parameter ( )

◆ Parameter() [2/2]

mumufit::Parameter::Parameter ( std::string  name,
double  value,
const AttLimits limits = AttLimits::limitless(),
double  step = 0.0 
)

Fit parameter constructor.

Parameters
nameunique name of fit parameters
valuestarting value of fit parameter
limitsfit parameter limits
stepinitial step of fit parameter during the minimization, will be calculated automatically, if zero.

Member Function Documentation

◆ error()

double mumufit::Parameter::error ( ) const

◆ limits()

AttLimits mumufit::Parameter::limits ( ) const

◆ name()

std::string mumufit::Parameter::name ( ) const

◆ setError()

void mumufit::Parameter::setError ( double  value)

◆ setValue()

void mumufit::Parameter::setValue ( double  value)

◆ startValue()

double mumufit::Parameter::startValue ( ) const

◆ step()

double mumufit::Parameter::step ( ) const

◆ value()

double mumufit::Parameter::value ( ) const