Mantid: Mantid::CurveFitting::JacobianImpl1< T > Class Template Reference

Mantid

Loading...

Searching...

No Matches

The implementation of Jacobian. More...

#include <EigenJacobian.h>

Inheritance diagram for Mantid::CurveFitting::JacobianImpl1< T >:

Public Member Functions
void	addNumberToColumn (const double &value, const size_t &iActiveP) override
	overwrite base method More...

double	get (size_t iY, size_t iP) override
	overwrite base method More...

void	set (size_t iY, size_t iP, double value) override
	overwrite base method More...

void	setJ (T *J)
	Set the pointer to the jacobian. 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...

Public Attributes
std::vector< int >	m_index
	Maps declared indices to active. For fixed (tied) parameters holds -1. More...

T *	m_J
	The internal jacobian matrix. More...

Detailed Description

template<class T>
class Mantid::CurveFitting::JacobianImpl1< T >

The implementation of Jacobian.

Definition at line 85 of file EigenJacobian.h.

Member Function Documentation

◆ addNumberToColumn()

template<class T >

void Mantid::CurveFitting::JacobianImpl1< T >::addNumberToColumn	(	const double &	value,
		const size_t &	iActiveP
	)

inlineoverride

overwrite base method

Parameters

value	:: the value
iActiveP	:: the index of the parameter

Exceptions

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

Definition at line 100 of file EigenJacobian.h.

References Mantid::CurveFitting::JacobianImpl1< T >::m_J, and value.

◆ get()

template<class T >

double Mantid::CurveFitting::JacobianImpl1< T >::get	(	size_t	iY,
		size_t	iP
	)

inlineoverridevirtual

overwrite base method

Implements Mantid::API::Jacobian.

Definition at line 134 of file EigenJacobian.h.

References Mantid::CurveFitting::JacobianImpl1< T >::m_index, and Mantid::CurveFitting::JacobianImpl1< T >::m_J.

◆ set()

template<class T >

void Mantid::CurveFitting::JacobianImpl1< T >::set	(	size_t	iY,
		size_t	iP,
		double	value
	)

inlineoverridevirtual

overwrite base method

Implements Mantid::API::Jacobian.

Definition at line 113 of file EigenJacobian.h.

References Mantid::CurveFitting::JacobianImpl1< T >::m_index, Mantid::CurveFitting::JacobianImpl1< T >::m_J, and value.

◆ setJ()

template<class T >

void Mantid::CurveFitting::JacobianImpl1< T >::setJ ( T * J )

inline

Set the pointer to the jacobian.

Definition at line 93 of file EigenJacobian.h.

References Mantid::CurveFitting::JacobianImpl1< T >::m_J.

◆ zero()

template<class T >

void Mantid::CurveFitting::JacobianImpl1< T >::zero ( )

inlineoverridevirtual

overwrite base method

Implements Mantid::API::Jacobian.

Definition at line 141 of file EigenJacobian.h.

References Mantid::CurveFitting::JacobianImpl1< T >::m_J.

Member Data Documentation

◆ m_index

template<class T >

std::vector<int> Mantid::CurveFitting::JacobianImpl1< T >::m_index

Maps declared indices to active. For fixed (tied) parameters holds -1.

Definition at line 90 of file EigenJacobian.h.

Referenced by Mantid::CurveFitting::JacobianImpl1< T >::get(), and Mantid::CurveFitting::JacobianImpl1< T >::set().

◆ m_J

template<class T >

T* Mantid::CurveFitting::JacobianImpl1< T >::m_J

The internal jacobian matrix.

Definition at line 88 of file EigenJacobian.h.

Referenced by Mantid::CurveFitting::JacobianImpl1< T >::addNumberToColumn(), Mantid::CurveFitting::JacobianImpl1< T >::get(), Mantid::CurveFitting::JacobianImpl1< T >::set(), Mantid::CurveFitting::JacobianImpl1< T >::setJ(), and Mantid::CurveFitting::JacobianImpl1< T >::zero().

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

Framework/CurveFitting/inc/MantidCurveFitting/EigenJacobian.h