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::MnUserParameterState Class Reference

Description

class which holds the external user and/or internal Minuit representation of the parameters and errors; transformation internal <-> external on demand;

Definition at line 31 of file MnUserParameterState.h.

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

Public Member Functions

 MnUserParameterState ()
 default constructor (invalid state) More...
 
 MnUserParameterState (const MinimumState &, double, const MnUserTransformation &)
 construct from internal parameters (after minimization) More...
 
 MnUserParameterState (const MnUserParameters &)
 
 MnUserParameterState (const MnUserParameters &, const MnUserCovariance &)
 
 MnUserParameterState (const MnUserParameterState &state)
 
 MnUserParameterState (const std::vector< double > &, const MnUserCovariance &)
 
 MnUserParameterState (const std::vector< double > &, const std::vector< double > &)
 construct from user parameters (before minimization) More...
 
 MnUserParameterState (const std::vector< double > &, const std::vector< double > &, unsigned int)
 construct from user parameters + covariance (before minimization) More...
 
 ~MnUserParameterState ()
 
void Add (const std::string &, double)
 
void Add (const std::string &name, double val, double err)
 
void Add (const std::string &name, double val, double err, double, double)
 
const MnUserCovarianceCovariance () const
 
int CovarianceStatus () const
 
double Edm () const
 
double Error (const std::string &) const
 
double Error (unsigned int) const
 
std::vector< double > Errors () const
 
double Ext2int (unsigned int, double) const
 
unsigned int ExtOfInt (unsigned int) const
 
void Fix (const std::string &)
 
void Fix (unsigned int)
 
double Fval () const
 
const std::string & GetName (unsigned int) const
 
const MnGlobalCorrelationCoeffGlobalCC () const
 
bool HasCovariance () const
 
bool HasGlobalCC () const
 
MnUserCovariance Hessian () const
 
unsigned int Index (const std::string &) const
 
double Int2ext (unsigned int, double) const
 
const MnUserCovarianceIntCovariance () const
 
unsigned int IntOfExt (unsigned int) const
 
const std::vector< double > & IntParameters () const
 
bool IsValid () const
 
const std::vector< ROOT::Minuit2::MinuitParameter > & MinuitParameters () const
 
const char * Name (unsigned int) const
 
unsigned int NFcn () const
 
MnUserParameterStateoperator= (const MnUserParameterState &state)
 
const MinuitParameterParameter (unsigned int i) const
 
const MnUserParametersParameters () const
 
std::vector< double > Params () const
 
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 iext, const std::string &name)
 
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

MnUserCovariance fCovariance
 
bool fCovarianceValid
 
int fCovStatus
 
double fEDM
 
double fFVal
 
bool fGCCValid
 
MnGlobalCorrelationCoeff fGlobalCC
 
MnUserCovariance fIntCovariance
 
std::vector< double > fIntParameters
 
unsigned int fNFcn
 
MnUserParameters fParameters
 
bool fValid
 

Constructor & Destructor Documentation

◆ MnUserParameterState() [1/8]

ROOT::Minuit2::MnUserParameterState::MnUserParameterState ( )
inline

default constructor (invalid state)

Definition at line 36 of file MnUserParameterState.h.

◆ MnUserParameterState() [2/8]

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

construct from user parameters (before minimization)

◆ MnUserParameterState() [3/8]

ROOT::Minuit2::MnUserParameterState::MnUserParameterState ( const MnUserParameters )

◆ MnUserParameterState() [4/8]

ROOT::Minuit2::MnUserParameterState::MnUserParameterState ( const std::vector< double > &  ,
const std::vector< double > &  ,
unsigned int   
)

construct from user parameters + covariance (before minimization)

◆ MnUserParameterState() [5/8]

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

◆ MnUserParameterState() [6/8]

ROOT::Minuit2::MnUserParameterState::MnUserParameterState ( const MnUserParameters ,
const MnUserCovariance  
)

◆ MnUserParameterState() [7/8]

ROOT::Minuit2::MnUserParameterState::MnUserParameterState ( const MinimumState ,
double  ,
const MnUserTransformation  
)

construct from internal parameters (after minimization)

◆ ~MnUserParameterState()

ROOT::Minuit2::MnUserParameterState::~MnUserParameterState ( )
inline

Definition at line 55 of file MnUserParameterState.h.

55 {}

◆ MnUserParameterState() [8/8]

ROOT::Minuit2::MnUserParameterState::MnUserParameterState ( const MnUserParameterState state)
inline

Definition at line 57 of file MnUserParameterState.h.

57  : fValid(state.fValid),
58  fCovarianceValid(state.fCovarianceValid), fGCCValid(state.fGCCValid), fCovStatus(state.fCovStatus),
59  fFVal(state.fFVal), fEDM(state.fEDM), fNFcn(state.fNFcn),
60  fParameters(state.fParameters),
61  fCovariance(state.fCovariance),
62  fGlobalCC(state.fGlobalCC), fIntParameters(state.fIntParameters), fIntCovariance(state.fIntCovariance) {}

Member Function Documentation

◆ Add() [1/3]

void ROOT::Minuit2::MnUserParameterState::Add ( const std::string &  ,
double   
)

◆ Add() [2/3]

void ROOT::Minuit2::MnUserParameterState::Add ( const std::string &  name,
double  val,
double  err 
)

◆ Add() [3/3]

void ROOT::Minuit2::MnUserParameterState::Add ( const std::string &  name,
double  val,
double  err,
double  ,
double   
)

◆ Covariance()

const MnUserCovariance& ROOT::Minuit2::MnUserParameterState::Covariance ( ) const
inline

◆ CovarianceStatus()

int ROOT::Minuit2::MnUserParameterState::CovarianceStatus ( ) const
inline

Definition at line 95 of file MnUserParameterState.h.

95 { return fCovStatus; }

References fCovStatus.

◆ Edm()

double ROOT::Minuit2::MnUserParameterState::Edm ( ) const
inline

Definition at line 105 of file MnUserParameterState.h.

105 {return fEDM;}

References fEDM.

Referenced by ROOT::Minuit2::Minuit2Minimizer::Edm().

◆ Error() [1/2]

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

◆ Error() [2/2]

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

◆ Errors()

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

◆ Ext2int()

double ROOT::Minuit2::MnUserParameterState::Ext2int ( unsigned int  ,
double   
) const

◆ ExtOfInt()

unsigned int ROOT::Minuit2::MnUserParameterState::ExtOfInt ( unsigned int  ) const

◆ Fix() [1/2]

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

◆ Fix() [2/2]

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

◆ Fval()

double ROOT::Minuit2::MnUserParameterState::Fval ( ) const
inline

Definition at line 104 of file MnUserParameterState.h.

104 {return fFVal;}

References fFVal.

Referenced by ROOT::Minuit2::Minuit2Minimizer::MinValue().

◆ GetName()

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

◆ GlobalCC()

const MnGlobalCorrelationCoeff& ROOT::Minuit2::MnUserParameterState::GlobalCC ( ) const
inline

Definition at line 85 of file MnUserParameterState.h.

85 {return fGlobalCC;}

References fGlobalCC.

◆ HasCovariance()

bool ROOT::Minuit2::MnUserParameterState::HasCovariance ( ) const
inline

Definition at line 101 of file MnUserParameterState.h.

101 {return fCovarianceValid;}

References fCovarianceValid.

◆ HasGlobalCC()

bool ROOT::Minuit2::MnUserParameterState::HasGlobalCC ( ) const
inline

Definition at line 102 of file MnUserParameterState.h.

102 {return fGCCValid;}

References fGCCValid.

◆ Hessian()

MnUserCovariance ROOT::Minuit2::MnUserParameterState::Hessian ( ) const

◆ Index()

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

◆ Int2ext()

double ROOT::Minuit2::MnUserParameterState::Int2ext ( unsigned int  ,
double   
) const

◆ IntCovariance()

const MnUserCovariance& ROOT::Minuit2::MnUserParameterState::IntCovariance ( ) const
inline

Definition at line 92 of file MnUserParameterState.h.

92 {return fIntCovariance;}

References fIntCovariance.

◆ IntOfExt()

unsigned int ROOT::Minuit2::MnUserParameterState::IntOfExt ( unsigned int  ) const

◆ IntParameters()

const std::vector<double>& ROOT::Minuit2::MnUserParameterState::IntParameters ( ) const
inline

Definition at line 91 of file MnUserParameterState.h.

91 {return fIntParameters;}

References fIntParameters.

◆ IsValid()

bool ROOT::Minuit2::MnUserParameterState::IsValid ( ) const
inline

◆ MinuitParameters()

const std::vector<ROOT::Minuit2::MinuitParameter>& ROOT::Minuit2::MnUserParameterState::MinuitParameters ( ) const

facade: forward interface of MnUserParameters and MnUserTransformation

◆ Name()

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

◆ NFcn()

unsigned int ROOT::Minuit2::MnUserParameterState::NFcn ( ) const
inline

Definition at line 106 of file MnUserParameterState.h.

106 {return fNFcn;}

References fNFcn.

Referenced by ROOT::Minuit2::Minuit2Minimizer::NCalls().

◆ operator=()

MnUserParameterState& ROOT::Minuit2::MnUserParameterState::operator= ( const MnUserParameterState state)
inline

Definition at line 64 of file MnUserParameterState.h.

64  {
65  if(this != &state) {
66  fValid = state.fValid;
67  fCovarianceValid = state.fCovarianceValid;
68  fGCCValid = state.fGCCValid;
69  fCovStatus = state.fCovStatus;
70  fFVal = state.fFVal;
71  fEDM = state.fEDM;
72  fNFcn = state.fNFcn;
73  fParameters = state.fParameters;
74  fCovariance = state.fCovariance;
75  fGlobalCC = state.fGlobalCC;
76  fIntParameters = state.fIntParameters;
77  fIntCovariance = state.fIntCovariance;
78  }
79  return *this;
80  }

References fCovariance, fCovarianceValid, fCovStatus, fEDM, fFVal, fGCCValid, fGlobalCC, fIntCovariance, fIntParameters, fNFcn, fParameters, and fValid.

◆ Parameter()

const MinuitParameter& ROOT::Minuit2::MnUserParameterState::Parameter ( unsigned int  i) const

◆ Parameters()

const MnUserParameters& ROOT::Minuit2::MnUserParameterState::Parameters ( ) const
inline

◆ Params()

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

◆ Precision()

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

◆ Release() [1/2]

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

◆ Release() [2/2]

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

◆ RemoveLimits() [1/2]

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

◆ RemoveLimits() [2/2]

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

◆ SetError() [1/2]

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

◆ SetError() [2/2]

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

◆ SetLimits() [1/2]

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

◆ SetLimits() [2/2]

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

◆ SetLowerLimit() [1/2]

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

◆ SetLowerLimit() [2/2]

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

◆ SetName()

void ROOT::Minuit2::MnUserParameterState::SetName ( unsigned int  iext,
const std::string &  name 
)
inline

Definition at line 138 of file MnUserParameterState.h.

138 { fParameters.SetName(iext,name); }
void SetName(unsigned int, const std::string &)

References fParameters, and ROOT::Minuit2::MnUserParameters::SetName().

Here is the call graph for this function:

◆ SetPrecision()

void ROOT::Minuit2::MnUserParameterState::SetPrecision ( double  eps)

◆ SetUpperLimit() [1/2]

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

◆ SetUpperLimit() [2/2]

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

◆ SetValue() [1/2]

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

◆ SetValue() [2/2]

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

◆ Trafo()

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

Definition at line 98 of file MnUserParameterState.h.

98 {return fParameters.Trafo();}
const MnUserTransformation & Trafo() const

References fParameters, and ROOT::Minuit2::MnUserParameters::Trafo().

Here is the call graph for this function:

◆ Value() [1/2]

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

◆ Value() [2/2]

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

◆ VariableParameters()

unsigned int ROOT::Minuit2::MnUserParameterState::VariableParameters ( ) const

Member Data Documentation

◆ fCovariance

MnUserCovariance ROOT::Minuit2::MnUserParameterState::fCovariance
private

Definition at line 184 of file MnUserParameterState.h.

Referenced by Covariance(), and operator=().

◆ fCovarianceValid

bool ROOT::Minuit2::MnUserParameterState::fCovarianceValid
private

Definition at line 176 of file MnUserParameterState.h.

Referenced by HasCovariance(), and operator=().

◆ fCovStatus

int ROOT::Minuit2::MnUserParameterState::fCovStatus
private

Definition at line 178 of file MnUserParameterState.h.

Referenced by CovarianceStatus(), and operator=().

◆ fEDM

double ROOT::Minuit2::MnUserParameterState::fEDM
private

Definition at line 180 of file MnUserParameterState.h.

Referenced by Edm(), and operator=().

◆ fFVal

double ROOT::Minuit2::MnUserParameterState::fFVal
private

Definition at line 179 of file MnUserParameterState.h.

Referenced by Fval(), and operator=().

◆ fGCCValid

bool ROOT::Minuit2::MnUserParameterState::fGCCValid
private

Definition at line 177 of file MnUserParameterState.h.

Referenced by HasGlobalCC(), and operator=().

◆ fGlobalCC

MnGlobalCorrelationCoeff ROOT::Minuit2::MnUserParameterState::fGlobalCC
private

Definition at line 185 of file MnUserParameterState.h.

Referenced by GlobalCC(), and operator=().

◆ fIntCovariance

MnUserCovariance ROOT::Minuit2::MnUserParameterState::fIntCovariance
private

Definition at line 188 of file MnUserParameterState.h.

Referenced by IntCovariance(), and operator=().

◆ fIntParameters

std::vector<double> ROOT::Minuit2::MnUserParameterState::fIntParameters
private

Definition at line 187 of file MnUserParameterState.h.

Referenced by IntParameters(), and operator=().

◆ fNFcn

unsigned int ROOT::Minuit2::MnUserParameterState::fNFcn
private

Definition at line 181 of file MnUserParameterState.h.

Referenced by NFcn(), and operator=().

◆ fParameters

MnUserParameters ROOT::Minuit2::MnUserParameterState::fParameters
private

Definition at line 183 of file MnUserParameterState.h.

Referenced by operator=(), Parameters(), SetName(), and Trafo().

◆ fValid

bool ROOT::Minuit2::MnUserParameterState::fValid
private

Definition at line 175 of file MnUserParameterState.h.

Referenced by IsValid(), and operator=().


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