285 lines
7.8 KiB
C++
285 lines
7.8 KiB
C++
/* -*- C++ -*- ------------------------------------------------------------
|
|
|
|
Copyright (c) 2007 Jesse Anders and Demian Nave http://cmldev.net/
|
|
|
|
The Configurable Math Library (CML) is distributed under the terms of the
|
|
Boost Software License, v1.0 (see cml/LICENSE for details).
|
|
|
|
*-----------------------------------------------------------------------*/
|
|
/** @file
|
|
* @brief
|
|
*/
|
|
|
|
#ifndef fixed_matrix_h
|
|
#define fixed_matrix_h
|
|
|
|
#include <cml/core/fixed_2D.h>
|
|
#include <cml/matrix/matrix_expr.h>
|
|
#include <cml/matrix/class_ops.h>
|
|
#include <cml/matrix/matrix_unroller.h>
|
|
|
|
namespace cml {
|
|
|
|
/** Fixed-size, fixed-memory matrix. */
|
|
template<typename Element, int Rows, int Cols,
|
|
typename BasisOrient, typename Layout>
|
|
class matrix<Element,fixed<Rows,Cols>,BasisOrient,Layout>
|
|
: public fixed_2D<Element,Rows,Cols,Layout>
|
|
{
|
|
public:
|
|
|
|
/* Shorthand for the generator: */
|
|
typedef fixed<Rows,Cols> generator_type;
|
|
|
|
/* Shorthand for the array type: */
|
|
typedef fixed_2D<Element,Rows,Cols,Layout> array_type;
|
|
|
|
/* Shorthand for the type of this matrix: */
|
|
typedef matrix<Element,generator_type,BasisOrient,Layout> matrix_type;
|
|
|
|
/* For integration into the expression template code: */
|
|
typedef matrix_type expr_type;
|
|
|
|
/* For integration into the expression template code: */
|
|
typedef matrix_type temporary_type;
|
|
|
|
/* Standard: */
|
|
typedef typename array_type::value_type value_type;
|
|
typedef typename array_type::reference reference;
|
|
typedef typename array_type::const_reference const_reference;
|
|
|
|
typedef matrix_type& expr_reference;
|
|
typedef const matrix_type& expr_const_reference;
|
|
|
|
/* For matching by basis: */
|
|
typedef BasisOrient basis_orient;
|
|
|
|
/* For matching by memory layout: */
|
|
typedef typename array_type::layout layout;
|
|
|
|
/* For matching by storage type if necessary: */
|
|
typedef typename array_type::memory_tag memory_tag;
|
|
|
|
/* For matching by size type if necessary: */
|
|
typedef typename array_type::size_tag size_tag;
|
|
|
|
/* For matching by result type: */
|
|
typedef cml::et::matrix_result_tag result_tag;
|
|
|
|
/* For matching by assignability: */
|
|
typedef cml::et::assignable_tag assignable_tag;
|
|
|
|
/* To simplify the matrix transpose operator: */
|
|
typedef matrix<
|
|
typename cml::remove_const<Element>::type,
|
|
typename array_type::transposed_type::generator_type,
|
|
BasisOrient, Layout
|
|
> transposed_type;
|
|
|
|
/* To simplify the matrix row and column operators: */
|
|
typedef vector<
|
|
Element,
|
|
typename array_type::row_array_type::generator_type
|
|
> row_vector_type;
|
|
|
|
typedef vector<
|
|
Element,
|
|
typename array_type::col_array_type::generator_type
|
|
> col_vector_type;
|
|
|
|
|
|
public:
|
|
|
|
/** Set this matrix to zero. */
|
|
matrix_type& zero() {
|
|
typedef cml::et::OpAssign<Element,Element> OpT;
|
|
cml::et::UnrollAssignment<OpT>(*this,Element(0));
|
|
return *this;
|
|
}
|
|
|
|
/** Set this matrix to the identity.
|
|
*
|
|
* This only makes sense for a square matrix, but no error will be
|
|
* signaled if the matrix is not square.
|
|
*/
|
|
matrix_type& identity() {
|
|
for(size_t i = 0; i < this->rows(); ++ i) {
|
|
for(size_t j = 0; j < this->cols(); ++ j) {
|
|
(*this)(i,j) = value_type((i == j)?1:0);
|
|
}
|
|
}
|
|
return *this;
|
|
}
|
|
|
|
/** Set this matrix to its transpose.
|
|
*
|
|
* This only makes sense for a square matrix, but no error will be
|
|
* signaled if the matrix is not square.
|
|
*/
|
|
matrix_type& transpose() {
|
|
/* transpose() returns a temporary: */
|
|
*this = cml::transpose(*this);
|
|
return *this;
|
|
}
|
|
|
|
/** Set this matrix to its inverse.
|
|
*
|
|
* This only makes sense for a square matrix, but no error will be
|
|
* signaled if the matrix is not square.
|
|
*/
|
|
matrix_type& inverse() {
|
|
/* inverse() returns a temporary: */
|
|
*this = cml::inverse(*this);
|
|
return *this;
|
|
}
|
|
|
|
/* NOTE: minimize() and maximize() no longer supported (Jesse) */
|
|
|
|
#if 0
|
|
/** Pairwise minimum of this matrix with another. */
|
|
template<typename E, class AT, typename L>
|
|
void minimize(const matrix<E,AT,basis_orient,L>& v) {
|
|
/* XXX This should probably use ScalarPromote: */
|
|
for (size_t i = 0; i < this->rows(); ++i) {
|
|
for (size_t j = 0; j < this->cols(); ++j) {
|
|
(*this)(i,j) = std::min((*this)(i,j),v(i,j));
|
|
}
|
|
}
|
|
}
|
|
|
|
/** Pairwise maximum of this matrix with another. */
|
|
template<typename E, class AT, typename L>
|
|
void maximize(const matrix<E,AT,basis_orient,L>& v) {
|
|
/* XXX This should probably use ScalarPromote: */
|
|
for (size_t i = 0; i < this->rows(); ++i) {
|
|
for (size_t j = 0; j < this->cols(); ++j) {
|
|
(*this)(i,j) = std::max((*this)(i,j),v(i,j));
|
|
}
|
|
}
|
|
}
|
|
#endif
|
|
|
|
/* Set each element to a random number in the range [min,max] */
|
|
void random(ELEMENT_ARG_TYPE min, ELEMENT_ARG_TYPE max) {
|
|
for(size_t i = 0; i < this->rows(); ++i) {
|
|
for(size_t j = 0; j < this->cols(); ++j) {
|
|
(*this)(i,j) = cml::random_real(min,max);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
public:
|
|
|
|
/** Default constructor.
|
|
*
|
|
* @throws same as the ArrayType constructor.
|
|
* @sa cml::fixed
|
|
* @sa cml::dynamic
|
|
*/
|
|
matrix() {}
|
|
|
|
|
|
public:
|
|
|
|
/** Return the matrix size as a pair. */
|
|
matrix_size size() const {
|
|
return matrix_size(this->rows(),this->cols());
|
|
}
|
|
|
|
/** Return element j of basis vector i. */
|
|
value_type basis_element(size_t i, size_t j) const {
|
|
return basis_element(i,j,basis_orient());
|
|
}
|
|
|
|
/** Set the given basis element. */
|
|
void set_basis_element(size_t i, size_t j, ELEMENT_ARG_TYPE s) {
|
|
set_basis_element(i,j,s,basis_orient());
|
|
}
|
|
|
|
/** Set the matrix row from the given vector. */
|
|
void set_row(size_t i, const row_vector_type& row) {
|
|
for(size_t j = 0; j < this->cols(); ++ j) (*this)(i,j) = row[j];
|
|
}
|
|
|
|
/** Set the matrix column from the given vector. */
|
|
void set_col(size_t j, const col_vector_type& col) {
|
|
for(size_t i = 0; i < this->rows(); ++ i) (*this)(i,j) = col[i];
|
|
}
|
|
|
|
|
|
public:
|
|
|
|
/* Define common class operators: */
|
|
|
|
CML_CONSTRUCT_MAT_22
|
|
CML_CONSTRUCT_MAT_33
|
|
CML_CONSTRUCT_MAT_44
|
|
|
|
CML_MAT_COPY_FROM_FIXED_ARRAY(
|
|
array_type::array_rows, array_type::array_cols)
|
|
|
|
CML_MAT_COPY_FROM_MATTYPE
|
|
CML_MAT_COPY_FROM_MAT
|
|
CML_MAT_COPY_FROM_MATXPR
|
|
|
|
CML_ASSIGN_MAT_22
|
|
CML_ASSIGN_MAT_33
|
|
CML_ASSIGN_MAT_44
|
|
|
|
CML_MAT_ASSIGN_FROM_MATTYPE
|
|
|
|
CML_MAT_ASSIGN_FROM_MAT(=, et::OpAssign)
|
|
CML_MAT_ASSIGN_FROM_MAT(+=, et::OpAddAssign)
|
|
CML_MAT_ASSIGN_FROM_MAT(-=, et::OpSubAssign)
|
|
|
|
CML_MAT_ASSIGN_FROM_MATXPR(=, et::OpAssign)
|
|
CML_MAT_ASSIGN_FROM_MATXPR(+=, et::OpAddAssign)
|
|
CML_MAT_ASSIGN_FROM_MATXPR(-=, et::OpSubAssign)
|
|
|
|
CML_MAT_ASSIGN_FROM_SCALAR(*=, et::OpMulAssign)
|
|
CML_MAT_ASSIGN_FROM_SCALAR(/=, et::OpDivAssign)
|
|
|
|
CML_ACCUMULATED_MATRIX_MULT(const matrix_type&)
|
|
|
|
template<typename E, class AT, typename BO, typename L>
|
|
CML_ACCUMULATED_MATRIX_MULT(const TEMPLATED_MATRIX_MACRO&)
|
|
|
|
template<class XprT>
|
|
CML_ACCUMULATED_MATRIX_MULT(MATXPR_ARG_TYPE)
|
|
|
|
|
|
protected:
|
|
|
|
value_type basis_element(size_t i, size_t j, row_basis) const {
|
|
return (*this)(i,j);
|
|
}
|
|
|
|
value_type basis_element(size_t i, size_t j, col_basis) const {
|
|
return (*this)(j,i);
|
|
}
|
|
|
|
void set_basis_element(size_t i, size_t j, ELEMENT_ARG_TYPE s, row_basis) {
|
|
(*this)(i,j) = s;
|
|
}
|
|
|
|
void set_basis_element(size_t i, size_t j, ELEMENT_ARG_TYPE s, col_basis) {
|
|
(*this)(j,i) = s;
|
|
}
|
|
|
|
|
|
public:
|
|
|
|
/* Braces should only be used for testing: */
|
|
#if defined(CML_ENABLE_MATRIX_BRACES)
|
|
CML_MATRIX_BRACE_OPERATORS
|
|
#endif
|
|
};
|
|
|
|
} // namespace cml
|
|
|
|
#endif
|
|
|
|
// -------------------------------------------------------------------------
|
|
// vim:ft=cpp
|