ROOT::Minuit2::FunctionMinimum Class Reference

Description

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

Definition at line 30 of file FunctionMinimum.h.

Collaboration diagram for ROOT::Minuit2::FunctionMinimum:

Classes
class	MnAboveMaxEdm
class	MnReachedCallLimit

Public Member Functions
	FunctionMinimum (const FunctionMinimum &min)
	copy constructo More...
	FunctionMinimum (const MinimumSeed &seed, const std::vector< MinimumState > &states, double up)
	constructor at the end of a successfull minimization from seed and vector of states More...
	FunctionMinimum (const MinimumSeed &seed, const std::vector< MinimumState > &states, double up, MnAboveMaxEdm)
	constructor at the end of a failed minimization due to edm above maximum value More...
	FunctionMinimum (const MinimumSeed &seed, const std::vector< MinimumState > &states, double up, MnReachedCallLimit)
	constructor at the end of a failed minimization due to exceeding function call limit More...
	FunctionMinimum (const MinimumSeed &seed, double up)
	constructor from only MinimumSeed. Minimum is only from seed result not full minimization More...
	~FunctionMinimum ()
void	Add (const MinimumState &state)
void	Add (const MinimumState &state, MnAboveMaxEdm)
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
FunctionMinimum &	operator= (const FunctionMinimum &min)
const MinimumParameters &	Parameters () const
const MinimumSeed &	Seed () const
void	SetErrorDef (double up)
const MinimumState &	State () const
const std::vector< ROOT::Minuit2::MinimumState > &	States () const
double	Up () const
const MnUserCovariance &	UserCovariance () const
const MnUserParameters &	UserParameters () const
const MnUserParameterState &	UserState () const

Private Attributes
MnRefCountedPointer< BasicFunctionMinimum >	fData

Constructor & Destructor Documentation

FunctionMinimum() [1/5]

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

inline

constructor from only MinimumSeed. Minimum is only from seed result not full minimization

Definition at line 41 of file FunctionMinimum.h.

: fData(MnRefCountedPointer<BasicFunctionMinimum>(new BasicFunctionMinimum(seed, up))) {}

FunctionMinimum() [2/5]

ROOT::Minuit2::FunctionMinimum::FunctionMinimum ( const MinimumSeed &  seed, const std::vector< MinimumState > &  states, double  up  )

inline

constructor at the end of a successfull minimization from seed and vector of states

Definition at line 44 of file FunctionMinimum.h.

: fData(MnRefCountedPointer<BasicFunctionMinimum>(new BasicFunctionMinimum(seed, states, up))) {}

FunctionMinimum() [3/5]

ROOT::Minuit2::FunctionMinimum::FunctionMinimum ( const MinimumSeed &  seed, const std::vector< MinimumState > &  states, double  up, MnReachedCallLimit    )

inline

constructor at the end of a failed minimization due to exceeding function call limit

Definition at line 47 of file FunctionMinimum.h.

: fData(MnRefCountedPointer<BasicFunctionMinimum>(new BasicFunctionMinimum(seed, states, up, BasicFunctionMinimum::MnReachedCallLimit()))) {}

FunctionMinimum() [4/5]

ROOT::Minuit2::FunctionMinimum::FunctionMinimum ( const MinimumSeed &  seed, const std::vector< MinimumState > &  states, double  up, MnAboveMaxEdm    )

inline

constructor at the end of a failed minimization due to edm above maximum value

Definition at line 50 of file FunctionMinimum.h.

: fData(MnRefCountedPointer<BasicFunctionMinimum>(new BasicFunctionMinimum(seed, states, up, BasicFunctionMinimum::MnAboveMaxEdm()))) {}

FunctionMinimum() [5/5]

ROOT::Minuit2::FunctionMinimum::FunctionMinimum ( const FunctionMinimum &  min )

inline

copy constructo

Definition at line 53 of file FunctionMinimum.h.

: fData(min.fData) {}

~FunctionMinimum()

ROOT::Minuit2::FunctionMinimum::~FunctionMinimum ( )

inline

Definition at line 60 of file FunctionMinimum.h.

{}

Member Function Documentation

Add() [1/2]

void ROOT::Minuit2::FunctionMinimum::Add ( const MinimumState &  state )

inline

Definition at line 63 of file FunctionMinimum.h.

{fData->Add(state);}

References fData.

Add() [2/2]

void ROOT::Minuit2::FunctionMinimum::Add ( const MinimumState &  state, MnAboveMaxEdm    )

inline

Definition at line 66 of file FunctionMinimum.h.

{fData->Add(state,BasicFunctionMinimum::MnAboveMaxEdm());}

References fData.

Edm()

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

inline

Definition at line 88 of file FunctionMinimum.h.

{return fData->Edm();}

References fData.

Error()

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

inline

Definition at line 85 of file FunctionMinimum.h.

{return fData->Error();}

References fData.

Fval()

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

inline

Definition at line 87 of file FunctionMinimum.h.

{return fData->Fval();}

References fData.

Grad()

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

inline

Definition at line 86 of file FunctionMinimum.h.

{return fData->Grad();}

References fData.

HasAccurateCovar()

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

inline

Definition at line 95 of file FunctionMinimum.h.

{return fData->HasAccurateCovar();}

References fData.

HasCovariance()

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

inline

Definition at line 99 of file FunctionMinimum.h.

{return fData->HasCovariance();}

References fData.

HasMadePosDefCovar()

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

inline

Definition at line 97 of file FunctionMinimum.h.

{return fData->HasMadePosDefCovar();}

References fData.

HasPosDefCovar()

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

inline

Definition at line 96 of file FunctionMinimum.h.

{return fData->HasPosDefCovar();}

References fData.

HasReachedCallLimit()

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

inline

Definition at line 101 of file FunctionMinimum.h.

{return fData->HasReachedCallLimit();}

References fData.

HasValidCovariance()

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

inline

Definition at line 94 of file FunctionMinimum.h.

{return fData->HasValidCovariance();}

References fData.

HasValidParameters()

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

inline

Definition at line 93 of file FunctionMinimum.h.

{return fData->HasValidParameters();}

References fData.

HesseFailed()

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

inline

Definition at line 98 of file FunctionMinimum.h.

{return fData->HesseFailed();}

References fData.

IsAboveMaxEdm()

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

inline

Definition at line 100 of file FunctionMinimum.h.

{return fData->IsAboveMaxEdm();}

References fData.

IsValid()

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

inline

Definition at line 92 of file FunctionMinimum.h.

{return fData->IsValid();}

References fData.

NFcn()

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

inline

Definition at line 89 of file FunctionMinimum.h.

{return fData->NFcn();}

References fData.

operator=()

FunctionMinimum& ROOT::Minuit2::FunctionMinimum::operator= ( const FunctionMinimum &  min )

inline

Definition at line 55 of file FunctionMinimum.h.

                                                          {
      fData = min.fData;
      return *this;
   }

References fData.

Parameters()

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

inline

Definition at line 84 of file FunctionMinimum.h.

{return fData->Parameters();}

References fData.

Seed()

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

inline

Definition at line 68 of file FunctionMinimum.h.

{return fData->Seed();}

References fData.

SetErrorDef()

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

inline

Definition at line 103 of file FunctionMinimum.h.

{ return fData->SetErrorDef(up);}

References fData.

State()

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

inline

Definition at line 83 of file FunctionMinimum.h.

{return fData->State();}

References fData.

States()

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

inline

Definition at line 69 of file FunctionMinimum.h.

{return fData->States();}

References fData.

Up()

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

inline

Definition at line 91 of file FunctionMinimum.h.

{return fData->Up();}

References fData.

UserCovariance()

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

inline

Definition at line 78 of file FunctionMinimum.h.

                                                  {
      return fData->UserCovariance();
   }

References fData.

UserParameters()

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

inline

Definition at line 75 of file FunctionMinimum.h.

                                                  {
      return fData->UserParameters();
   }

References fData.

UserState()

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

inline

Definition at line 72 of file FunctionMinimum.h.

                                                 {
      return fData->UserState();
   }

References fData.

Member Data Documentation

fData

MnRefCountedPointer<BasicFunctionMinimum> ROOT::Minuit2::FunctionMinimum::fData

private

Definition at line 107 of file FunctionMinimum.h.

Referenced by Add(), Edm(), Error(), Fval(), Grad(), HasAccurateCovar(), HasCovariance(), HasMadePosDefCovar(), HasPosDefCovar(), HasReachedCallLimit(), HasValidCovariance(), HasValidParameters(), HesseFailed(), IsAboveMaxEdm(), IsValid(), NFcn(), operator=(), Parameters(), Seed(), SetErrorDef(), State(), States(), Up(), UserCovariance(), UserParameters(), and UserState().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/3rdparty/RootMinimizers/Minuit2/FunctionMinimum.h