Mantid::CurveFitting::Jacobian Class Reference

An implementation of Jacobian using std::vector. More...

#include <Jacobian.h>

Inheritance diagram for Mantid::CurveFitting::Jacobian:

Public Member Functions
void	addNumberToColumn (const double &value, const size_t &iP) override
	overwrite base method More...
double	get (size_t iY, size_t iP) override
	overwrite base method More...
	Jacobian (size_t ny, size_t np)
	Constructor. More...
void	set (size_t iY, size_t iP, double value) override
	overwrite base method More...
void	zero () override
	overwrite base method 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...

Private Attributes
std::vector< double >	m_data
	Storage for the derivatives. More...
size_t	m_np
	Number of parameters in a function (== IFunction::nParams()) More...
size_t	m_ny
	Number of data points. More...

Detailed Description

An implementation of Jacobian using std::vector.

Author

Roman Tolchenov

Date

17/02/2012

Definition at line 21 of file Jacobian.h.

Constructor & Destructor Documentation

Jacobian()

Mantid::CurveFitting::Jacobian::Jacobian ( size_t  ny, size_t  np  )

inline

Constructor.

Parameters

ny	:: Number of data points
np	:: Number of parameters

Definition at line 33 of file Jacobian.h.

References m_data.

Member Function Documentation

addNumberToColumn()

void Mantid::CurveFitting::Jacobian::addNumberToColumn ( const double &  value, const size_t &  iP  )

inlineoverride

overwrite base method

Parameters

value	:: the value
iP	:: the index of the parameter

Exceptions

runtime_error

Thrown if column of Jacobian to add number to does not exist

Definition at line 39 of file Jacobian.h.

References m_data, and value.

get()

double Mantid::CurveFitting::Jacobian::get ( size_t  iY, size_t  iP  )

inlineoverridevirtual

overwrite base method

Implements Mantid::API::Jacobian.

Definition at line 62 of file Jacobian.h.

References m_data.

set()

void Mantid::CurveFitting::Jacobian::set ( size_t  iY, size_t  iP, double  value  )

inlineoverridevirtual

overwrite base method

Implements Mantid::API::Jacobian.

Definition at line 52 of file Jacobian.h.

References m_data, and value.

zero()

void Mantid::CurveFitting::Jacobian::zero ( )

inlineoverridevirtual

overwrite base method

Implements Mantid::API::Jacobian.

Definition at line 72 of file Jacobian.h.

References m_data.

Member Data Documentation

m_data

std::vector<double> Mantid::CurveFitting::Jacobian::m_data

private

Storage for the derivatives.

Definition at line 27 of file Jacobian.h.

m_np

size_t Mantid::CurveFitting::Jacobian::m_np

private

Number of parameters in a function (== IFunction::nParams())

Definition at line 25 of file Jacobian.h.

m_ny

size_t Mantid::CurveFitting::Jacobian::m_ny

private

Number of data points.

Definition at line 23 of file Jacobian.h.

---

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

• Framework/CurveFitting/inc/MantidCurveFitting/Jacobian.h