Mantid
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Attributes | List of all members
Mantid::CurveFitting::Algorithms::JacobianImpl Class Reference

The implementation of Jacobian. More...

Inheritance diagram for Mantid::CurveFitting::Algorithms::JacobianImpl:
Mantid::API::Jacobian

Public Member Functions

double get (size_t iY, size_t iP) override
 Get a value to a Jacobian matrix element. More...
 
 JacobianImpl ()
 Default constructor. More...
 
void set (size_t iY, size_t iP, double value) override
 Set a value to a Jacobian matrix element. More...
 
void setJ (gsl_matrix *J)
 Set the pointer to the GSL's jacobian. More...
 
void zero () override
 Zero all matrix elements. More...
 
- Public Member Functions inherited from Mantid::API::Jacobian
virtual double get (size_t iY, size_t iP)=0
 Get the value to a Jacobian matrix element. More...
 
virtual void set (size_t iY, size_t iP, double value)=0
 Set a value to a Jacobian matrix element. More...
 
virtual void zero ()=0
 Zero all matrix elements. More...
 
virtual ~Jacobian ()=default
 Virtual destructor. More...
 

Public Attributes

std::map< int, int > m_map
 The index map. More...
 

Private Attributes

gsl_matrix * m_J
 The pointer to the GSL's internal jacobian matrix. More...
 

Detailed Description

The implementation of Jacobian.

Definition at line 41 of file Fit1D.cpp.

Constructor & Destructor Documentation

◆ JacobianImpl()

Mantid::CurveFitting::Algorithms::JacobianImpl::JacobianImpl ( )
inline

Default constructor.

Definition at line 44 of file Fit1D.cpp.

Member Function Documentation

◆ get()

double Mantid::CurveFitting::Algorithms::JacobianImpl::get ( size_t  iY,
size_t  iP 
)
inlineoverridevirtual

Get a value to a Jacobian matrix element.

Parameters
iY:: The index of the data point.
iP:: The index of the parameter. It does not depend on the number of fixed parameters in a particular fit.

Implements Mantid::API::Jacobian.

Definition at line 64 of file Fit1D.cpp.

References m_J, and m_map.

◆ set()

void Mantid::CurveFitting::Algorithms::JacobianImpl::set ( size_t  iY,
size_t  iP,
double  value 
)
inlineoverridevirtual

Set a value to a Jacobian matrix element.

Parameters
iY:: The index of the data point.
iP:: The index of the parameter. It does not depend on the number of fixed parameters in a particular fit.
value:: The derivative value.

Implements Mantid::API::Jacobian.

Definition at line 54 of file Fit1D.cpp.

References m_J, m_map, and value.

◆ setJ()

void Mantid::CurveFitting::Algorithms::JacobianImpl::setJ ( gsl_matrix *  J)
inline

Set the pointer to the GSL's jacobian.

Definition at line 74 of file Fit1D.cpp.

References m_J.

Referenced by Mantid::CurveFitting::Algorithms::Fit1D::exec().

◆ zero()

void Mantid::CurveFitting::Algorithms::JacobianImpl::zero ( )
inlineoverridevirtual

Zero all matrix elements.

Implements Mantid::API::Jacobian.

Definition at line 72 of file Fit1D.cpp.

References m_J.

Member Data Documentation

◆ m_J

gsl_matrix* Mantid::CurveFitting::Algorithms::JacobianImpl::m_J
private

The pointer to the GSL's internal jacobian matrix.

Definition at line 78 of file Fit1D.cpp.

Referenced by get(), set(), setJ(), and zero().

◆ m_map

std::map<int, int> Mantid::CurveFitting::Algorithms::JacobianImpl::m_map

The index map.

Definition at line 47 of file Fit1D.cpp.

Referenced by Mantid::CurveFitting::Algorithms::FitData::FitData(), get(), and set().


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