ROOT::Minuit2::BasicFunctionMinimum Class Reference

Description

result of the minimization; both internal and external (MnUserParameterState) representation available For the parameters at the Minimum

Definition at line 34 of file BasicFunctionMinimum.h.

Collaboration diagram for ROOT::Minuit2::BasicFunctionMinimum:

Classes
class	MnAboveMaxEdm
class	MnReachedCallLimit

Public Member Functions
	BasicFunctionMinimum (const BasicFunctionMinimum &min)
	copy constructor More...
	BasicFunctionMinimum (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...
	BasicFunctionMinimum (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...
	BasicFunctionMinimum (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...
	BasicFunctionMinimum (const MinimumSeed &seed, double up)
	constructor from only MinimumSeed. Minimum is only from seed result not the full minimization More...
	~BasicFunctionMinimum ()
void	Add (const MinimumState &state)
	add latest minimization state (for example add Hesse result after Migrad) More...
void	Add (const MinimumState &state, MnAboveMaxEdm)
	Add a new state and flag that edm is above maximum. More...
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
void	operator delete (void *p, size_t)
void *	operator new (size_t nbytes)
BasicFunctionMinimum &	operator= (const BasicFunctionMinimum &min)
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
bool	fAboveMaxEdm
double	fErrorDef
bool	fReachedCallLimit
MinimumSeed	fSeed
std::vector< MinimumState >	fStates
MnUserParameterState	fUserState

Constructor & Destructor Documentation

BasicFunctionMinimum() [1/5]

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

inline

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

Definition at line 44 of file BasicFunctionMinimum.h.

: fSeed(seed), fStates(std::vector<MinimumState>(1, MinimumState(seed.Parameters(), seed.Error(), seed.Gradient(), seed.Parameters().Fval(), seed.NFcn()))), fErrorDef(up), fAboveMaxEdm(false), fReachedCallLimit(false), fUserState(MnUserParameterState()) {}

BasicFunctionMinimum() [2/5]

ROOT::Minuit2::BasicFunctionMinimum::BasicFunctionMinimum ( 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 47 of file BasicFunctionMinimum.h.

: fSeed(seed), fStates(states), fErrorDef(up), fAboveMaxEdm(false), fReachedCallLimit(false), fUserState(MnUserParameterState()) {}

BasicFunctionMinimum() [3/5]

ROOT::Minuit2::BasicFunctionMinimum::BasicFunctionMinimum ( 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 50 of file BasicFunctionMinimum.h.

: fSeed(seed), fStates(states), fErrorDef(up), fAboveMaxEdm(false), fReachedCallLimit(true), fUserState(MnUserParameterState()) {}

BasicFunctionMinimum() [4/5]

ROOT::Minuit2::BasicFunctionMinimum::BasicFunctionMinimum ( 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 53 of file BasicFunctionMinimum.h.

: fSeed(seed), fStates(states), fErrorDef(up), fAboveMaxEdm(true), fReachedCallLimit(false), fUserState(MnUserParameterState()) {}

BasicFunctionMinimum() [5/5]

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

inline

copy constructor

Definition at line 56 of file BasicFunctionMinimum.h.

: fSeed(min.fSeed), fStates(min.fStates), fErrorDef(min.fErrorDef), fAboveMaxEdm(min.fAboveMaxEdm), fReachedCallLimit(min.fReachedCallLimit), fUserState(min.fUserState) {}

~BasicFunctionMinimum()

ROOT::Minuit2::BasicFunctionMinimum::~BasicFunctionMinimum ( )

inline

Definition at line 68 of file BasicFunctionMinimum.h.

{}

Member Function Documentation

Add() [1/2]

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

inline

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

Definition at line 71 of file BasicFunctionMinimum.h.

                                        {
      fStates.push_back(state);
      // LM : update also the user state
      fUserState = MnUserParameterState(State(), Up(), Seed().Trafo());
      // reset maxedm flag. If new state has edm over max other method must be used
      fAboveMaxEdm = false;
   }

References fAboveMaxEdm, fStates, fUserState, Seed(), State(), and Up().

Referenced by Add().

Here is the call graph for this function:

Add() [2/2]

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

inline

Add a new state and flag that edm is above maximum.

Definition at line 80 of file BasicFunctionMinimum.h.

                                                      {
      Add(state);
      fAboveMaxEdm = true;
   }

References Add(), and fAboveMaxEdm.

Here is the call graph for this function:

Edm()

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

inline

Definition at line 119 of file BasicFunctionMinimum.h.

{return fStates.back().Edm();}

References fStates.

Error()

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

inline

Definition at line 116 of file BasicFunctionMinimum.h.

{return fStates.back().Error();}

References fStates.

Fval()

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

inline

Definition at line 118 of file BasicFunctionMinimum.h.

{return fStates.back().Fval();}

References fStates.

Grad()

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

inline

Definition at line 117 of file BasicFunctionMinimum.h.

{return fStates.back().Gradient();}

References fStates.

HasAccurateCovar()

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

inline

Definition at line 128 of file BasicFunctionMinimum.h.

{return State().Error().IsAccurate();}

References ROOT::Minuit2::MinimumState::Error(), ROOT::Minuit2::MinimumError::IsAccurate(), and State().

Here is the call graph for this function:

HasCovariance()

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

inline

Definition at line 132 of file BasicFunctionMinimum.h.

{return State().Error().IsAvailable();}

References ROOT::Minuit2::MinimumState::Error(), ROOT::Minuit2::MinimumError::IsAvailable(), and State().

Here is the call graph for this function:

HasMadePosDefCovar()

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

inline

Definition at line 130 of file BasicFunctionMinimum.h.

{return State().Error().IsMadePosDef();}

References ROOT::Minuit2::MinimumState::Error(), ROOT::Minuit2::MinimumError::IsMadePosDef(), and State().

Here is the call graph for this function:

HasPosDefCovar()

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

inline

Definition at line 129 of file BasicFunctionMinimum.h.

{return State().Error().IsPosDef();}

References ROOT::Minuit2::MinimumState::Error(), ROOT::Minuit2::MinimumError::IsPosDef(), and State().

Here is the call graph for this function:

HasReachedCallLimit()

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

inline

Definition at line 134 of file BasicFunctionMinimum.h.

{return fReachedCallLimit;}

References fReachedCallLimit.

Referenced by IsValid().

HasValidCovariance()

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

inline

Definition at line 127 of file BasicFunctionMinimum.h.

{return State().Error().IsValid();}

References ROOT::Minuit2::MinimumState::Error(), ROOT::Minuit2::MinimumError::IsValid(), and State().

Here is the call graph for this function:

HasValidParameters()

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

inline

Definition at line 126 of file BasicFunctionMinimum.h.

{return State().Parameters().IsValid();}

References ROOT::Minuit2::MinimumParameters::IsValid(), ROOT::Minuit2::MinimumState::Parameters(), and State().

Here is the call graph for this function:

HesseFailed()

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

inline

Definition at line 131 of file BasicFunctionMinimum.h.

{return State().Error().HesseFailed();}

References ROOT::Minuit2::MinimumState::Error(), ROOT::Minuit2::MinimumError::HesseFailed(), and State().

Here is the call graph for this function:

IsAboveMaxEdm()

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

inline

Definition at line 133 of file BasicFunctionMinimum.h.

{return fAboveMaxEdm;}

References fAboveMaxEdm.

Referenced by IsValid().

IsValid()

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

inline

Definition at line 123 of file BasicFunctionMinimum.h.

                        {
      return State().IsValid() && !IsAboveMaxEdm() && !HasReachedCallLimit();
   }

References HasReachedCallLimit(), IsAboveMaxEdm(), ROOT::Minuit2::MinimumState::IsValid(), and State().

Here is the call graph for this function:

NFcn()

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

inline

Definition at line 120 of file BasicFunctionMinimum.h.

{return fStates.back().NFcn();}

References fStates.

operator delete()

void ROOT::Minuit2::BasicFunctionMinimum::operator delete ( void *  p, size_t    )

inline

Definition at line 109 of file BasicFunctionMinimum.h.

                                           {
      StackAllocatorHolder::Get().Deallocate(p);
   }

References ROOT::Minuit2::StackAllocator::Deallocate(), and ROOT::Minuit2::StackAllocatorHolder::Get().

Here is the call graph for this function:

operator new()

void* ROOT::Minuit2::BasicFunctionMinimum::operator new ( size_t  nbytes )

inline

Definition at line 105 of file BasicFunctionMinimum.h.

                                     {
      return StackAllocatorHolder::Get().Allocate(nbytes);
   }

References ROOT::Minuit2::StackAllocator::Allocate(), and ROOT::Minuit2::StackAllocatorHolder::Get().

Here is the call graph for this function:

operator=()

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

inline

Definition at line 58 of file BasicFunctionMinimum.h.

                                                                    {
      fSeed = min.fSeed;
      fStates = min.fStates;
      fErrorDef = min.fErrorDef;
      fAboveMaxEdm = min.fAboveMaxEdm;
      fReachedCallLimit = min.fReachedCallLimit;
      fUserState = min.fUserState;
      return *this;
   }

References fAboveMaxEdm, fErrorDef, fReachedCallLimit, fSeed, fStates, and fUserState.

Parameters()

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

inline

Definition at line 115 of file BasicFunctionMinimum.h.

{return fStates.back().Parameters();}

References fStates.

Seed()

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

inline

Definition at line 85 of file BasicFunctionMinimum.h.

{return fSeed;}

References fSeed.

Referenced by Add(), SetErrorDef(), UserCovariance(), UserParameters(), and UserState().

SetErrorDef()

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

inline

Definition at line 136 of file BasicFunctionMinimum.h.

                                {
      fErrorDef = up;
      // update user state for new valeu of up (scaling of errors)
      fUserState = MnUserParameterState(State(), up, Seed().Trafo());
   }

References fErrorDef, fUserState, Seed(), and State().

Here is the call graph for this function:

State()

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

inline

Definition at line 114 of file BasicFunctionMinimum.h.

{return fStates.back();}

References fStates.

Referenced by Add(), HasAccurateCovar(), HasCovariance(), HasMadePosDefCovar(), HasPosDefCovar(), HasValidCovariance(), HasValidParameters(), HesseFailed(), IsValid(), SetErrorDef(), UserCovariance(), UserParameters(), and UserState().

States()

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

inline

Definition at line 86 of file BasicFunctionMinimum.h.

{return fStates;}

References fStates.

Up()

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

inline

Definition at line 122 of file BasicFunctionMinimum.h.

{return fErrorDef;}

References fErrorDef.

Referenced by Add(), UserCovariance(), UserParameters(), and UserState().

UserCovariance()

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

inline

Definition at line 99 of file BasicFunctionMinimum.h.

                                                  {
      if(!fUserState.IsValid())
         fUserState = MnUserParameterState(State(), Up(), Seed().Trafo());
      return fUserState.Covariance();
   }

References ROOT::Minuit2::MnUserParameterState::Covariance(), fUserState, ROOT::Minuit2::MnUserParameterState::IsValid(), Seed(), State(), and Up().

Here is the call graph for this function:

UserParameters()

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

inline

Definition at line 94 of file BasicFunctionMinimum.h.

                                                  {
      if(!fUserState.IsValid())
         fUserState = MnUserParameterState(State(), Up(), Seed().Trafo());
      return fUserState.Parameters();
   }

References fUserState, ROOT::Minuit2::MnUserParameterState::IsValid(), ROOT::Minuit2::MnUserParameterState::Parameters(), Seed(), State(), and Up().

Here is the call graph for this function:

UserState()

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

inline

Definition at line 89 of file BasicFunctionMinimum.h.

                                                 {
      if(!fUserState.IsValid())
         fUserState = MnUserParameterState(State(), Up(), Seed().Trafo());
      return fUserState;
   }

References fUserState, ROOT::Minuit2::MnUserParameterState::IsValid(), Seed(), State(), and Up().

Here is the call graph for this function:

Member Data Documentation

fAboveMaxEdm

bool ROOT::Minuit2::BasicFunctionMinimum::fAboveMaxEdm

private

Definition at line 147 of file BasicFunctionMinimum.h.

Referenced by Add(), IsAboveMaxEdm(), and operator=().

fErrorDef

double ROOT::Minuit2::BasicFunctionMinimum::fErrorDef

private

Definition at line 146 of file BasicFunctionMinimum.h.

Referenced by operator=(), SetErrorDef(), and Up().

fReachedCallLimit

bool ROOT::Minuit2::BasicFunctionMinimum::fReachedCallLimit

private

Definition at line 148 of file BasicFunctionMinimum.h.

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

fSeed

MinimumSeed ROOT::Minuit2::BasicFunctionMinimum::fSeed

private

Definition at line 144 of file BasicFunctionMinimum.h.

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

fStates

std::vector<MinimumState> ROOT::Minuit2::BasicFunctionMinimum::fStates

private

Definition at line 145 of file BasicFunctionMinimum.h.

Referenced by Add(), Edm(), Error(), Fval(), Grad(), NFcn(), operator=(), Parameters(), State(), and States().

fUserState

MnUserParameterState ROOT::Minuit2::BasicFunctionMinimum::fUserState

mutableprivate

Definition at line 149 of file BasicFunctionMinimum.h.

Referenced by Add(), operator=(), SetErrorDef(), 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/BasicFunctionMinimum.h