Logo ROOT  

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

MinimumState keeps the information (position, Gradient, 2nd deriv, etc) after one minimization step (usually in MinimumBuilder).

Definition at line 27 of file MinimumState.h.

Classes

struct  Data
 

Public Member Functions

 MinimumState (const MinimumParameters &states, const MinimumError &err, const FunctionGradient &grad, double edm, int nfcn)
 Constructor with parameters values, errors and gradient.
 
 MinimumState (const MinimumParameters &states, double edm, int nfcn)
 Constructor with only parameter values, edm and nfcn, but without errors (covariance).
 
 MinimumState (double fval, double edm, int nfcn)
 Constructor without parameter values, but with function value, edm and nfcn.
 
 MinimumState (unsigned int n)
 Invalid state.
 
double Edm () const
 
const MinimumError & Error () const
 
double Fval () const
 
const FunctionGradient & Gradient () const
 
bool HasCovariance () const
 
bool HasParameters () const
 
bool IsValid () const
 
int NFcn () const
 
const MinimumParameters & Parameters () const
 
int size () const
 
const MnAlgebraicVector & Vec () const
 

Private Attributes

std::shared_ptr< Data > fPtr
 

#include <Minuit2/MinimumState.h>

Constructor & Destructor Documentation

◆ MinimumState() [1/4]

ROOT::Minuit2::MinimumState::MinimumState ( unsigned int  n)
inline

Invalid state.

Definition at line 31 of file MinimumState.h.

◆ MinimumState() [2/4]

ROOT::Minuit2::MinimumState::MinimumState ( double  fval,
double  edm,
int  nfcn 
)
inline

Constructor without parameter values, but with function value, edm and nfcn.

This constructor will result in a state that is flagged as not valid

Definition at line 37 of file MinimumState.h.

◆ MinimumState() [3/4]

ROOT::Minuit2::MinimumState::MinimumState ( const MinimumParameters &  states,
double  edm,
int  nfcn 
)
inline

Constructor with only parameter values, edm and nfcn, but without errors (covariance).

The resulting state it will be considered valid, since it contains the parameter values, although it has not the error matrix (MinimumError) and HasCovariance() returns false.

Definition at line 45 of file MinimumState.h.

◆ MinimumState() [4/4]

ROOT::Minuit2::MinimumState::MinimumState ( const MinimumParameters &  states,
const MinimumError &  err,
const FunctionGradient &  grad,
double  edm,
int  nfcn 
)
inline

Constructor with parameters values, errors and gradient.

Definition at line 51 of file MinimumState.h.

Member Function Documentation

◆ Edm()

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

Definition at line 64 of file MinimumState.h.

◆ Error()

const MinimumError & ROOT::Minuit2::MinimumState::Error ( ) const
inline

Definition at line 61 of file MinimumState.h.

◆ Fval()

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

Definition at line 63 of file MinimumState.h.

◆ Gradient()

const FunctionGradient & ROOT::Minuit2::MinimumState::Gradient ( ) const
inline

Definition at line 62 of file MinimumState.h.

◆ HasCovariance()

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

Definition at line 78 of file MinimumState.h.

◆ HasParameters()

bool ROOT::Minuit2::MinimumState::HasParameters ( ) const
inline

Definition at line 77 of file MinimumState.h.

◆ IsValid()

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

Definition at line 67 of file MinimumState.h.

◆ NFcn()

int ROOT::Minuit2::MinimumState::NFcn ( ) const
inline

Definition at line 65 of file MinimumState.h.

◆ Parameters()

const MinimumParameters & ROOT::Minuit2::MinimumState::Parameters ( ) const
inline

Definition at line 57 of file MinimumState.h.

◆ size()

int ROOT::Minuit2::MinimumState::size ( ) const
inline

Definition at line 59 of file MinimumState.h.

◆ Vec()

const MnAlgebraicVector & ROOT::Minuit2::MinimumState::Vec ( ) const
inline

Definition at line 58 of file MinimumState.h.

Member Data Documentation

◆ fPtr

std::shared_ptr<Data> ROOT::Minuit2::MinimumState::fPtr
private

Definition at line 89 of file MinimumState.h.

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