Logo ROOT  

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

class holding the full result of the minimization; both internal and external (MnUserParameterState) representation available for the parameters at the Minimum

Definition at line 37 of file FunctionMinimum.h.

Classes

struct  Data
 

Public Types

enum  Status { MnValid , MnReachedCallLimit , MnAboveMaxEdm }
 

Public Member Functions

 FunctionMinimum (const MinimumSeed &seed, const std::vector< MinimumState > &states, double up, Status status=MnValid)
 Constructor at the end of a minimization from seed and vector of states.
 
 FunctionMinimum (const MinimumSeed &seed, double up)
 Constructor from only MinimumSeed. Minimum is only from seed result not the full minimization.
 
void Add (const MinimumState &state, Status status=MnValid)
 add latest minimization state (for example add Hesse result after Migrad)
 
double Edm () const
 
const MinimumError & Error () const
 
double Fval () const
 
const FunctionGradient & Grad () const
 
bool HasAccurateCovar () const
 
bool HasCovariance () const
 
bool HasMadePosDefCovar () const
 
bool HasPosDefCovar () const
 
bool HasReachedCallLimit () const
 
bool HasValidCovariance () const
 
bool HasValidParameters () const
 
bool HesseFailed () const
 
bool IsAboveMaxEdm () const
 
bool IsValid () const
 
int NFcn () const
 
const MinimumParameters & Parameters () const
 
const MinimumSeed & Seed () const
 
void SetErrorDef (double up)
 
const MinimumState & State () const
 
const std::vector< MinimumState > & States () const
 
double Up () const
 
const MnUserCovariance & UserCovariance () const
 
const MnUserParameters & UserParameters () const
 
const MnUserParameterState & UserState () const
 

Private Attributes

std::shared_ptr< Data > fPtr
 

#include <Minuit2/FunctionMinimum.h>

Member Enumeration Documentation

◆ Status

enum ROOT::Minuit2::FunctionMinimum::Status
Enumerator
MnValid 
MnReachedCallLimit 
MnAboveMaxEdm 

Definition at line 40 of file FunctionMinimum.h.

Constructor & Destructor Documentation

◆ FunctionMinimum() [1/2]

ROOT::Minuit2::FunctionMinimum::FunctionMinimum ( const MinimumSeed &  seed,
double  up 
)
inline

Constructor from only MinimumSeed. Minimum is only from seed result not the full minimization.

Definition at line 48 of file FunctionMinimum.h.

◆ FunctionMinimum() [2/2]

ROOT::Minuit2::FunctionMinimum::FunctionMinimum ( const MinimumSeed &  seed,
const std::vector< MinimumState > &  states,
double  up,
Status  status = MnValid 
)
inline

Constructor at the end of a minimization from seed and vector of states.

Definition at line 57 of file FunctionMinimum.h.

Member Function Documentation

◆ Add()

void ROOT::Minuit2::FunctionMinimum::Add ( const MinimumState &  state,
Status  status = MnValid 
)
inline

add latest minimization state (for example add Hesse result after Migrad)

Definition at line 63 of file FunctionMinimum.h.

◆ Edm()

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

Definition at line 92 of file FunctionMinimum.h.

◆ Error()

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

Definition at line 89 of file FunctionMinimum.h.

◆ Fval()

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

Definition at line 91 of file FunctionMinimum.h.

◆ Grad()

const FunctionGradient & ROOT::Minuit2::FunctionMinimum::Grad ( ) const
inline

Definition at line 90 of file FunctionMinimum.h.

◆ HasAccurateCovar()

bool ROOT::Minuit2::FunctionMinimum::HasAccurateCovar ( ) const
inline

Definition at line 99 of file FunctionMinimum.h.

◆ HasCovariance()

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

Definition at line 103 of file FunctionMinimum.h.

◆ HasMadePosDefCovar()

bool ROOT::Minuit2::FunctionMinimum::HasMadePosDefCovar ( ) const
inline

Definition at line 101 of file FunctionMinimum.h.

◆ HasPosDefCovar()

bool ROOT::Minuit2::FunctionMinimum::HasPosDefCovar ( ) const
inline

Definition at line 100 of file FunctionMinimum.h.

◆ HasReachedCallLimit()

bool ROOT::Minuit2::FunctionMinimum::HasReachedCallLimit ( ) const
inline

Definition at line 105 of file FunctionMinimum.h.

◆ HasValidCovariance()

bool ROOT::Minuit2::FunctionMinimum::HasValidCovariance ( ) const
inline

Definition at line 98 of file FunctionMinimum.h.

◆ HasValidParameters()

bool ROOT::Minuit2::FunctionMinimum::HasValidParameters ( ) const
inline

Definition at line 97 of file FunctionMinimum.h.

◆ HesseFailed()

bool ROOT::Minuit2::FunctionMinimum::HesseFailed ( ) const
inline

Definition at line 102 of file FunctionMinimum.h.

◆ IsAboveMaxEdm()

bool ROOT::Minuit2::FunctionMinimum::IsAboveMaxEdm ( ) const
inline

Definition at line 104 of file FunctionMinimum.h.

◆ IsValid()

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

Definition at line 96 of file FunctionMinimum.h.

◆ NFcn()

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

Definition at line 93 of file FunctionMinimum.h.

◆ Parameters()

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

Definition at line 88 of file FunctionMinimum.h.

◆ Seed()

const MinimumSeed & ROOT::Minuit2::FunctionMinimum::Seed ( ) const
inline

Definition at line 73 of file FunctionMinimum.h.

◆ SetErrorDef()

void ROOT::Minuit2::FunctionMinimum::SetErrorDef ( double  up)
inline

Definition at line 107 of file FunctionMinimum.h.

◆ State()

const MinimumState & ROOT::Minuit2::FunctionMinimum::State ( ) const
inline

Definition at line 87 of file FunctionMinimum.h.

◆ States()

const std::vector< MinimumState > & ROOT::Minuit2::FunctionMinimum::States ( ) const
inline

Definition at line 74 of file FunctionMinimum.h.

◆ Up()

double ROOT::Minuit2::FunctionMinimum::Up ( ) const
inline

Definition at line 95 of file FunctionMinimum.h.

◆ UserCovariance()

const MnUserCovariance & ROOT::Minuit2::FunctionMinimum::UserCovariance ( ) const
inline

Definition at line 84 of file FunctionMinimum.h.

◆ UserParameters()

const MnUserParameters & ROOT::Minuit2::FunctionMinimum::UserParameters ( ) const
inline

Definition at line 83 of file FunctionMinimum.h.

◆ UserState()

const MnUserParameterState & ROOT::Minuit2::FunctionMinimum::UserState ( ) const
inline

Definition at line 77 of file FunctionMinimum.h.

Member Data Documentation

◆ fPtr

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

Definition at line 124 of file FunctionMinimum.h.

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