Full matrix class. More...

#include <Matrix_Pointers.hxx>

Inheritance diagram for Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >:

Public Types
typedef Allocator::value_type	value_type

typedef Allocator::pointer	pointer

typedef Allocator::const_pointer	const_pointer

typedef Allocator::reference	reference

typedef Allocator::const_reference	const_reference

typedef Allocator::value_type	entry_type

typedef Allocator::reference	access_type

typedef Allocator::const_reference	const_access_type

Public Member Functions
	Matrix_Pointers ()
	Default constructor. More...

	Matrix_Pointers (int i, int j)
	Main constructor. More...

	Matrix_Pointers (const Matrix_Pointers< T, Prop, Storage, Allocator > &A)
	Copy constructor.

	~Matrix_Pointers ()
	Destructor.

void	Clear ()
	Clears the matrix. More...

long	GetDataSize () const
	Returns the number of elements stored in memory. More...

size_t	GetMemorySize () const
	Returns size of A in bytes used to store the matrix.

pointer *	GetMe () const
	Returns the pointer 'me_'. More...

void	Reallocate (int i, int j)
	Reallocates memory to resize the matrix. More...

void	SetData (int i, int j, pointer data)
	Changes the size of the matrix and sets its data array (low level method). More...

void	Nullify ()
	Clears the matrix without releasing memory. More...

void	Resize (int i, int j)
	Reallocates memory to resize the matrix and keeps previous entries. More...

pointer	GetDataPointer (int i, int j) const
	Returns a pointer to a data element. More...

reference	operator() (int i, int j)
	Access operator. More...

const_reference	operator() (int i, int j) const
	Access operator. More...

reference	Val (int i, int j)
	Access operator. More...

reference	Get (int i, int j)
	Access operator. More...

const_reference	Val (int i, int j) const
	Access operator. More...

const_reference	Get (int i, int j) const
	Access operator. More...

reference	operator[] (int i)
	Access to elements of the data array. More...

const_reference	operator[] (int i) const
	Access to elements of the data array. More...

Matrix_Pointers< T, Prop, Storage, Allocator > &	operator= (const Matrix_Pointers< T, Prop, Storage, Allocator > &A)
	Duplicates a matrix (assignment operator). More...

void	Set (int i, int j, const T &val)
	Sets an element of the matrix. More...

void	Copy (const Matrix_Pointers< T, Prop, Storage, Allocator > &A)
	Duplicates a matrix. More...

int	GetLD () const
	Returns the leading dimension. More...

void	Zero ()
	Sets all elements to zero. More...

void	SetIdentity ()
	Sets the current matrix to the identity.

void	Fill ()
	Fills the matrix the matrix with 0, 1, 2, ... More...

template<class T0 >
void	Fill (const T0 &x)
	Fills the matrix with a given value. More...

template<class T0 >
Matrix_Pointers< T, Prop, Storage, Allocator > &	operator= (const T0 &x)
	Fills the matrix with a given value. More...

void	FillRand ()
	Fills the matrix randomly. More...

void	Print () const
	Displays the matrix on the standard output. More...

void	Print (int a, int b, int m, int n) const
	Displays a sub-matrix on the standard output. More...

void	Print (int l) const
	Displays a square sub-matrix on the standard output. More...

void	Append (string FileName) const
	Appends the matrix in a file. More...

void	Write (string FileName, bool with_size=true) const
	Writes the matrix in a file. More...

void	Write (ostream &FileStream, bool with_size=true) const
	Writes the matrix to an output stream. More...

void	WriteText (string FileName) const
	Writes the matrix in a file. More...

void	WriteText (ostream &FileStream) const
	Writes the matrix to an output stream. More...

void	Read (string FileName, bool with_size=true)
	Reads the matrix from a file. More...

void	Read (istream &FileStream, bool with_size=true)
	Reads the matrix from an input stream. More...

void	ReadText (string FileName)
	Reads the matrix from a file. More...

void	ReadText (istream &FileStream)
	Reads the matrix from an input stream. More...

pointer	GetData () const
	Returns a pointer to the data array. More...

const_pointer	GetDataConst () const
	Returns a const pointer to the data array. More...

void *	GetDataVoid () const
	Returns a pointer of type "void*" to the data array. More...

const void *	GetDataConstVoid () const
	Returns a pointer of type "const void*" to the data array. More...

int	GetM () const
	Returns the number of rows. More...

int	GetM (const Seldon::SeldonTranspose &status) const
	Returns the number of rows of the matrix possibly transposed. More...

int	GetM (const CBLAS_TRANSPOSE &status) const
	Returns the number of rows of the matrix possibly transposed. More...

int	GetN () const
	Returns the number of columns. More...

int	GetN (const Seldon::SeldonTranspose &status) const
	Returns the number of columns of the matrix possibly transposed. More...

int	GetN (const CBLAS_TRANSPOSE &status) const
	Returns the number of columns of the matrix possibly transposed. More...

long	GetSize () const
	Returns the number of elements in the matrix. More...

Protected Attributes
pointer *	me_

pointer	data_

int	m_

int	n_

Detailed Description

template<class T, class Prop, class Storage, class Allocator = typename SeldonDefaultAllocator<Storage, T>::allocator>
class Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >

Full matrix class.

Definition at line 37 of file Matrix_Pointers.hxx.

Constructor & Destructor Documentation

◆ Matrix_Pointers() [1/2]

template<class T , class Prop , class Storage , class Allocator >

Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Matrix_Pointers

inline

Default constructor.

On exit, the matrix is an empty 0x0 matrix.

Definition at line 39 of file Matrix_PointersInline.cxx.

◆ Matrix_Pointers() [2/2]

template<class T , class Prop , class Storage , class Allocator >

Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Matrix_Pointers	(	int	i,
		int	j
	)

explicit

Main constructor.

Builds a i x j full matrix.

Parameters

i	number of rows.
j	number of columns.

Definition at line 36 of file Matrix_Pointers.cxx.

Member Function Documentation

◆ Append()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Append ( string FileName ) const

Appends the matrix in a file.

Appends the matrix in a file in binary format. The matrix elements are appended in the same order as in memory (e.g. row-major storage).

Parameters

FileName output file name.

Definition at line 574 of file Matrix_Pointers.cxx.

◆ Clear()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Clear

Clears the matrix.

Destructs the matrix.

Warning: On exit, the matrix is an empty 0x0 matrix.

Definition at line 122 of file Matrix_Pointers.cxx.

◆ Copy()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Copy ( const Matrix_Pointers< T, Prop, Storage, Allocator > & A )

inline

Duplicates a matrix.

Parameters

A	matrix to be copied.

Note: Memory is duplicated: 'A' is therefore independent from the current instance after the copy.

Definition at line 327 of file Matrix_PointersInline.cxx.

◆ Fill() [1/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Fill

Fills the matrix the matrix with 0, 1, 2, ...

On exit, the matrix is filled with 0, 1, 2, 3, ... The order of those numbers depends on the storage.

Definition at line 434 of file Matrix_Pointers.cxx.

◆ Fill() [2/2]

template<class T , class Prop , class Storage , class Allocator >

template<class T0 >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Fill ( const T0 & x )

Fills the matrix with a given value.

Parameters

x	the value to fill the matrix with.

Definition at line 447 of file Matrix_Pointers.cxx.

◆ FillRand()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::FillRand

Fills the matrix randomly.

Note: The random generator is very basic.

Definition at line 474 of file Matrix_Pointers.cxx.

◆ Get() [1/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::reference Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Get	(	int	i,
		int	j
	)

inline

Access operator.

Returns the value of element (i, j).

Parameters

i	row index.
j	column index.

Returns: Element (i, j) of the matrix.

Definition at line 206 of file Matrix_PointersInline.cxx.

◆ Get() [2/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::const_reference Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Get	(	int	i,
		int	j
	)		const

inline

Access operator.

Returns the value of element (i, j).

Parameters

i	row index.
j	column index.

Returns: Element (i, j) of the matrix.

Definition at line 243 of file Matrix_PointersInline.cxx.

◆ GetData()

Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::pointer Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::GetData

inlineinherited

Returns a pointer to the data array.

Returns a pointer to data, i.e. the data array 'data_'.

Returns: A pointer to the data array.

Definition at line 241 of file Matrix_BaseInline.cxx.

◆ GetDataConst()

Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::const_pointer Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::GetDataConst

inlineinherited

Returns a const pointer to the data array.

Returns a const pointer to data, i.e. the data array 'data_'.

Returns: A const pointer to the data array.

Definition at line 254 of file Matrix_BaseInline.cxx.

◆ GetDataConstVoid()

const void * Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::GetDataConstVoid

inlineinherited

Returns a pointer of type "const void*" to the data array.

Returns a pointer of type "const void*" to data, i.e. the data array 'data_'.

Returns: A const pointer of type "void*" to the data array.

Definition at line 280 of file Matrix_BaseInline.cxx.

◆ GetDataPointer()

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::pointer Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::GetDataPointer	(	int	i,
		int	j
	)		const

inline

Returns a pointer to a data element.

Parameters

i	index along dimension #1.
j	index along dimension #2.

Returns: A pointer to the data element.

Definition at line 127 of file Matrix_PointersInline.cxx.

◆ GetDataSize()

template<class T , class Prop , class Storage , class Allocator >

long Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::GetDataSize

inline

Returns the number of elements stored in memory.

Returns the number of elements stored in memory, i.e. the number of rows multiplied by the number of columns because the matrix is full.

Returns: The number of elements stored in memory.

Definition at line 72 of file Matrix_PointersInline.cxx.

◆ GetDataVoid()

void * Seldon::Matrix_Base< T, typename SeldonDefaultAllocator< Storage, T >::allocator >::GetDataVoid

inlineinherited

Returns a pointer of type "void*" to the data array.

Returns a pointer of type "void*" to data, i.e. the data array 'data_'.

Returns: A pointer of type "void*" to the data array.

Definition at line 267 of file Matrix_BaseInline.cxx.

◆ GetLD()

template<class T , class Prop , class Storage , class Allocator >

int Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::GetLD

inline

Returns the leading dimension.

Returns: The leading dimension.

Definition at line 108 of file Matrix_PointersInline.cxx.

◆ GetM() [1/3]

template<class T >

int Seldon::VirtualMatrix< T >::GetM

inlineinherited

Returns the number of rows.

Returns: The number of rows.

Definition at line 69 of file Matrix_BaseInline.cxx.

◆ GetM() [2/3]

template<class T >

int Seldon::VirtualMatrix< T >::GetM ( const CBLAS_TRANSPOSE & status ) const

inlineinherited

Returns the number of rows of the matrix possibly transposed.

Parameters

status assumed status about the transposition of the matrix.

Returns: The number of rows of the possibly-transposed matrix.

Definition at line 122 of file Matrix_BaseInline.cxx.

◆ GetM() [3/3]

template<class T >

int Seldon::VirtualMatrix< T >::GetM ( const Seldon::SeldonTranspose & status ) const

inlineinherited

Returns the number of rows of the matrix possibly transposed.

Parameters

status assumed status about the transposition of the matrix.

Returns: The number of rows of the possibly-transposed matrix.

Definition at line 92 of file Matrix_BaseInline.cxx.

◆ GetMe()

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::pointer * Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::GetMe

inline

Returns the pointer 'me_'.

Returns the pointer 'me_' that defines an array pointing to the first row or column elements, so that 'me_[1]' points to the first element of the second row or column.

Returns: The pointer 'me_'.

Definition at line 97 of file Matrix_PointersInline.cxx.

◆ GetN() [1/3]

template<class T >

int Seldon::VirtualMatrix< T >::GetN

inlineinherited

Returns the number of columns.

Returns: The number of columns.

Definition at line 80 of file Matrix_BaseInline.cxx.

◆ GetN() [2/3]

template<class T >

int Seldon::VirtualMatrix< T >::GetN ( const CBLAS_TRANSPOSE & status ) const

inlineinherited

Returns the number of columns of the matrix possibly transposed.

Parameters

status assumed status about the transposition of the matrix.

Returns: The number of columns of the possibly-transposed matrix.

Definition at line 137 of file Matrix_BaseInline.cxx.

◆ GetN() [3/3]

template<class T >

int Seldon::VirtualMatrix< T >::GetN ( const Seldon::SeldonTranspose & status ) const

inlineinherited

Returns the number of columns of the matrix possibly transposed.

Parameters

status assumed status about the transposition of the matrix.

Returns: The number of columns of the possibly-transposed matrix.

Definition at line 107 of file Matrix_BaseInline.cxx.

◆ GetSize()

template<class T >

long Seldon::VirtualMatrix< T >::GetSize

inlineinherited

Returns the number of elements in the matrix.

Returns the number of elements in the matrix, i.e. the number of rows multiplied by the number of columns.

Returns: The number of elements in the matrix.

Definition at line 153 of file Matrix_BaseInline.cxx.

◆ Nullify()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Nullify

Clears the matrix without releasing memory.

On exit, the matrix is empty and the memory has not been released. It is useful for low level manipulations on a Matrix instance.

Warning: Memory is not released except for me_.

Definition at line 329 of file Matrix_Pointers.cxx.

◆ operator()() [1/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::reference Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::operator()	(	int	i,
		int	j
	)

inline

Access operator.

Returns the value of element (i, j).

Parameters

i	row index.
j	column index.

Returns: Element (i, j) of the matrix.

Definition at line 145 of file Matrix_PointersInline.cxx.

◆ operator()() [2/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::const_reference Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::operator()	(	int	i,
		int	j
	)		const

inline

Access operator.

Returns the value of element (i, j).

Parameters

i	row index.
j	column index.

Returns: Element (i, j) of the matrix.

Definition at line 166 of file Matrix_PointersInline.cxx.

◆ operator=() [1/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator > & Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::operator= ( const Matrix_Pointers< T, Prop, Storage, Allocator > & A )

inline

Duplicates a matrix (assignment operator).

Parameters

A	matrix to be copied.

Note: Memory is duplicated: 'A' is therefore independent from the current instance after the copy.

Definition at line 311 of file Matrix_PointersInline.cxx.

◆ operator=() [2/2]

template<class T , class Prop , class Storage , class Allocator >

template<class T0 >

Matrix_Pointers< T, Prop, Storage, Allocator > & Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::operator= ( const T0 & x )

Fills the matrix with a given value.

Parameters

x	the value to fill the matrix with.

Definition at line 461 of file Matrix_Pointers.cxx.

◆ operator[]() [1/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::reference Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::operator[] ( int i )

inline

Access to elements of the data array.

Provides a direct access to the data array.

Parameters

i index.

Returns: i-th element of the data array.

Definition at line 257 of file Matrix_PointersInline.cxx.

◆ operator[]() [2/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::const_reference Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::operator[] ( int i ) const

inline

Access to elements of the data array.

Provides a direct access to the data array.

Parameters

i index.

Returns: i-th element of the data array.

Definition at line 277 of file Matrix_PointersInline.cxx.

◆ Print() [1/3]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Print

Displays the matrix on the standard output.

Displays elements on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.

Definition at line 491 of file Matrix_Pointers.cxx.

◆ Print() [2/3]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Print	(	int	a,
		int	b,
		int	m,
		int	n
	)		const

Displays a sub-matrix on the standard output.

The sub-matrix is defined by its upper-left corner (a, b) and its bottom-right corner (m, n). So, elements with indices in [a, m] x [b, n] are displayed on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.

Parameters

a	row index of the upper-left corner.
b	column index of the upper-left corner.
m	row index of the bottom-right corner.
n	column index of the bottom-right corner.

Definition at line 515 of file Matrix_Pointers.cxx.

◆ Print() [3/3]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Print ( int l ) const

Displays a square sub-matrix on the standard output.

The sub-matrix is defined by its bottom-right corner (l, l). So, elements with indices in [0, 0] x [l, l] are displayed on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.

Parameters

l	dimension of the square matrix to be displayed.

Definition at line 537 of file Matrix_Pointers.cxx.

◆ Read() [1/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Read	(	istream &	FileStream,
		bool	with_size = `true`
	)

Reads the matrix from an input stream.

Reads a matrix in binary format from an input stream. The number of rows (integer) and the number of columns (integer) are read, and matrix elements are then read in the same order as it should be in memory (e.g. row-major storage).

Parameters

FileStream	input stream.
with_size	if set to 'false', the dimensions of the matrix are not available in the stream. In this case, the current dimensions (M, N) of the matrix are unchanged, and MxN elements are read in the stream.

Definition at line 777 of file Matrix_Pointers.cxx.

◆ Read() [2/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Read	(	string	FileName,
		bool	with_size = `true`
	)

Reads the matrix from a file.

Reads a matrix stored in binary format in a file. The number of rows (integer) and the number of columns (integer) are read, and matrix elements are then read in the same order as it should be in memory (e.g. row-major storage).

Parameters

FileName	input file name.
with_size	if set to 'false', the dimensions of the matrix are not available in the file. In this case, the current dimensions (M, N) of the matrix are unchanged, and MxN elements are read in the file.

Definition at line 746 of file Matrix_Pointers.cxx.

◆ ReadText() [1/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::ReadText ( istream & FileStream )

Reads the matrix from an input stream.

Reads a matrix in text format from an input stream.

Parameters

FileStream input stream.

Definition at line 840 of file Matrix_Pointers.cxx.

◆ ReadText() [2/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::ReadText ( string FileName )

Reads the matrix from a file.

Reads a matrix from a file in text format.

Parameters

FileName input file name.

Definition at line 815 of file Matrix_Pointers.cxx.

◆ Reallocate()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Reallocate	(	int	i,
		int	j
	)

Reallocates memory to resize the matrix.

On exit, the matrix is a i x j matrix.

Parameters

i	new number of rows.
j	new number of columns.

Warning: Depending on your allocator, data may be lost.

Definition at line 183 of file Matrix_Pointers.cxx.

◆ Resize()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Resize	(	int	i,
		int	j
	)

Reallocates memory to resize the matrix and keeps previous entries.

On exit, the matrix is a i x j matrix.

Parameters

i	new number of rows.
j	new number of columns.

Warning: The previous entries are kept, extra-entries may not be initialized (depending of the allocator).

Definition at line 369 of file Matrix_Pointers.cxx.

◆ Set()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Set	(	int	i,
		int	j,
		const T &	val
	)

inline

Sets an element of the matrix.

Parameters

i	row index.
j	column index.
x	new value for the matrix element (i, j).

Definition at line 296 of file Matrix_PointersInline.cxx.

◆ SetData()

template<class T , class Prop , class Storage , class Allocator = typename SeldonDefaultAllocator<Storage, T>::allocator>

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::SetData	(	int	i,
		int	j,
		pointer	data
	)

Changes the size of the matrix and sets its data array (low level method).

The matrix is first cleared (memory is freed). The matrix is then resized to a i x j matrix, and the data array of the matrix is set to 'data'. 'data' elements are not duplicated: the new data array of the matrix is the 'data' array. It is useful to create a matrix from pre-existing data.

Parameters

i	new number of rows.
j	new number of columns.
data	new array storing elements.

Warning: 'data' has to be used carefully outside the object. Unless you use 'Nullify', 'data' will be freed by the destructor, which means that 'data' must have been allocated carefully. The matrix allocator should be compatible.

Note: This method should only be used by advanced users.

Definition at line 277 of file Matrix_Pointers.cxx.

◆ Val() [1/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::reference Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Val	(	int	i,
		int	j
	)

inline

Access operator.

Returns the value of element (i, j).

Parameters

i	row index.
j	column index.

Returns: Element (i, j) of the matrix.

Definition at line 186 of file Matrix_PointersInline.cxx.

◆ Val() [2/2]

template<class T , class Prop , class Storage , class Allocator >

Matrix_Pointers< T, Prop, Storage, Allocator >::const_reference Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Val	(	int	i,
		int	j
	)		const

inline

Access operator.

Returns the value of element (i, j).

Parameters

i	row index.
j	column index.

Returns: Element (i, j) of the matrix.

Definition at line 222 of file Matrix_PointersInline.cxx.

◆ Write() [1/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Write	(	ostream &	FileStream,
		bool	with_size = `true`
	)		const

Writes the matrix to an output stream.

Writes the matrix to an output stream in binary format. The number of rows (integer) and the number of columns (integer) are written, and matrix elements are then written in the same order as in memory (e.g. row-major storage).

Parameters

FileStream	output stream.
with_size	if set to 'false', the dimensions of the matrix are not saved.

Definition at line 634 of file Matrix_Pointers.cxx.

◆ Write() [2/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Write	(	string	FileName,
		bool	with_size = `true`
	)		const

Writes the matrix in a file.

Stores the matrix in a file in binary format. The number of rows (integer) and the number of columns (integer) are written, and matrix elements are then written in the same order as in memory (e.g. row-major storage).

Parameters

FileName	output file name.
with_size	if set to 'false', the dimensions of the matrix are not saved.

Definition at line 604 of file Matrix_Pointers.cxx.

◆ WriteText() [1/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::WriteText ( ostream & FileStream ) const

Writes the matrix to an output stream.

Writes the matrix to an output stream in text format. Only matrix elements are written (not dimensions). Each row is written on a single line and elements of a row are delimited by tabulations.

Parameters

FileStream output stream.

Definition at line 705 of file Matrix_Pointers.cxx.

◆ WriteText() [2/2]

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::WriteText ( string FileName ) const

Writes the matrix in a file.

Stores the matrix in a file in text format. Only matrix elements are written (not dimensions). Each row is written on a single line and elements of a row are delimited by tabulations.

Parameters

FileName output file name.

Definition at line 675 of file Matrix_Pointers.cxx.

◆ Zero()

template<class T , class Prop , class Storage , class Allocator >

void Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >::Zero

Sets all elements to zero.

Warning: It fills the memory with zeros. If the matrix stores complex structures, use 'Fill' instead.

Definition at line 406 of file Matrix_Pointers.cxx.

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<class T, class Prop, class Storage, class Allocator = typename SeldonDefaultAllocator<Storage, T>::allocator> class Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >

Constructor & Destructor Documentation

◆ Matrix_Pointers() [1/2]

◆ Matrix_Pointers() [2/2]

Member Function Documentation

◆ Append()

◆ Clear()

◆ Copy()

◆ Fill() [1/2]

◆ Fill() [2/2]

◆ FillRand()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetData()

◆ GetDataConst()

◆ GetDataConstVoid()

◆ GetDataPointer()

◆ GetDataSize()

◆ GetDataVoid()

◆ GetLD()

◆ GetM() [1/3]

◆ GetM() [2/3]

◆ GetM() [3/3]

◆ GetMe()

◆ GetN() [1/3]

◆ GetN() [2/3]

◆ GetN() [3/3]

◆ GetSize()

◆ Nullify()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Print() [1/3]

◆ Print() [2/3]

◆ Print() [3/3]

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadText() [1/2]

◆ ReadText() [2/2]

◆ Reallocate()

◆ Resize()

◆ Set()

◆ SetData()

◆ Val() [1/2]

◆ Val() [2/2]

◆ Write() [1/2]

◆ Write() [2/2]

◆ WriteText() [1/2]

◆ WriteText() [2/2]

◆ Zero()

template<class T, class Prop, class Storage, class Allocator = typename SeldonDefaultAllocator<Storage, T>::allocator>
class Seldon::Matrix_Pointers< T, Prop, Storage, Allocator >