aligator
0.16.0
A versatile and efficient C++ library for real-time constrained trajectory optimization.
|
Block matrix class, with a fixed or dynamic-size number of row and column blocks. More...
#include <aligator/gar/blk-matrix.hpp>
Public Types | |
enum | { N = _N , M = _M , Options = PlainObject::Options } |
using | MatrixType = _MatrixType |
using | PlainObject = typename MatrixType::PlainObject |
using | Scalar = typename MatrixType::Scalar |
using | Index = Eigen::Index |
using | RowDimsType |
using | ColDimsType |
Public Member Functions | |
BlkMatrix () | |
BlkMatrix (const RowDimsType &rowDims, const ColDimsType &colDims) | |
template<typename Other> | |
BlkMatrix (const Eigen::MatrixBase< Other > &data, const RowDimsType &rowDims, const ColDimsType &colDims) | |
template<typename Other> | |
BlkMatrix (Eigen::MatrixBase< Other > &data, const RowDimsType &rowDims, const ColDimsType &colDims) | |
template<typename Other> | |
BlkMatrix (const Eigen::MatrixBase< Other > &data, const RowDimsType &dims) | |
Only-rows constructor (only for vectors) | |
template<typename Other> | |
BlkMatrix (Eigen::MatrixBase< Other > &data, const RowDimsType &dims) | |
Only-rows constructor (only for vectors) | |
operator Eigen::Ref< PlainObject > () | |
operator Eigen::Ref< const PlainObject > () const | |
BlkMatrix (const RowDimsType &dims) | |
Only-rows constructor (only for vectors) | |
auto | operator() (size_t i, size_t j) |
Get the block in position ( i , j ) | |
auto | operator() (size_t i, size_t j) const |
auto | blockRow (size_t i) |
auto | blockRow (size_t i) const |
auto | blockCol (size_t j) const |
auto | blockCol (size_t j) |
auto | blockSegment (size_t i) |
auto | blockSegment (size_t i) const |
auto | operator[] (size_t i) |
auto | operator[] (size_t i) const |
template<typename Other> | |
BlkMatrix & | operator= (const Eigen::MatrixBase< Other > &other) |
Set the data to be equal to some other Eigen object. | |
void | setZero () |
template<typename Other> | |
void | swap (BlkMatrix< Other, N, M > &other) |
MatrixType & | matrix () |
const MatrixType & | matrix () const |
const RowDimsType & | rowDims () const |
const RowDimsType & | rowIndices () const |
const ColDimsType & | colDims () const |
const ColDimsType & | colIndices () const |
Index | rows () const |
Index | cols () const |
auto | topBlkRows (size_t n) |
template<size_t n> | |
auto | topBlkRows () |
Static Public Member Functions | |
static BlkMatrix | Zero (const RowDimsType &rowDims, const ColDimsType &colDims) |
Static Public Attributes | |
static constexpr bool | IsVectorAtCompileTime |
Protected Member Functions | |
void | initialize () |
Protected Attributes | |
MatrixType | m_data |
RowDimsType | m_rowDims |
ColDimsType | m_colDims |
RowDimsType | m_rowIndices |
ColDimsType | m_colIndices |
Index | m_totalRows |
Index | m_totalCols |
Friends | |
std::ostream & | operator<< (std::ostream &oss, const BlkMatrix &self) |
Block matrix class, with a fixed or dynamic-size number of row and column blocks.
Baseline | matrix type; the user can use an Eigen::Ref type to create a blocked view to an existing matrix. |
N | number of block rows. |
M | number of block columns. |
Definition at line 19 of file blk-matrix.hpp.
using aligator::BlkMatrix< _MatrixType, _N, _M >::MatrixType = _MatrixType |
Definition at line 21 of file blk-matrix.hpp.
using aligator::BlkMatrix< _MatrixType, _N, _M >::PlainObject = typename MatrixType::PlainObject |
Definition at line 22 of file blk-matrix.hpp.
using aligator::BlkMatrix< _MatrixType, _N, _M >::Scalar = typename MatrixType::Scalar |
Definition at line 23 of file blk-matrix.hpp.
using aligator::BlkMatrix< _MatrixType, _N, _M >::Index = Eigen::Index |
Definition at line 24 of file blk-matrix.hpp.
using aligator::BlkMatrix< _MatrixType, _N, _M >::RowDimsType |
Definition at line 29 of file blk-matrix.hpp.
using aligator::BlkMatrix< _MatrixType, _N, _M >::ColDimsType |
Definition at line 31 of file blk-matrix.hpp.
anonymous enum |
Enumerator | |
---|---|
N | |
M | |
Options |
Definition at line 25 of file blk-matrix.hpp.
|
inline |
Definition at line 41 of file blk-matrix.hpp.
|
inline |
Definition at line 50 of file blk-matrix.hpp.
|
inline |
Definition at line 62 of file blk-matrix.hpp.
|
inline |
Definition at line 75 of file blk-matrix.hpp.
|
inline |
Only-rows constructor (only for vectors)
Definition at line 89 of file blk-matrix.hpp.
|
inline |
Only-rows constructor (only for vectors)
Definition at line 94 of file blk-matrix.hpp.
|
inlineexplicit |
Only-rows constructor (only for vectors)
Definition at line 101 of file blk-matrix.hpp.
|
inline |
Definition at line 97 of file blk-matrix.hpp.
|
inline |
Definition at line 98 of file blk-matrix.hpp.
|
inline |
Get the block in position ( i
, j
)
Definition at line 108 of file blk-matrix.hpp.
|
inline |
Definition at line 114 of file blk-matrix.hpp.
|
inline |
Definition at line 119 of file blk-matrix.hpp.
|
inline |
Definition at line 123 of file blk-matrix.hpp.
|
inline |
Definition at line 127 of file blk-matrix.hpp.
|
inline |
Definition at line 131 of file blk-matrix.hpp.
|
inline |
Definition at line 135 of file blk-matrix.hpp.
|
inline |
Definition at line 140 of file blk-matrix.hpp.
|
inline |
Definition at line 145 of file blk-matrix.hpp.
|
inline |
Definition at line 147 of file blk-matrix.hpp.
|
inline |
Set the data to be equal to some other Eigen object.
Definition at line 151 of file blk-matrix.hpp.
|
inline |
Definition at line 158 of file blk-matrix.hpp.
|
inlinestatic |
Definition at line 159 of file blk-matrix.hpp.
|
inline |
Definition at line 167 of file blk-matrix.hpp.
|
inline |
Definition at line 171 of file blk-matrix.hpp.
|
inline |
Definition at line 172 of file blk-matrix.hpp.
|
inline |
Definition at line 174 of file blk-matrix.hpp.
|
inline |
Definition at line 175 of file blk-matrix.hpp.
|
inline |
Definition at line 176 of file blk-matrix.hpp.
|
inline |
Definition at line 177 of file blk-matrix.hpp.
|
inline |
Definition at line 179 of file blk-matrix.hpp.
|
inline |
Definition at line 180 of file blk-matrix.hpp.
|
inline |
Definition at line 182 of file blk-matrix.hpp.
|
inline |
Definition at line 191 of file blk-matrix.hpp.
|
inlineprotected |
Definition at line 215 of file blk-matrix.hpp.
|
friend |
Definition at line 202 of file blk-matrix.hpp.
|
staticconstexpr |
Definition at line 26 of file blk-matrix.hpp.
|
protected |
Definition at line 207 of file blk-matrix.hpp.
|
protected |
Definition at line 208 of file blk-matrix.hpp.
|
protected |
Definition at line 209 of file blk-matrix.hpp.
|
protected |
Definition at line 210 of file blk-matrix.hpp.
|
protected |
Definition at line 211 of file blk-matrix.hpp.
|
protected |
Definition at line 212 of file blk-matrix.hpp.
|
protected |
Definition at line 213 of file blk-matrix.hpp.