Public Member Functions
fmatvec::SquareMatrix< Ref, AT > Class Template Reference

This is a matrix class of general quadratic matrices. More...

#include <square_matrix.h>

Inheritance diagram for fmatvec::SquareMatrix< Ref, AT >:
fmatvec::Matrix< General, Ref, Ref, AT >

List of all members.

Public Member Functions

 SquareMatrix ()
 Standard constructor.
 SquareMatrix (int m, Noinit ini)
 SquareMatrix (int m, Init ini=INIT, const AT &a=0)
 SquareMatrix (int m, Eye ini, const AT &a=1)
 SquareMatrix (int m, AT *ele)
 Regular Constructor.
 SquareMatrix (const char *str)
 SquareMatrix (const SquareMatrix< Ref, AT > &A)
 Copy Constructor.
 SquareMatrix (const Matrix< General, Ref, Ref, AT > &A)
 Copy Constructor.
template<class Type , class Row , class Col >
 SquareMatrix (const Matrix< Type, Row, Col, AT > &x)
SquareMatrix< Ref, AT > & resize ()
SquareMatrix< Ref, AT > & resize (int m, Noinit)
SquareMatrix< Ref, AT > & resize (int m, Init ini=INIT, const AT &a=0)
SquareMatrix< Ref, AT > & resize (int m, Eye ini, const AT &a=1)
SquareMatrix< Ref, AT > & operator= (const SquareMatrix< Ref, AT > &A)
 Assignment operator.
template<class Type , class Row , class Col >
SquareMatrix< Ref, AT > & operator<< (const Matrix< Type, Row, Col, AT > &A)
 Copy operator.
SquareMatrix< Ref, AT > & operator>> (const SquareMatrix< Ref, AT > &A)
 Reference operator.
SquareMatrix< Ref, AT > & operator>> (const Matrix< General, Ref, Ref, AT > &A)
 Reference operator.
int size () const
 Size.
SquareMatrix< Ref, AT > copy () const
 Matrix duplicating.
 operator std::vector< std::vector< AT > > ()
 Cast to std::vector<std::vector<AT> >.
SquareMatrix< Ref, AT > T ()
const SquareMatrix< Ref, AT > T () const

Detailed Description

template<class AT>
class fmatvec::SquareMatrix< Ref, AT >

This is a matrix class of general quadratic matrices.

Template class SquareMatrix with shape type General and atomic type AT. The storage form is dense. The template parameter AT defines the atomic type of the vector. Valid types are int, float, double, complex<float> and complex<double>


Constructor & Destructor Documentation

template<class AT >
fmatvec::SquareMatrix< Ref, AT >::SquareMatrix ( ) [inline]

Standard constructor.

Constructs a squarematrix with no size.

template<class AT >
fmatvec::SquareMatrix< Ref, AT >::SquareMatrix ( int  m,
AT *  ele 
) [inline]

Regular Constructor.

Constructs a matrix of size m x m with the pyhsical memory given by ele_;

Parameters:
mThe number of rows and columns.
eleThe physical memory the matrix will point to.
template<class AT >
fmatvec::SquareMatrix< Ref, AT >::SquareMatrix ( const SquareMatrix< Ref, AT > &  A) [inline]

Copy Constructor.

Constructs a reference to the matrix A.

Attention:
The physical memory of the matrix A will not be copied, only referenced.
Parameters:
AThe matrix that will be referenced.
template<class AT >
fmatvec::SquareMatrix< Ref, AT >::SquareMatrix ( const Matrix< General, Ref, Ref, AT > &  A) [inline, explicit]

Copy Constructor.

See SquareMatrix(const SquareMatrix<General,Ref,Ref,AT>&)

References fmatvec::Matrix< General, Ref, Ref, AT >::cols(), and fmatvec::Matrix< General, Ref, Ref, AT >::rows().


Member Function Documentation

template<class AT >
SquareMatrix< Ref, AT > fmatvec::SquareMatrix< Ref, AT >::copy ( ) const [inline]

Matrix duplicating.

The calling matrix returns a deep copy of itself.

Returns:
The duplicate.

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

template<class AT >
fmatvec::SquareMatrix< Ref, AT >::operator std::vector< std::vector< AT > > ( ) [inline]

Cast to std::vector<std::vector<AT> >.

Returns:
The std::vector<std::vector<AT> > representation of the matrix

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

template<class AT >
template<class Type , class Row , class Col >
SquareMatrix<Ref,AT>& fmatvec::SquareMatrix< Ref, AT >::operator<< ( const Matrix< Type, Row, Col, AT > &  A) [inline]

Copy operator.

Copies the matrix given by A.

Parameters:
AThe matrix to be copied.
Returns:
A reference to the calling matrix.

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

References fmatvec::operator<<().

template<class AT >
SquareMatrix<Ref,AT>& fmatvec::SquareMatrix< Ref, AT >::operator= ( const SquareMatrix< Ref, AT > &  A) [inline]

Assignment operator.

Copies the matrix given by A by calling operator<<().

Parameters:
AThe matrix to be assigned.
Returns:
A reference to the calling matrix.
Remarks:
To call operator>>() by default, define FMATVEC_NO_DEEP_ASSIGNMENT
See also:
operator<<(), operator>>()
template<class AT >
SquareMatrix<Ref,AT>& fmatvec::SquareMatrix< Ref, AT >::operator>> ( const SquareMatrix< Ref, AT > &  A) [inline]

Reference operator.

References the matrix given by A.

Parameters:
AThe matrix to be referenced.
Returns:
A reference to the calling matrix.

References fmatvec::operator>>().

template<class AT >
SquareMatrix<Ref,AT>& fmatvec::SquareMatrix< Ref, AT >::operator>> ( const Matrix< General, Ref, Ref, AT > &  A) [inline]

Reference operator.

References the matrix given by A.

Parameters:
AThe matrix to be referenced.
Returns:
A reference to the calling matrix.

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

References fmatvec::Matrix< General, Ref, Ref, AT >::cols(), fmatvec::operator>>(), and fmatvec::Matrix< General, Ref, Ref, AT >::rows().

template<class AT >
int fmatvec::SquareMatrix< Ref, AT >::size ( ) const [inline]

Size.

Returns:
The number of rows and columns of the matrix.

Referenced by fmatvec::countElements().


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