Mantid::API::PartialJacobian Class Reference

A Jacobian for individual functions. More...

#include <CompositeFunction.h>

Inheritance diagram for Mantid::API::PartialJacobian:

Public Member Functions
void	addNumberToColumn (const double &value, const size_t &iP) override
	Add number to all iY (data) Jacobian elements for a given iP (parameter) More...
double	get (size_t iY, size_t iP) override
	Overridden Jacobian::get(...). More...
	PartialJacobian (Jacobian *J, size_t iP0)
	particular function More...
	PartialJacobian (Jacobian *J, size_t iY0, size_t iP0)
	Constructor. More...
void	set (size_t iY, size_t iP, double value) override
	Overridden Jacobian::set(...). 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...

Private Attributes
size_t	m_iP0
	particular function More...
size_t	m_iY0
	fitting data index offset in the overall Jacobian for a More...
Jacobian *	m_J
	pointer to the overall Jacobian More...

Detailed Description

A Jacobian for individual functions.

Definition at line 267 of file CompositeFunction.h.

Constructor & Destructor Documentation

PartialJacobian() [1/2]

Mantid::API::PartialJacobian::PartialJacobian ( Jacobian *  J, size_t  iP0  )

inline

particular function

Constructor

Parameters

J	:: A pointer to the overall Jacobian
iP0	:: The parameter index (declared) offset for a particular function

Definition at line 279 of file CompositeFunction.h.

PartialJacobian() [2/2]

Mantid::API::PartialJacobian::PartialJacobian ( Jacobian *  J, size_t  iY0, size_t  iP0  )

inline

Constructor.

Parameters

J	:: A pointer to the overall Jacobian
iY0	:: The data index offset for a particular function
iP0	:: The parameter index offset for a particular function

Definition at line 287 of file CompositeFunction.h.

Member Function Documentation

addNumberToColumn()

void Mantid::API::PartialJacobian::addNumberToColumn ( const double &  value, const size_t &  iP  )

inlineoverride

Add number to all iY (data) Jacobian elements for a given iP (parameter)

Parameters

value	:: Value to add
iP	:: The index of an active parameter.

Definition at line 310 of file CompositeFunction.h.

References m_iP0, m_J, and value.

get()

double Mantid::API::PartialJacobian::get ( size_t  iY, size_t  iP  )

inlineoverridevirtual

Overridden Jacobian::get(...).

Parameters

iY	:: The index of the data point
iP	:: The parameter index of an individual function.

Implements Mantid::API::Jacobian.

Definition at line 300 of file CompositeFunction.h.

References Mantid::API::Jacobian::get(), m_iP0, m_iY0, and m_J.

set()

void Mantid::API::PartialJacobian::set ( size_t  iY, size_t  iP, double  value  )

inlineoverridevirtual

Overridden Jacobian::set(...).

Parameters

iY	:: The index of the data point
iP	:: The parameter index of an individual function.
value	:: The derivative value

Implements Mantid::API::Jacobian.

Definition at line 294 of file CompositeFunction.h.

References m_iP0, m_iY0, m_J, Mantid::API::Jacobian::set(), and value.

zero()

void Mantid::API::PartialJacobian::zero ( )

inlineoverridevirtual

Zero all matrix elements.

Implements Mantid::API::Jacobian.

Definition at line 303 of file CompositeFunction.h.

Member Data Documentation

m_iP0

size_t Mantid::API::PartialJacobian::m_iP0

private

particular function

parameter index offset in the overall Jacobian for a

Definition at line 271 of file CompositeFunction.h.

Referenced by addNumberToColumn(), get(), and set().

m_iY0

size_t Mantid::API::PartialJacobian::m_iY0

private

fitting data index offset in the overall Jacobian for a

Definition at line 269 of file CompositeFunction.h.

Referenced by get(), and set().

m_J

Jacobian* Mantid::API::PartialJacobian::m_J

private

pointer to the overall Jacobian

Definition at line 268 of file CompositeFunction.h.

Referenced by addNumberToColumn(), get(), and set().

---

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

• Framework/API/inc/MantidAPI/CompositeFunction.h