Mantid::CurveFitting::EigenVector_View Class Reference

#include <EigenVectorView.h>

Public Member Functions
	EigenVector_View ()
	EigenVector_View (const double *base, const size_t nElements, const size_t startElement=0)
	EigenVector_View (const Eigen::VectorXd &vector, const size_t nElements, const size_t startElement=0)
	EigenVector_View (const EigenVector_View &v)
	EigenVector_View (const vec_map_type &vector, const size_t nElements=-1, const size_t startElement=0)
	CONST constructor: map->vector view. More...
	EigenVector_View (double *base, const size_t nElements, const size_t startElement=0)
	EigenVector_View (Eigen::VectorXd &vector, const int nElements=-1, const size_t startElement=0)
	EigenVector_View (EigenVector_View &v)
	EigenVector_View (vec_map_type &vector, const int nElements=-1, const size_t startElement=0)
	constructor: map->vector view More...
EigenVector_View &	operator= (EigenVector_View &&V)
EigenVector_View &	operator= (EigenVector_View &V)
size_t	size () const
vec_map_type	vector_copy () const
const vec_map_type	vector_inspector () const
vec_map_type &	vector_mutator ()

Protected Attributes
bool	m_isConst = false
vec_map_type	m_view

Detailed Description

Definition at line 17 of file EigenVectorView.h.

Constructor & Destructor Documentation

EigenVector_View() [1/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View

(

)

Definition at line 12 of file EigenVectorView.cpp.

EigenVector_View() [2/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View	(	vec_map_type &	vector,
		const int	nElements = -1,
		const size_t	startElement = 0
	)

constructor: map->vector view

Parameters

vector	:: Eigen::Map of a Eigen::VectorXd from which to take view.
startElement	:: The first element of the view.
nElements	:: The number of elements to view.

Definition at line 18 of file EigenVectorView.cpp.

References m_view.

EigenVector_View() [3/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View	(	Eigen::VectorXd &	vector,
		const int	nElements = -1,
		const size_t	startElement = 0
	)

Parameters

vector	:: Eigen::VectorXd from which to take view.
startElement	:: The first element of the view.
nElements	:: The number of elements to view.

Definition at line 31 of file EigenVectorView.cpp.

References m_view.

EigenVector_View() [4/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View	(	double *	base,
		const size_t	nElements,
		const size_t	startElement = 0
	)

Parameters

base	:: array from which to take view.
startElement	:: The first element of the view.
nElements	:: The number of elements to view.

Definition at line 44 of file EigenVectorView.cpp.

EigenVector_View() [5/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View	(	const vec_map_type &	vector,
		const size_t	nElements = -1,
		const size_t	startElement = 0
	)

CONST constructor: map->vector view.

Parameters

vector	:: Eigen::Map of a Eigen::VectorXd from which to take view.
startElement	:: The first element of the view.
nElements	:: The number of elements to view.

Definition at line 51 of file EigenVectorView.cpp.

EigenVector_View() [6/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View	(	const Eigen::VectorXd &	vector,
		const size_t	nElements,
		const size_t	startElement = 0
	)

Parameters

vector	:: Eigen::VectorXd from which to take view.
startElement	:: The first element of the view.
nElements	:: The number of elements to view.

Definition at line 60 of file EigenVectorView.cpp.

EigenVector_View() [7/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View	(	const double *	base,
		const size_t	nElements,
		const size_t	startElement = 0
	)

Parameters

base	:: array from which to take view.
startElement	:: The first element of the view.
nElements	:: The number of elements to view.

Definition at line 69 of file EigenVectorView.cpp.

EigenVector_View() [8/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View

(

EigenVector_View &

v

)

Parameters

v	:: EigenVector_View to copy.

Returns

a EigenVector_View which is a copy of v.

Definition at line 83 of file EigenVectorView.cpp.

EigenVector_View() [9/9]

Mantid::CurveFitting::EigenVector_View::EigenVector_View

(

const EigenVector_View &

v

)

Parameters

v	:: EigenVector_View to copy.

Definition at line 76 of file EigenVectorView.cpp.

Member Function Documentation

operator=() [1/2]

EigenVector_View & Mantid::CurveFitting::EigenVector_View::operator=

(

EigenVector_View &&

V

)

Definition at line 102 of file EigenVectorView.cpp.

References m_view.

operator=() [2/2]

EigenVector_View & Mantid::CurveFitting::EigenVector_View::operator=

(

EigenVector_View &

V

)

Definition at line 95 of file EigenVectorView.cpp.

References m_view.

size()

size_t Mantid::CurveFitting::EigenVector_View::size ( ) const

inline

Definition at line 50 of file EigenVectorView.h.

vector_copy()

vec_map_type Mantid::CurveFitting::EigenVector_View::vector_copy ( ) const

inline

Definition at line 49 of file EigenVectorView.h.

vector_inspector()

const vec_map_type Mantid::CurveFitting::EigenVector_View::vector_inspector ( ) const

inline

Definition at line 48 of file EigenVectorView.h.

vector_mutator()

vec_map_type & Mantid::CurveFitting::EigenVector_View::vector_mutator

(

)

Returns

a non-const reference to the member m_view, an Eigen::Map of an Eigen::VectorXd.

Definition at line 87 of file EigenVectorView.cpp.

References m_isConst, and m_view.

Member Data Documentation

m_isConst

bool Mantid::CurveFitting::EigenVector_View::m_isConst = false

protected

Definition at line 57 of file EigenVectorView.h.

Referenced by vector_mutator().

m_view

vec_map_type Mantid::CurveFitting::EigenVector_View::m_view

protected

Definition at line 56 of file EigenVectorView.h.

Referenced by EigenVector_View(), operator=(), and vector_mutator().

---

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

• Framework/CurveFitting/inc/MantidCurveFitting/EigenVectorView.h
• Framework/CurveFitting/src/EigenVectorView.cpp