BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FitOptions Class Reference

General fitting options. More...

Public Member Functions

 FitOptions ()
 
double derivEpsilon () const
 
void setDerivEpsilon (double deriv_epsilon)
 
void setStepFactor (double step_factor)
 
double stepFactor () const
 

Private Attributes

double m_deriv_epsilon
 epsilon for derivative calculation More...
 
double m_step_factor
 default relative parameter step More...
 

Detailed Description

General fitting options.

Definition at line 20 of file FitOptions.h.

Constructor & Destructor Documentation

◆ FitOptions()

FitOptions::FitOptions ( )

Definition at line 17 of file FitOptions.cpp.

17 : m_deriv_epsilon(1e-09), m_step_factor(0.01) {}
double m_deriv_epsilon
epsilon for derivative calculation
Definition: FitOptions.h:31
double m_step_factor
default relative parameter step
Definition: FitOptions.h:32

Member Function Documentation

◆ derivEpsilon()

double FitOptions::derivEpsilon ( ) const

Definition at line 34 of file FitOptions.cpp.

35 {
36  return m_deriv_epsilon;
37 }

References m_deriv_epsilon.

◆ setDerivEpsilon()

void FitOptions::setDerivEpsilon ( double  deriv_epsilon)

Definition at line 29 of file FitOptions.cpp.

30 {
31  m_deriv_epsilon = deriv_epsilon;
32 }

References m_deriv_epsilon.

◆ setStepFactor()

void FitOptions::setStepFactor ( double  step_factor)

Definition at line 19 of file FitOptions.cpp.

20 {
21  m_step_factor = step_factor;
22 }

References m_step_factor.

◆ stepFactor()

double FitOptions::stepFactor ( ) const

Definition at line 24 of file FitOptions.cpp.

25 {
26  return m_step_factor;
27 }

References m_step_factor.

Member Data Documentation

◆ m_deriv_epsilon

double FitOptions::m_deriv_epsilon
private

epsilon for derivative calculation

Definition at line 31 of file FitOptions.h.

Referenced by derivEpsilon(), and setDerivEpsilon().

◆ m_step_factor

double FitOptions::m_step_factor
private

default relative parameter step

Definition at line 32 of file FitOptions.h.

Referenced by setStepFactor(), and stepFactor().


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