Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Private Attributes | List of all members
ROOT::Minuit2::MnUserParameters Class Reference

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 36 of file MnUserParameters.h.

Public Member Functions

 MnUserParameters ()
 
 MnUserParameters (const MnUserParameters &par)
 
 MnUserParameters (std::span< const double >, std::span< const double >)
 
 ~MnUserParameters ()
 
bool Add (const std::string &, double)
 Add const Parameter Name, vale.
 
bool Add (const std::string &, double, double)
 Add free Parameter Name, Value, Error.
 
bool Add (const std::string &, double, double, double, double)
 Add limited Parameter Name, Value, Lower bound, Upper bound.
 
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
 
void Fix (unsigned int)
 interaction via external number of Parameter
 
const std::string & GetName (unsigned int) const
 
unsigned int Index (const std::string &) const
 
const char * Name (unsigned int) const
 
MnUserParameters & operator= (const MnUserParameters &par)
 
const MinuitParameter & Parameter (unsigned int) const
 access to single Parameter
 
const std::vector< ROOT::Minuit2::MinuitParameter > & Parameters () const
 access to parameters (row-wise)
 
std::vector< double > Params () const
 access to parameters and errors in column-wise representation
 
const MnMachinePrecision & Precision () 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 MnUserTransformation & Trafo () const
 
double Value (const std::string &) const
 
double Value (unsigned int) const
 
unsigned int VariableParameters () const
 

Private Attributes

MnUserTransformation fTransformation
 

#include <Minuit2/MnUserParameters.h>

Constructor & Destructor Documentation

◆ MnUserParameters() [1/3]

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

Definition at line 39 of file MnUserParameters.h.

◆ MnUserParameters() [2/3]

ROOT::Minuit2::MnUserParameters::MnUserParameters ( std::span< const double >  par,
std::span< const double >  err 
)

Definition at line 16 of file MnUserParameters.cxx.

◆ ~MnUserParameters()

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

Definition at line 43 of file MnUserParameters.h.

◆ MnUserParameters() [3/3]

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

Definition at line 45 of file MnUserParameters.h.

Member Function Documentation

◆ Add() [1/3]

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

Add const Parameter Name, vale.

Definition at line 61 of file MnUserParameters.cxx.

◆ Add() [2/3]

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

Add free Parameter Name, Value, Error.

Definition at line 47 of file MnUserParameters.cxx.

◆ Add() [3/3]

bool ROOT::Minuit2::MnUserParameters::Add ( const std::string &  name,
double  val,
double  err,
double  low,
double  up 
)

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

Definition at line 54 of file MnUserParameters.cxx.

◆ Error() [1/2]

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

Definition at line 190 of file MnUserParameters.cxx.

◆ Error() [2/2]

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

Definition at line 128 of file MnUserParameters.cxx.

◆ Errors()

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

Definition at line 35 of file MnUserParameters.cxx.

◆ Fix() [1/2]

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

interaction via Name of Parameter

Definition at line 136 of file MnUserParameters.cxx.

◆ Fix() [2/2]

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

interaction via external number of Parameter

Definition at line 68 of file MnUserParameters.cxx.

◆ GetName()

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

Definition at line 202 of file MnUserParameters.cxx.

◆ Index()

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

Definition at line 196 of file MnUserParameters.cxx.

◆ Name()

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

Definition at line 207 of file MnUserParameters.cxx.

◆ operator=()

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

Definition at line 47 of file MnUserParameters.h.

◆ Parameter()

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

access to single Parameter

Definition at line 41 of file MnUserParameters.cxx.

◆ Parameters()

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

access to parameters (row-wise)

Definition at line 23 of file MnUserParameters.cxx.

◆ Params()

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

access to parameters and errors in column-wise representation

Definition at line 29 of file MnUserParameters.cxx.

◆ Precision()

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

Definition at line 213 of file MnUserParameters.cxx.

◆ Release() [1/2]

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

Definition at line 142 of file MnUserParameters.cxx.

◆ Release() [2/2]

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

Definition at line 74 of file MnUserParameters.cxx.

◆ RemoveLimits() [1/2]

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

Definition at line 178 of file MnUserParameters.cxx.

◆ RemoveLimits() [2/2]

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

Definition at line 80 of file MnUserParameters.cxx.

◆ SetError() [1/2]

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

Definition at line 154 of file MnUserParameters.cxx.

◆ SetError() [2/2]

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

Definition at line 92 of file MnUserParameters.cxx.

◆ SetLimits() [1/2]

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

Definition at line 160 of file MnUserParameters.cxx.

◆ SetLimits() [2/2]

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

Definition at line 98 of file MnUserParameters.cxx.

◆ SetLowerLimit() [1/2]

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

Definition at line 172 of file MnUserParameters.cxx.

◆ SetLowerLimit() [2/2]

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

Definition at line 110 of file MnUserParameters.cxx.

◆ SetName()

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

Definition at line 116 of file MnUserParameters.cxx.

◆ SetPrecision()

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

Definition at line 109 of file MnUserParameters.h.

◆ SetUpperLimit() [1/2]

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

Definition at line 166 of file MnUserParameters.cxx.

◆ SetUpperLimit() [2/2]

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

Definition at line 104 of file MnUserParameters.cxx.

◆ SetValue() [1/2]

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

Definition at line 148 of file MnUserParameters.cxx.

◆ SetValue() [2/2]

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

Definition at line 86 of file MnUserParameters.cxx.

◆ Trafo()

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

Definition at line 53 of file MnUserParameters.h.

◆ Value() [1/2]

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

Definition at line 184 of file MnUserParameters.cxx.

◆ Value() [2/2]

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

Definition at line 122 of file MnUserParameters.cxx.

◆ VariableParameters()

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

Definition at line 55 of file MnUserParameters.h.

Member Data Documentation

◆ fTransformation

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

Definition at line 112 of file MnUserParameters.h.

Libraries for ROOT::Minuit2::MnUserParameters:
[legend]
The documentation for this class was generated from the following files: