fmatvec 0.0.0

Public Types | Public Member Functions | Static Public Attributes | List of all members
fmatvec::SquareMatrix< Fixed< M >, AT > Class Template Reference

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

`#include <fixed_square_matrix.h>`

Inheritance diagram for fmatvec::SquareMatrix< Fixed< M >, AT >:
[legend]

## Public Types

using | value_type = AT
using | shape_type = Square
Public Types inherited from fmatvec::Matrix< General, Fixed< M >, Fixed< M >, AT >
using | value_type = AT
using | shape_type = General

## Public Member Functions

| SquareMatrix (Noinit ini)
| SquareMatrix (Init ini=INIT, const AT &a=AT())
| SquareMatrix (Eye ini, const AT &a=1)
| SquareMatrix (int m, Noinit ini)
| SquareMatrix (int m, Init ini=INIT, const AT &a=AT())
| SquareMatrix (int m, Eye ini, const AT &a=1)
| SquareMatrix (const SquareMatrix< Fixed< M >, AT > &A)=default
| Copy Constructor. More...
template<class Row >
| SquareMatrix (const SquareMatrix< Row, AT > &A)
| Copy Constructor. More...
template<class Type , class Row , class Col >
| SquareMatrix (const Matrix< Type, Row, Col, AT > &A)
| Copy Constructor. More...
| SquareMatrix (const char *str)
SquareMatrix< Fixed< M >, AT > & | operator= (const SquareMatrix< Fixed< M >, AT > &A)=default
| Assignment operator. More...
template<class Type , class Row , class Col >
SquareMatrix< Fixed< M >, AT > & | operator= (const Matrix< Type, Row, Col, AT > &A)
| Assignment operator. More...
template<class Type , class Row , class Col >
SquareMatrix< Fixed< M >, AT > & | operator<<= (const Matrix< Type, Row, Col, AT > &A)
| Matrix assignment. More...
constexpr int | size () const
| Size. More...
constexpr int | rows () const
constexpr int | cols () const
| operator std::vector< std::vector< AT >> () const
| Cast to std::vector<std::vector<AT>>. More...
| SquareMatrix (const std::vector< std::vector< AT >> &m)
| std::vector<std::vector<AT>> Constructor. Constructs and initializes a matrix with a std::vector<std::vector<AT>> object. An FMATVEC_ASSERT checks for constant length of each ro, UseExceptions<AT>::EXw. More...
const SquareMatrix< Fixed< M >, AT > | T () const
Public Member Functions inherited from fmatvec::Matrix< General, Fixed< M >, Fixed< M >, AT >
AT & | operator() (int i, int j)
| Standard constructor. More...
const AT & | operator() (int i, int j) const
| Element operator. More...
AT & | e (int i, int j)
const AT & | e (int i, int j) const
int | rows () const
| Number of rows. More...
int | cols () const
| Number of columns. More...
| operator std::vector< std::vector< AT >> () const
| Cast to std::vector<std::vector<AT>>. More...

## Static Public Attributes

static constexpr bool | isVector {false}
Static Public Attributes inherited from fmatvec::Matrix< General, Fixed< M >, Fixed< M >, AT >
static constexpr bool | isVector

## Detailed Description

### template<int M, class AT>
class fmatvec::SquareMatrix< Fixed< M >, 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

## ◆ SquareMatrix() [1/4]

template<int M, class AT >

fmatvec::SquareMatrix< Fixed< M >, AT >::SquareMatrix | ( | const SquareMatrix< Fixed< M >, AT > & | A | ) |

default

Copy Constructor.

See SquareMatrix(const SquareMatrix<AT>&)

## ◆ SquareMatrix() [2/4]

template<int M, class AT >
template<class Row >

fmatvec::SquareMatrix< Fixed< M >, AT >::SquareMatrix | ( | const SquareMatrix< Row, AT > & | A | ) |

inline

Copy Constructor.

See SquareMatrix(const SquareMatrix<AT>&)

## ◆ SquareMatrix() [3/4]

template<int M, class AT >
template<class Type , class Row , class Col >

fmatvec::SquareMatrix< Fixed< M >, AT >::SquareMatrix | ( | const Matrix< Type, Row, Col, AT > & | A | ) |

inline explicit

Copy Constructor.

See SquareMatrix(const SquareMatrix<AT>&)

## ◆ SquareMatrix() [4/4]

template<int M, class AT >

fmatvec::SquareMatrix< Fixed< M >, AT >::SquareMatrix | ( | const std::vector< std::vector< AT >> & | m | ) |

inline explicit

std::vector<std::vector<AT>> Constructor. Constructs and initializes a matrix with a std::vector<std::vector<AT>> object. An FMATVEC_ASSERT checks for constant length of each ro, UseExceptions<AT>::EXw.

Parameters

  m | The std::vector<std::vector<AT>> the matrix will be initialized with.

## Member Function Documentation

## ◆ operator std::vector< std::vector< AT >>()

template<int M, class AT >

fmatvec::SquareMatrix< Fixed< M >, AT >::operator std::vector< std::vector< AT >> | ( |  | ) | const

inline explicit

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

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

## ◆ operator<<=()

template<int M, class AT >
template<class Type , class Row , class Col >

SquareMatrix<Fixed<M>,AT>& fmatvec::SquareMatrix< Fixed< M >, AT >::operator<<= | ( | const Matrix< Type, Row, Col, AT > & | A | ) |

inline

Matrix assignment.

Copies the matrix given by A.

Parameters

  A | The matrix to be copied.

Returns
  A reference to the calling matrix.

## ◆ operator=() [1/2]

template<int M, class AT >

SquareMatrix<Fixed<M>,AT>& fmatvec::SquareMatrix< Fixed< M >, AT >::operator= | ( | const SquareMatrix< Fixed< M >, AT > & | A | ) |

inline default

Assignment operator.

Copies the matrix given by A.

Parameters

  A | The matrix to be assigned.

Returns
  A reference to the calling matrix.

## ◆ operator=() [2/2]

template<int M, class AT >
template<class Type , class Row , class Col >

SquareMatrix<Fixed<M>,AT>& fmatvec::SquareMatrix< Fixed< M >, AT >::operator= | ( | const Matrix< Type, Row, Col, AT > & | A | ) |

inline

Assignment operator.

Copies the matrix given by A.

Parameters

  A | The matrix to be assigned.

Returns
  A reference to the calling matrix.

## ◆ size()

template<int M, class AT >

constexpr int fmatvec::SquareMatrix< Fixed< M >, AT >::size | ( |  | ) | const

inline

Size.

Returns
  The number of rows and columns of the matrix.

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

- /mbsim-env/fmatvec/fmatvec/fixed_square_matrix.h