BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
ROOT::Minuit2::MinimumState Class Reference

Description

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

Definition at line 29 of file MinimumState.h.

Collaboration diagram for ROOT::Minuit2::MinimumState:
[legend]

Public Member Functions

 MinimumState (const MinimumParameters &states, const MinimumError &err, const FunctionGradient &grad, double edm, int nfcn)
 
 MinimumState (const MinimumParameters &states, double edm, int nfcn)
 
 MinimumState (const MinimumState &state)
 
 MinimumState (double fval, double edm, int nfcn)
 
 MinimumState (unsigned int n)
 
 ~MinimumState ()
 
double Edm () const
 
const MinimumErrorError () const
 
double Fval () const
 
const FunctionGradientGradient () const
 
bool HasCovariance () const
 
bool HasParameters () const
 
bool IsValid () const
 
int NFcn () const
 
MinimumStateoperator= (const MinimumState &state)
 
const MinimumParametersParameters () const
 
int size () const
 
const MnAlgebraicVectorVec () const
 

Private Attributes

MnRefCountedPointer< BasicMinimumStatefData
 

Constructor & Destructor Documentation

◆ MinimumState() [1/5]

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

invalid state

Definition at line 34 of file MinimumState.h.

34  :
35  fData(MnRefCountedPointer<BasicMinimumState>(new BasicMinimumState(n,0.,0.,0.))) {}
MnRefCountedPointer< BasicMinimumState > fData
Definition: MinimumState.h:75

◆ MinimumState() [2/5]

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

state without parameters and errors (only function value an, edm and nfcn)

Definition at line 37 of file MinimumState.h.

37  :
38  fData(MnRefCountedPointer<BasicMinimumState>(new BasicMinimumState(0, fval, edm, nfcn))) {}

◆ MinimumState() [3/5]

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

state with parameters only (from stepping methods like Simplex, Scan)

Definition at line 40 of file MinimumState.h.

40  :
41  fData(MnRefCountedPointer<BasicMinimumState>(new BasicMinimumState(states, edm, nfcn))) {}

◆ MinimumState() [4/5]

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

state with parameters, Gradient and covariance (from Gradient methods such as Migrad)

Definition at line 45 of file MinimumState.h.

46  :
47  fData(MnRefCountedPointer<BasicMinimumState>(new BasicMinimumState(states, err, grad, edm, nfcn))) {}

◆ ~MinimumState()

ROOT::Minuit2::MinimumState::~MinimumState ( )
inline

Definition at line 49 of file MinimumState.h.

49 {}

◆ MinimumState() [5/5]

ROOT::Minuit2::MinimumState::MinimumState ( const MinimumState state)
inline

Definition at line 51 of file MinimumState.h.

51 : fData(state.fData) {}

Member Function Documentation

◆ Edm()

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

Definition at line 65 of file MinimumState.h.

65 {return fData->Edm();}

References fData.

Referenced by ROOT::Minuit2::BasicMinimumSeed::Edm().

◆ Error()

◆ Fval()

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

Definition at line 64 of file MinimumState.h.

64 {return fData->Fval();}

References fData.

Referenced by ROOT::Minuit2::BasicMinimumSeed::Fval().

◆ Gradient()

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

Definition at line 63 of file MinimumState.h.

63 {return fData->Gradient();}

References fData.

Referenced by ROOT::Minuit2::BasicMinimumSeed::Gradient().

◆ HasCovariance()

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

Definition at line 71 of file MinimumState.h.

71 {return fData->HasCovariance();}

References fData.

◆ HasParameters()

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

Definition at line 70 of file MinimumState.h.

70 {return fData->HasParameters();}

References fData.

◆ IsValid()

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

Definition at line 68 of file MinimumState.h.

68 {return fData->IsValid();}

References fData.

Referenced by ROOT::Minuit2::BasicFunctionMinimum::IsValid().

◆ NFcn()

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

Definition at line 66 of file MinimumState.h.

66 {return fData->NFcn();}

References fData.

Referenced by ROOT::Minuit2::BasicMinimumSeed::NFcn().

◆ operator=()

MinimumState& ROOT::Minuit2::MinimumState::operator= ( const MinimumState state)
inline

Definition at line 53 of file MinimumState.h.

53  {
54  fData = state.fData;
55  return *this;
56  }

References fData.

◆ Parameters()

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

Definition at line 58 of file MinimumState.h.

58 {return fData->Parameters();}

References fData.

Referenced by ROOT::Minuit2::BasicFunctionMinimum::HasValidParameters(), and ROOT::Minuit2::BasicMinimumSeed::Parameters().

◆ size()

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

Definition at line 60 of file MinimumState.h.

60 {return fData->size();}

References fData.

◆ Vec()

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

Definition at line 59 of file MinimumState.h.

59 {return fData->Vec();}

References fData.

Member Data Documentation

◆ fData

MnRefCountedPointer<BasicMinimumState> ROOT::Minuit2::MinimumState::fData
private

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