Specialisation of a \(m\times 1\) matrix. More...

#include <CepGen/Utils/Algebra.h>

Inheritance diagram for Vector:

Collaboration diagram for Vector:

Public Types
typedef std::pair< size_t, size_t >	Indices

Public Member Functions
	Vector (size_t num_coord, double def=0.)
	Object constructor.

	Vector (const std::initializer_list< double > &)
	Build a vector from a {...} list of double precision floats.

	Vector (const VectorRef &)
	Build a vector from a GSL vector view.

	Vector (const gsl_vector_const_view &)
	Build a vector from a constant GSL vector view.

size_t	size () const
	Vector multiplicity (number of lines)

Vector	subset (size_t min, size_t max=0ull) const
	Extract a subset of the vector.

double &	operator() (size_t)
	Component access operator.

double	operator() (size_t) const
	Component retrieval operator.

double	dot (const Vector &) const
	Scalar product of two vectors.

Vector	cross (const Vector &) const
	Vector product of two vectors.

	operator Vector () const
	Implicit conversion to vector.

VectorRef	diagonal ()
	Return the diagonal components of the matrix.

Vector	diagonal () const
	Return the diagonal components of the matrix.

size_t	numColumns () const
	Number of (vertical) columns.

size_t	numRows () const
	Number of (horizontal) rows.

bool	operator== (const Matrix &) const
	Equality operator.

bool	operator!= (const Matrix &oth) const
	Inequality operator.

Matrix	subset (size_t min_y, size_t min_x, size_t max_y=0ull, size_t max_x=0ull) const
	Extract a subset of the matrix as a new object.

Matrix &	operator*= (double)
	Multiplication by a scalar operator.

Matrix &	operator*= (const Vector &)
	Multiplication by a vector operator.

Matrix &	operator*= (const Matrix &)
	Multiplication by a matrix operator.

Matrix &	operator/= (double)
	Division by a scalar operator.

Matrix	operator- () const
	Unary inverse operator.

Matrix &	operator+= (const Matrix &)
	Addition of another matrix.

Matrix &	operator-= (const Matrix &)
	Subtraction of another matrix.

double &	operator() (size_t, size_t)
	Component access operator.

double	operator() (size_t, size_t) const
	Component retrieval operator.

Vector	operator% (const Vector &) const
	Solving operator (from LU decomposition)

Indices	imin () const
	Index (row, column) of the minimum matrix element.

Indices	imax () const
	Index (row, column) of the maximum matrix element.

double	min () const
	Minimum matrix element.

double	max () const
	Maximum matrix element.

bool	null () const
	Is the matrix uniformly null?

bool	positive () const
	Is the matrix positive-defined?

bool	negative () const
	Is the matrix negative-defined?

bool	nonNegative () const
	Is the matrix non-negative-defined?

Matrix &	truncate (double min=1.e-14)
	Truncate (specify minimum non-zero value) for all matrix components.

Matrix &	transpose ()
	Transpose the matrix.

Matrix	transposed () const
	Return a transposition of this matrix.

Matrix &	invert ()
	Invert the matrix.

Matrix	inverted () const
	Return the inverse of this matrix (LU decomposition)

VectorRef	column (size_t)
	Return whole column of the matrix.

Vector	column (size_t) const
	Return whole column of the matrix.

VectorRef	row (size_t)
	Return whole row of the matrix.

Vector	row (size_t) const
	Return whole row of the matrix.

Static Public Member Functions
static Matrix	zero (size_t num_rows, size_t num_cols=0ull)
	Build a zero'ed matrix.

static Matrix	uniform (size_t num_rows, size_t num_cols, double value=1.)
	Build a uniform matrix.

static Matrix	identity (size_t)
	Build a (square) identity matrix.

static Matrix	diagonal (const Vector &)
	Build a (square) diagonal matrix from its diagonal vector.

Friends
std::ostream &	operator<< (std::ostream &, const Vector &)
	Printout of vector components.

Detailed Description

Definition at line 139 of file Algebra.h.

Member Typedef Documentation

◆ Indices

typedef std::pair<size_t, size_t> Indices

inherited

Definition at line 90 of file Algebra.h.

Constructor & Destructor Documentation

◆ Vector() [1/4]

Vector	(	size_t	num_coord,
		double	def = `0.`
	)

explicit

Parameters

[in]	num_coord	vector multiplicity
[in]	def	default value for all components

Definition at line 307 of file Algebra.cpp.

◆ Vector() [2/4]

Vector ( const std::initializer_list< double > & vec )

Definition at line 309 of file Algebra.cpp.

◆ Vector() [3/4]

Vector ( const VectorRef & ref )

Definition at line 315 of file Algebra.cpp.

◆ Vector() [4/4]

Vector ( const gsl_vector_const_view & vec )

Definition at line 320 of file Algebra.cpp.

Member Function Documentation

◆ column() [1/2]

VectorRef column ( size_t i )

inherited

Definition at line 225 of file Algebra.cpp.

◆ column() [2/2]

Vector column ( size_t i ) const

inherited

Definition at line 223 of file Algebra.cpp.

◆ cross()

Vector cross ( const Vector & oth ) const

Definition at line 345 of file Algebra.cpp.

◆ diagonal() [1/3]

VectorRef diagonal ( )

inherited

Definition at line 233 of file Algebra.cpp.

◆ diagonal() [2/3]

Vector diagonal ( ) const

inherited

Definition at line 231 of file Algebra.cpp.

◆ diagonal() [3/3]

Matrix diagonal ( const Vector & vec )

staticinherited

Definition at line 87 of file Algebra.cpp.

◆ dot()

double dot ( const Vector & oth ) const

Definition at line 333 of file Algebra.cpp.

◆ identity()

Matrix identity ( size_t n )

staticinherited

Definition at line 81 of file Algebra.cpp.

◆ imax()

Matrix::Indices imax ( ) const

inherited

Definition at line 168 of file Algebra.cpp.

◆ imin()

Matrix::Indices imin ( ) const

inherited

Definition at line 162 of file Algebra.cpp.

◆ invert()

Matrix & invert ( )

inherited

Definition at line 208 of file Algebra.cpp.

◆ inverted()

Matrix inverted ( ) const

inherited

Definition at line 221 of file Algebra.cpp.

◆ max()

double max ( ) const

inherited

Definition at line 176 of file Algebra.cpp.

◆ min()

double min ( ) const

inherited

Definition at line 174 of file Algebra.cpp.

◆ negative()

bool negative ( ) const

inherited

Definition at line 182 of file Algebra.cpp.

◆ nonNegative()

bool nonNegative ( ) const

inherited

Definition at line 184 of file Algebra.cpp.

◆ null()

bool null ( ) const

inherited

Definition at line 178 of file Algebra.cpp.

◆ numColumns()

size_t numColumns ( ) const

inherited

Definition at line 94 of file Algebra.cpp.

◆ numRows()

size_t numRows ( ) const

inherited

Definition at line 96 of file Algebra.cpp.

◆ operator Vector()

operator Vector ( ) const

inherited

Definition at line 59 of file Algebra.cpp.

◆ operator!=()

bool operator!= ( const Matrix & oth ) const

inherited

Definition at line 61 of file Algebra.h.

◆ operator%()

Vector operator% ( const Vector & vec ) const

inherited

Definition at line 136 of file Algebra.cpp.

◆ operator()() [1/4]

double & operator() ( size_t i )

Definition at line 329 of file Algebra.cpp.

◆ operator()() [2/4]

double operator() ( size_t i ) const

Definition at line 331 of file Algebra.cpp.

◆ operator()() [3/4]

double & operator()	(	size_t	ix,
		size_t	iy
	)

inherited

Definition at line 148 of file Algebra.cpp.

◆ operator()() [4/4]

double operator()	(	size_t	ix,
		size_t	iy
	)		const

inherited

Definition at line 155 of file Algebra.cpp.

◆ operator*=() [1/3]

Matrix & operator*= ( const Matrix & mat )

inherited

Definition at line 117 of file Algebra.cpp.

◆ operator*=() [2/3]

Matrix & operator*= ( const Vector & vec )

inherited

Definition at line 112 of file Algebra.cpp.

◆ operator*=() [3/3]

Matrix & operator*= ( double val )

inherited

Definition at line 107 of file Algebra.cpp.

◆ operator+=()

Matrix & operator+= ( const Matrix & oth )

inherited

Definition at line 126 of file Algebra.cpp.

◆ operator-()

Matrix operator- ( ) const

inherited

Definition at line 124 of file Algebra.cpp.

◆ operator-=()

Matrix & operator-= ( const Matrix & oth )

inherited

Definition at line 131 of file Algebra.cpp.

◆ operator/=()

Matrix & operator/= ( double val )

inherited

Definition at line 122 of file Algebra.cpp.

◆ operator==()

bool operator== ( const Matrix & oth ) const

inherited

Definition at line 105 of file Algebra.cpp.

◆ positive()

bool positive ( ) const

inherited

Definition at line 180 of file Algebra.cpp.

◆ row() [1/2]

VectorRef row ( size_t i )

inherited

Definition at line 229 of file Algebra.cpp.

◆ row() [2/2]

Vector row ( size_t i ) const

inherited

Definition at line 227 of file Algebra.cpp.

◆ size()

size_t size ( ) const

Definition at line 325 of file Algebra.cpp.

◆ subset() [1/2]

Vector subset	(	size_t	min,
		size_t	max = `0ull`
	)		const

Parameters

[in]	min	first index for the subset
[in]	max	last index for the subset (last element if not specified)

Definition at line 327 of file Algebra.cpp.

◆ subset() [2/2]

Matrix subset	(	size_t	min_y,
		size_t	min_x,
		size_t	max_y = `0ull`,
		size_t	max_x = `0ull`
	)		const

inherited

Parameters

[in]	min_y	first vertical index for the subset
[in]	min_x	first horizontal index for the subset
[in]	max_y	last vertical index for the subset
[in]	max_x	last horizontal index for the subset

Definition at line 98 of file Algebra.cpp.

◆ transpose()

Matrix & transpose ( )

inherited

Definition at line 196 of file Algebra.cpp.

◆ transposed()

Matrix transposed ( ) const

inherited

Definition at line 206 of file Algebra.cpp.

◆ truncate()

Matrix & truncate ( double min = 1.e-14 )

inherited

Definition at line 186 of file Algebra.cpp.

◆ uniform()

Matrix uniform	(	size_t	num_rows,
		size_t	num_cols,
		double	value = `1.`
	)

staticinherited

Parameters

[in]	num_rows	number of (horizontal) rows for the matrix
[in]	num_cols	number of (vertical) columns for the matrix
[in]	value	uniform value for all the matrix components

Definition at line 75 of file Algebra.cpp.

◆ zero()

Matrix zero	(	size_t	num_rows,
		size_t	num_cols = `0ull`
	)

staticinherited

Parameters

[in]	num_rows	number of (horizontal) rows for the matrix
[in]	num_cols	number of (vertical) columns for the matrix

Definition at line 67 of file Algebra.cpp.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Vector &	vec
	)

friend

Definition at line 357 of file Algebra.cpp.

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ Indices

Constructor & Destructor Documentation

◆ Vector() [1/4]

◆ Vector() [2/4]

◆ Vector() [3/4]

◆ Vector() [4/4]

Member Function Documentation

◆ column() [1/2]

◆ column() [2/2]

◆ cross()

◆ diagonal() [1/3]

◆ diagonal() [2/3]

◆ diagonal() [3/3]

◆ dot()

◆ identity()

◆ imax()

◆ imin()

◆ invert()

◆ inverted()

◆ max()

◆ min()

◆ negative()

◆ nonNegative()

◆ null()

◆ numColumns()

◆ numRows()

◆ operator Vector()

◆ operator!=()

◆ operator%()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator*=() [1/3]

◆ operator*=() [2/3]

◆ operator*=() [3/3]

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/=()

◆ operator==()

◆ positive()

◆ row() [1/2]

◆ row() [2/2]

◆ size()

◆ subset() [1/2]

◆ subset() [2/2]

◆ transpose()

◆ transposed()

◆ truncate()

◆ uniform()

◆ zero()

Friends And Related Symbol Documentation

◆ operator<<