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

Description

GSLSimAnnealing class for performing a simulated annealing search of a multidimensional function

Definition at line 193 of file GSLSimAnnealing.h.

Collaboration diagram for ROOT::Math::GSLSimAnnealing:
[legend]

Public Member Functions

 GSLSimAnnealing ()
 
 ~GSLSimAnnealing ()
 
GSLSimAnParamsParams ()
 
const GSLSimAnParamsParams () const
 
void SetParams (const GSLSimAnParams &params)
 
int Solve (const ROOT::Math::IMultiGenFunction &func, const double *x0, const double *scale, double *xmin, bool debug=false)
 
int Solve (GSLSimAnFunc &func, bool debug=false)
 

Private Member Functions

 GSLSimAnnealing (const GSLSimAnnealing &)
 
GSLSimAnnealingoperator= (const GSLSimAnnealing &rhs)
 

Private Attributes

GSLSimAnParams fParams
 

Constructor & Destructor Documentation

◆ GSLSimAnnealing() [1/2]

ROOT::Math::GSLSimAnnealing::GSLSimAnnealing ( )

Default constructor

◆ ~GSLSimAnnealing()

ROOT::Math::GSLSimAnnealing::~GSLSimAnnealing ( )
inline

Destructor (no operations)

Definition at line 205 of file GSLSimAnnealing.h.

205 {}

◆ GSLSimAnnealing() [2/2]

ROOT::Math::GSLSimAnnealing::GSLSimAnnealing ( const GSLSimAnnealing )
inlineprivate

Copy constructor

Definition at line 213 of file GSLSimAnnealing.h.

213 {}

Member Function Documentation

◆ operator=()

GSLSimAnnealing& ROOT::Math::GSLSimAnnealing::operator= ( const GSLSimAnnealing rhs)
inlineprivate

Assignment operator

Definition at line 218 of file GSLSimAnnealing.h.

218  {
219  if (this == &rhs) return *this; // time saving self-test
220  return *this;
221  }

◆ Params() [1/2]

GSLSimAnParams& ROOT::Math::GSLSimAnnealing::Params ( )
inline

Definition at line 239 of file GSLSimAnnealing.h.

239 { return fParams; }

References fParams.

◆ Params() [2/2]

const GSLSimAnParams& ROOT::Math::GSLSimAnnealing::Params ( ) const
inline

Definition at line 240 of file GSLSimAnnealing.h.

240 { return fParams; }

References fParams.

◆ SetParams()

void ROOT::Math::GSLSimAnnealing::SetParams ( const GSLSimAnParams params)
inline

Definition at line 241 of file GSLSimAnnealing.h.

241 { fParams = params; }

References fParams.

◆ Solve() [1/2]

int ROOT::Math::GSLSimAnnealing::Solve ( const ROOT::Math::IMultiGenFunction func,
const double *  x0,
const double *  scale,
double *  xmin,
bool  debug = false 
)

solve the simulated annealing given a multi-dim function, the initial vector parameters and a vector containing the scaling factors for the parameters

◆ Solve() [2/2]

int ROOT::Math::GSLSimAnnealing::Solve ( GSLSimAnFunc func,
bool  debug = false 
)

solve the simulated annealing given a GSLSimAnFunc object The object will contain the initial state at the beginning and the final minimum state at the end

Member Data Documentation

◆ fParams

GSLSimAnParams ROOT::Math::GSLSimAnnealing::fParams
private

Definition at line 249 of file GSLSimAnnealing.h.

Referenced by Params(), and SetParams().


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