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

Description

A collection of fit parameters.

Public Types

using const_iterator = parameters_t::const_iterator
 
using corr_matrix_t = std::vector< std::vector< double > >
 
using iterator = parameters_t::iterator
 
using parameters_t = std::vector< Parameter >
 

Public Member Functions

 Parameters ()=default
 
void add (const Parameter &par)
 
iterator begin ()
 
const_iterator begin () const
 
corr_matrix_t correlationMatrix () const
 
iterator end ()
 
const_iterator end () const
 
std::vector< double > errors () const
 
size_t freeParameterCount () const
 
const Parameteroperator[] (const std::string &name) const
 
const Parameteroperator[] (size_t index) const
 
void setCorrelationMatrix (const corr_matrix_t &matrix)
 
void setErrors (const std::vector< double > &errors)
 
void setValues (const std::vector< double > &values)
 
size_t size () const
 
std::vector< double > values () const
 

Member Typedef Documentation

◆ const_iterator

using mumufit::Parameters::const_iterator = parameters_t::const_iterator

◆ corr_matrix_t

using mumufit::Parameters::corr_matrix_t = std::vector<std::vector<double> >

◆ iterator

using mumufit::Parameters::iterator = parameters_t::iterator

◆ parameters_t

Constructor & Destructor Documentation

◆ Parameters()

mumufit::Parameters::Parameters ( )
default

Member Function Documentation

◆ add()

void mumufit::Parameters::add ( const Parameter par)

◆ begin() [1/2]

iterator mumufit::Parameters::begin ( )

◆ begin() [2/2]

const_iterator mumufit::Parameters::begin ( ) const

◆ correlationMatrix()

corr_matrix_t mumufit::Parameters::correlationMatrix ( ) const

◆ end() [1/2]

iterator mumufit::Parameters::end ( )

◆ end() [2/2]

const_iterator mumufit::Parameters::end ( ) const

◆ errors()

std::vector<double> mumufit::Parameters::errors ( ) const

◆ freeParameterCount()

size_t mumufit::Parameters::freeParameterCount ( ) const

◆ operator[]() [1/2]

const Parameter& mumufit::Parameters::operator[] ( const std::string &  name) const

◆ operator[]() [2/2]

const Parameter& mumufit::Parameters::operator[] ( size_t  index) const

◆ setCorrelationMatrix()

void mumufit::Parameters::setCorrelationMatrix ( const corr_matrix_t matrix)

◆ setErrors()

void mumufit::Parameters::setErrors ( const std::vector< double > &  errors)

◆ setValues()

void mumufit::Parameters::setValues ( const std::vector< double > &  values)

◆ size()

size_t mumufit::Parameters::size ( ) const

◆ values()

std::vector<double> mumufit::Parameters::values ( ) const