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

Description

API class for the user interaction with the parameters; serves as input to the minimizer as well as output from it; users can interact: Fix/release parameters, set values and errors, etc.; parameters can be accessed via their Parameter number (determined internally by Minuit and followed the order how the parameters are created) or via their user-specified Name (10 character string). Minuit has also an internal parameter number which is used during the minimization (the fix parameter are skipped). The parameter number used in this class is the external one. The class ROOT::Minuit2::MnUserTransformation is used to keep the internal <-> external transformation

Definition at line 37 of file MnUserParameters.h.

Collaboration diagram for ROOT::Minuit2::MnUserParameters:
[legend]

Public Member Functions

 MnUserParameters ()
 
 MnUserParameters (const MnUserParameters &par)
 
 MnUserParameters (const std::vector< double > &, const std::vector< double > &)
 
 ~MnUserParameters ()
 
bool Add (const std::string &, double)
 Add const Parameter Name, vale. More...
 
bool Add (const std::string &, double, double)
 Add free Parameter Name, Value, Error. More...
 
bool Add (const std::string &, double, double, double, double)
 Add limited Parameter Name, Value, Lower bound, Upper bound. More...
 
double Error (const std::string &) const
 
double Error (unsigned int) const
 
std::vector< double > Errors () const
 
void Fix (const std::string &)
 interaction via Name of Parameter More...
 
void Fix (unsigned int)
 interaction via external number of Parameter More...
 
const std::string & GetName (unsigned int) const
 
unsigned int Index (const std::string &) const
 
const char * Name (unsigned int) const
 
MnUserParametersoperator= (const MnUserParameters &par)
 
const MinuitParameterParameter (unsigned int) const
 access to single Parameter More...
 
const std::vector< ROOT::Minuit2::MinuitParameter > & Parameters () const
 access to parameters (row-wise) More...
 
std::vector< double > Params () const
 access to parameters and errors in column-wise representation More...
 
const MnMachinePrecisionPrecision () const
 
void Release (const std::string &)
 
void Release (unsigned int)
 
void RemoveLimits (const std::string &)
 
void RemoveLimits (unsigned int)
 
void SetError (const std::string &, double)
 
void SetError (unsigned int, double)
 
void SetLimits (const std::string &, double, double)
 
void SetLimits (unsigned int, double, double)
 
void SetLowerLimit (const std::string &, double)
 
void SetLowerLimit (unsigned int, double)
 
void SetName (unsigned int, const std::string &)
 
void SetPrecision (double eps)
 
void SetUpperLimit (const std::string &, double)
 
void SetUpperLimit (unsigned int, double)
 
void SetValue (const std::string &, double)
 
void SetValue (unsigned int, double)
 
const MnUserTransformationTrafo () const
 
double Value (const std::string &) const
 
double Value (unsigned int) const
 
unsigned int VariableParameters () const
 

Private Attributes

MnUserTransformation fTransformation
 

Constructor & Destructor Documentation

◆ MnUserParameters() [1/3]

ROOT::Minuit2::MnUserParameters::MnUserParameters ( )
inline

Definition at line 41 of file MnUserParameters.h.

41 : fTransformation(MnUserTransformation()) {}
MnUserTransformation fTransformation

◆ MnUserParameters() [2/3]

ROOT::Minuit2::MnUserParameters::MnUserParameters ( const std::vector< double > &  ,
const std::vector< double > &   
)

◆ ~MnUserParameters()

ROOT::Minuit2::MnUserParameters::~MnUserParameters ( )
inline

Definition at line 45 of file MnUserParameters.h.

45 {}

◆ MnUserParameters() [3/3]

ROOT::Minuit2::MnUserParameters::MnUserParameters ( const MnUserParameters par)
inline

Definition at line 47 of file MnUserParameters.h.

47  :
48  fTransformation(par.fTransformation) {}

Member Function Documentation

◆ Add() [1/3]

bool ROOT::Minuit2::MnUserParameters::Add ( const std::string &  ,
double   
)

Add const Parameter Name, vale.

◆ Add() [2/3]

bool ROOT::Minuit2::MnUserParameters::Add ( const std::string &  ,
double  ,
double   
)

Add free Parameter Name, Value, Error.

◆ Add() [3/3]

bool ROOT::Minuit2::MnUserParameters::Add ( const std::string &  ,
double  ,
double  ,
double  ,
double   
)

Add limited Parameter Name, Value, Lower bound, Upper bound.

◆ Error() [1/2]

double ROOT::Minuit2::MnUserParameters::Error ( const std::string &  ) const

◆ Error() [2/2]

double ROOT::Minuit2::MnUserParameters::Error ( unsigned int  ) const

◆ Errors()

std::vector<double> ROOT::Minuit2::MnUserParameters::Errors ( ) const

◆ Fix() [1/2]

void ROOT::Minuit2::MnUserParameters::Fix ( const std::string &  )

interaction via Name of Parameter

◆ Fix() [2/2]

void ROOT::Minuit2::MnUserParameters::Fix ( unsigned int  )

interaction via external number of Parameter

◆ GetName()

const std::string& ROOT::Minuit2::MnUserParameters::GetName ( unsigned int  ) const

◆ Index()

unsigned int ROOT::Minuit2::MnUserParameters::Index ( const std::string &  ) const

◆ Name()

const char* ROOT::Minuit2::MnUserParameters::Name ( unsigned int  ) const

◆ operator=()

MnUserParameters& ROOT::Minuit2::MnUserParameters::operator= ( const MnUserParameters par)
inline

Definition at line 50 of file MnUserParameters.h.

50  {
51  fTransformation = par.fTransformation;
52  return *this;
53  }

References fTransformation.

◆ Parameter()

const MinuitParameter& ROOT::Minuit2::MnUserParameters::Parameter ( unsigned int  ) const

access to single Parameter

◆ Parameters()

const std::vector<ROOT::Minuit2::MinuitParameter>& ROOT::Minuit2::MnUserParameters::Parameters ( ) const

access to parameters (row-wise)

◆ Params()

std::vector<double> ROOT::Minuit2::MnUserParameters::Params ( ) const

access to parameters and errors in column-wise representation

◆ Precision()

const MnMachinePrecision& ROOT::Minuit2::MnUserParameters::Precision ( ) const

◆ Release() [1/2]

void ROOT::Minuit2::MnUserParameters::Release ( const std::string &  )

◆ Release() [2/2]

void ROOT::Minuit2::MnUserParameters::Release ( unsigned int  )

◆ RemoveLimits() [1/2]

void ROOT::Minuit2::MnUserParameters::RemoveLimits ( const std::string &  )

◆ RemoveLimits() [2/2]

void ROOT::Minuit2::MnUserParameters::RemoveLimits ( unsigned int  )

◆ SetError() [1/2]

void ROOT::Minuit2::MnUserParameters::SetError ( const std::string &  ,
double   
)

◆ SetError() [2/2]

void ROOT::Minuit2::MnUserParameters::SetError ( unsigned int  ,
double   
)

◆ SetLimits() [1/2]

void ROOT::Minuit2::MnUserParameters::SetLimits ( const std::string &  ,
double  ,
double   
)

◆ SetLimits() [2/2]

void ROOT::Minuit2::MnUserParameters::SetLimits ( unsigned int  ,
double  ,
double   
)

◆ SetLowerLimit() [1/2]

void ROOT::Minuit2::MnUserParameters::SetLowerLimit ( const std::string &  ,
double   
)

◆ SetLowerLimit() [2/2]

void ROOT::Minuit2::MnUserParameters::SetLowerLimit ( unsigned int  ,
double   
)

◆ SetName()

void ROOT::Minuit2::MnUserParameters::SetName ( unsigned int  ,
const std::string &   
)

◆ SetPrecision()

void ROOT::Minuit2::MnUserParameters::SetPrecision ( double  eps)
inline

Definition at line 113 of file MnUserParameters.h.

References fTransformation, and ROOT::Minuit2::MnUserTransformation::SetPrecision().

Here is the call graph for this function:

◆ SetUpperLimit() [1/2]

void ROOT::Minuit2::MnUserParameters::SetUpperLimit ( const std::string &  ,
double   
)

◆ SetUpperLimit() [2/2]

void ROOT::Minuit2::MnUserParameters::SetUpperLimit ( unsigned int  ,
double   
)

◆ SetValue() [1/2]

void ROOT::Minuit2::MnUserParameters::SetValue ( const std::string &  ,
double   
)

◆ SetValue() [2/2]

void ROOT::Minuit2::MnUserParameters::SetValue ( unsigned int  ,
double   
)

◆ Trafo()

const MnUserTransformation& ROOT::Minuit2::MnUserParameters::Trafo ( ) const
inline

Definition at line 55 of file MnUserParameters.h.

55 {return fTransformation;}

References fTransformation.

Referenced by ROOT::Minuit2::MnUserParameterState::Trafo().

◆ Value() [1/2]

double ROOT::Minuit2::MnUserParameters::Value ( const std::string &  ) const

◆ Value() [2/2]

double ROOT::Minuit2::MnUserParameters::Value ( unsigned int  ) const

◆ VariableParameters()

unsigned int ROOT::Minuit2::MnUserParameters::VariableParameters ( ) const
inline

Definition at line 57 of file MnUserParameters.h.

57  {
59  }

References fTransformation, and ROOT::Minuit2::MnUserTransformation::VariableParameters().

Here is the call graph for this function:

Member Data Documentation

◆ fTransformation

MnUserTransformation ROOT::Minuit2::MnUserParameters::fTransformation
private

Definition at line 117 of file MnUserParameters.h.

Referenced by operator=(), SetPrecision(), Trafo(), and VariableParameters().


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