General matrix with 3 rows and 1 column. More...

#include <general_matrix_3x1.h>

Public Member Functions
	operator jcb_e13_row_dofs_type< T > & () const
	Operator to convert current to jcb_e13_row_dofs_type. More...

T *	operator[] (int xrow)
	Pointer to the first element in row xrow of this matrix. Facilitates accessing elements via matrix[i][j]. More...

const T *	operator[] (int xrow) const
	Pointer to the first element in row xrow of this matrix. Facilitates accessing elements via matrix[i][j]. More...

	operator T* ()
	Conversion (cast) operator to convert to the associated matrix type (non const version). More...

	operator const T * () const
	Conversion (cast) operator to convert to the associated matrix type (const version). More...

int	row_index (int xrow) const
	Index for row xrow in the linear storage array. More...

void	assign (const T &xvalue)
	Assign all elements of this matrix to the value xvalue. More...

void	multiply (const T &xscalar, general_matrix_3x1< T > &xresult) const
	This matrix multiplied by a scalar (pre-allocated). More...

general_matrix_3x1< T >	multiply (const T &xscalar) const
	This matrix multiplied by a scalar (auto-allocated). More...

void	multiply (const general_matrix_1x2< T > &xother, general_matrix_3x2< T > &xresult) const
	Premultiply matrix xother by this matrix (pre-allocated). More...

general_matrix_3x2< T >	multiply (const general_matrix_1x2< T > &xother) const
	Premultiply matrix xother by this matrix (auto-allocated). More...

void	multiply (const general_matrix_1x3< T > &xother, general_matrix_3x3< T > &xresult) const
	Premultiply matrix xother by this matrix (pre-allocated). More...

general_matrix_3x3< T >	multiply (const general_matrix_1x3< T > &xother) const
	Premultiply matrix xother by this matrix (auto-allocated). More...

void	transpose (general_matrix_1x3< T > &xresult) const
	The transpose of the matrix (pre-allocated). More...

general_matrix_1x3< T >	transpose () const
	The transpose of the matrix (auto-allocated). More...

Static Public Member Functions
static int	number_of_rows ()
	The number of rows. More...

static int	number_of_columns ()
	The number of columns. More...

static int	d ()
	Dimension of the underlying elements. More...

Public Attributes
T	components [3]
	Linear storage array. More...

Detailed Description

template<typename T>
class fiber_bundle::general_matrix_3x1< T >

General matrix with 3 rows and 1 column.

Class general_matrix_3x1 is a special kind of matrix class intended to be used in conjunction with various row_dofs_type classes (pod types). The pod types will be converted (cast) to appropriate matrix types. So, this class is also required to be a pod type also (ie: really just a struct with no inheritance, no constructors, no virtual functions, etc.).

Definition at line 35 of file antisymmetric_matrix_3x3.h.

Member Function Documentation

◆ assign()

template<typename T >

void fiber_bundle::general_matrix_3x1< T >::assign ( const T & xvalue )

Assign all elements of this matrix to the value xvalue.

Postcondition

for(int i = ( 0 ); i < ( d() ); ++ i ) components[i] == xvalue

Definition at line 264 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::multiply().

Referenced by fiber_bundle::general_matrix_3x1< T >::row_index().

◆ d()

template<typename T >

int fiber_bundle::general_matrix_3x1< T >::d ( )

static

Dimension of the underlying elements.

Definition at line 132 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::operator[]().

Referenced by fiber_bundle::general_matrix_3x1< T >::number_of_columns().

◆ multiply() [1/6]

template<typename T >

void fiber_bundle::general_matrix_3x1< T >::multiply	(	const T &	xscalar,
		general_matrix_3x1< T > &	xresult
	)		const

This matrix multiplied by a scalar (pre-allocated).

Definition at line 288 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::components.

Referenced by fiber_bundle::general_matrix_3x1< T >::assign(), and fiber_bundle::general_matrix_3x1< T >::multiply().

◆ multiply() [2/6]

template<typename T >

general_matrix_3x1< T > fiber_bundle::general_matrix_3x1< T >::multiply ( const T & xscalar ) const

This matrix multiplied by a scalar (auto-allocated).

Definition at line 313 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::multiply(), and fiber_bundle::vd_algebra::multiply().

◆ multiply() [3/6]

template<typename T >

void fiber_bundle::general_matrix_3x1< T >::multiply	(	const general_matrix_1x2< T > &	xother,
		general_matrix_3x2< T > &	xresult
	)		const

Premultiply matrix xother by this matrix (pre-allocated).

Definition at line 334 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::multiply(), and fiber_bundle::general_matrix_1x2< T >::number_of_columns().

◆ multiply() [4/6]

template<typename T >

general_matrix_3x2< T > fiber_bundle::general_matrix_3x1< T >::multiply ( const general_matrix_1x2< T > & xother ) const

Premultiply matrix xother by this matrix (auto-allocated).

Definition at line 374 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::multiply(), and fiber_bundle::vd_algebra::multiply().

◆ multiply() [5/6]

template<typename T >

void fiber_bundle::general_matrix_3x1< T >::multiply	(	const general_matrix_1x3< T > &	xother,
		general_matrix_3x3< T > &	xresult
	)		const

Premultiply matrix xother by this matrix (pre-allocated).

Definition at line 394 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::multiply(), and fiber_bundle::general_matrix_1x3< T >::number_of_columns().

◆ multiply() [6/6]

template<typename T >

general_matrix_3x3< T > fiber_bundle::general_matrix_3x1< T >::multiply ( const general_matrix_1x3< T > & xother ) const

Premultiply matrix xother by this matrix (auto-allocated).

Definition at line 434 of file general_matrix_3x1.impl.h.

References fiber_bundle::vd_algebra::multiply(), and fiber_bundle::general_matrix_3x1< T >::transpose().

◆ number_of_columns()

template<typename T >

int fiber_bundle::general_matrix_3x1< T >::number_of_columns ( )

static

The number of columns.

Definition at line 115 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::d().

Referenced by fiber_bundle::general_matrix_2x3< T >::multiply(), fiber_bundle::general_matrix_3x3< T >::multiply(), and fiber_bundle::general_matrix_3x1< T >::number_of_rows().

◆ number_of_rows()

template<typename T >

int fiber_bundle::general_matrix_3x1< T >::number_of_rows ( )

static

The number of rows.

Definition at line 98 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::number_of_columns().

Referenced by fiber_bundle::general_matrix_3x1< T >::operator jcb_e13_row_dofs_type< T > &(), and fiber_bundle::operator<<().

◆ operator const T *()

template<typename T >

fiber_bundle::general_matrix_3x1< T >::operator const T * ( ) const

Conversion (cast) operator to convert to the associated matrix type (const version).

Postcondition

result != 0

Definition at line 215 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::row_index().

◆ operator jcb_e13_row_dofs_type< T > &()

template<typename T >

fiber_bundle::general_matrix_3x1< T >::operator jcb_e13_row_dofs_type< T > & ( ) const

Operator to convert current to jcb_e13_row_dofs_type.

Definition at line 76 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::number_of_rows().

◆ operator T*()

template<typename T >

fiber_bundle::general_matrix_3x1< T >::operator T* ( )

Conversion (cast) operator to convert to the associated matrix type (non const version).

Postcondition

result != 0

Definition at line 193 of file general_matrix_3x1.impl.h.

◆ operator[]() [1/2]

template<typename T >

T * fiber_bundle::general_matrix_3x1< T >::operator[] ( int xrow )

Pointer to the first element in row xrow of this matrix. Facilitates accessing elements via matrix[i][j].

Precondition

nrow >= 0 && nrow < number_of_rows()

Postcondition

result != 0

Definition at line 149 of file general_matrix_3x1.impl.h.

Referenced by fiber_bundle::general_matrix_3x1< T >::d().

◆ operator[]() [2/2]

template<typename T >

const T * fiber_bundle::general_matrix_3x1< T >::operator[] ( int xrow ) const

Pointer to the first element in row xrow of this matrix. Facilitates accessing elements via matrix[i][j].

Precondition

nrow >= 0 && nrow < number_of_rows()

Postcondition

result != 0

Definition at line 171 of file general_matrix_3x1.impl.h.

◆ row_index()

template<typename T >

int fiber_bundle::general_matrix_3x1< T >::row_index ( int xrow ) const

Index for row xrow in the linear storage array.

Precondition

xrow >= 0 && xrow < number_of_rows()

Postcondition

result == number_of_columns()*xrow

Definition at line 238 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::assign().

Referenced by fiber_bundle::general_matrix_3x1< T >::operator const T *().

◆ transpose() [1/2]

template<typename T >

void fiber_bundle::general_matrix_3x1< T >::transpose ( general_matrix_1x3< T > & xresult ) const

The transpose of the matrix (pre-allocated).

Definition at line 454 of file general_matrix_3x1.impl.h.

References fiber_bundle::general_matrix_3x1< T >::transpose().

◆ transpose() [2/2]

template<typename T >

general_matrix_1x3< T > fiber_bundle::general_matrix_3x1< T >::transpose ( ) const

The transpose of the matrix (auto-allocated).

Definition at line 476 of file general_matrix_3x1.impl.h.

Referenced by fiber_bundle::general_matrix_3x1< T >::multiply(), and fiber_bundle::general_matrix_3x1< T >::transpose().

Member Data Documentation

◆ components

template<typename T>

T fiber_bundle::general_matrix_3x1< T >::components[3]

Linear storage array.

Definition at line 111 of file general_matrix_3x1.h.

Referenced by fiber_bundle::general_matrix_3x2< T >::column(), fiber_bundle::antisymmetric_matrix_3x3< T >::column(), fiber_bundle::symmetric_matrix_3x3< T >::column(), fiber_bundle::general_matrix_3x3< T >::column(), and fiber_bundle::general_matrix_3x1< T >::multiply().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

template<typename T> class fiber_bundle::general_matrix_3x1< T >

Member Function Documentation

◆ assign()

◆ d()

◆ multiply() [1/6]

◆ multiply() [2/6]

◆ multiply() [3/6]

◆ multiply() [4/6]

◆ multiply() [5/6]

◆ multiply() [6/6]

◆ number_of_columns()

◆ number_of_rows()

◆ operator const T *()

◆ operator jcb_e13_row_dofs_type< T > &()

◆ operator T*()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ row_index()

◆ transpose() [1/2]

◆ transpose() [2/2]

Member Data Documentation

◆ components

template<typename T>
class fiber_bundle::general_matrix_3x1< T >