Ravelin
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
CONST_SHAREDMATRIXN Class Reference

A generic, possibly non-square matrix using constant shared data. More...

#include <SharedMatrixN.h>

Public Member Functions

 CONST_SHAREDMATRIXN (const SHAREDMATRIXN &source)
 Copy constructor.
 
 CONST_SHAREDMATRIXN (const CONST_SHAREDMATRIXN &source)
 Copy constructor.
 
 CONST_SHAREDMATRIXN (unsigned rows, unsigned cols, unsigned leading_dim, unsigned start, SharedResizable< REAL > data)
 Constructs the matrix using the given arguments.
 
const SHAREDMATRIXN get () const
 Gets this object as a standard shared matrix. More...
 
void reset_from (const CONST_SHAREDMATRIXN &source)
 Resets this from another shared matrix.
 
void reset_from (const SHAREDMATRIXN &source)
 Resets this from another shared matrix.
 
bool is_symmetric (REAL tolerance=(REAL)-1.0) const
 
REAL norm_inf () const
 
unsigned rows () const
 
unsigned columns () const
 
unsigned leading_dim () const
 
CONST_SHAREDMATRIXNresize (unsigned rows, unsigned columns, bool preserve=false)
 
const REAL & operator() (unsigned i, unsigned j) const
 Accesses the given element.
 
const REAL * data () const
 
void reset ()
 Resets the shared matrix.
 
CONST_COLUMN_ITERATOR block_column_iterator_begin (unsigned row_start, unsigned row_end, unsigned col_start, unsigned col_end) const
 This file consists of general routines for constant matrices. More...
 
CONST_COLUMN_ITERATOR block_column_iterator_end (unsigned row_start, unsigned row_end, unsigned col_start, unsigned col_end) const
 Gets a column iterator to a block.
 
CONST_ROW_ITERATOR block_row_iterator_begin (unsigned row_start, unsigned row_end, unsigned col_start, unsigned col_end) const
 Gets a row iterator to a block.
 
CONST_ROW_ITERATOR block_row_iterator_end (unsigned row_start, unsigned row_end, unsigned col_start, unsigned col_end) const
 Gets a row iterator to a block.
 
template<class V >
V & get_row (unsigned row, V &v) const
 
template<class V >
V & get_column (unsigned column, V &v) const
 
template<class T , class U >
U & transpose_mult_transpose (const T &x, U &y, REAL alpha=(REAL) 1.0, REAL beta=(REAL) 0.0) const
 Does the operation y = beta*y + alpha*this'*x'.
 
template<class T , class U >
U & mult_transpose (const T &x, U &y, REAL alpha=(REAL) 1.0, REAL beta=(REAL) 0.0) const
 Does the operation y = beta*y + alpha*this*x'.
 
template<class T , class U >
U & transpose_mult (const T &x, U &y, REAL alpha=(REAL) 1.0, REAL beta=(REAL) 0.0) const
 Does the operation y = beta*y + alpha*this'*x.
 
template<class T , class U >
U & mult (const T &x, U &y, REAL alpha=(REAL) 1.0, REAL beta=(REAL) 0.0) const
 Does the operation y = beta*y + alpha*this*x.
 
template<class M >
M & get_sub_mat (unsigned row_start, unsigned row_end, unsigned col_start, unsigned col_end, M &m, Transposition trans=eNoTranspose) const
 Gets the specified sub matrix. More...
 
template<class ForwardIterator , class M >
M & select_columns (ForwardIterator col_start, ForwardIterator col_end, M &m) const
 Gets a submatrix of columns (not necessarily a block) More...
 
template<class M >
M & select_columns (std::vector< bool > &col_select, M &m) const
 Gets a submatrix of columns (not necessarily a block) More...
 
template<class ForwardIterator , class M >
M & select_rows (ForwardIterator row_start, ForwardIterator row_end, M &m) const
 Gets a submatrix of rows (not necessarily a block) More...
 
template<class M >
M & select_rows (std::vector< bool > &row_select, M &m) const
 Gets a submatrix of rows (not necessarily a block) More...
 
template<class ForwardIterator1 , class ForwardIterator2 , class X >
X & select (ForwardIterator1 row_start, ForwardIterator1 row_end, ForwardIterator2 col_start, ForwardIterator2 col_end, X &m) const
 Gets a submatrix (not necessarily a block) More...
 
template<class X >
X & select (const std::vector< bool > &rows, const std::vector< bool > &cols, X &m) const
 Gets a submatrix (not necessarily a block)
 
template<class M >
M & select_square (const std::vector< bool > &indices, M &result) const
 Gets a square submatrix (not necessarily a block)
 
template<class ForwardIterator , class M >
M & select_square (ForwardIterator start, ForwardIterator end, M &m) const
 
CONST_COLUMN_ITERATOR column_iterator_begin () const
 Get an iterator to the beginning.
 
CONST_COLUMN_ITERATOR column_iterator_end () const
 Get an iterator to the end.
 
CONST_ROW_ITERATOR row_iterator_begin () const
 Get an iterator to the beginning.
 
CONST_ROW_ITERATOR row_iterator_end () const
 Get an iterator to the end.
 
CONST_SHAREDVECTORN row (unsigned i) const
 Gets the specified sub matrix. More...
 
CONST_SHAREDVECTORN column (unsigned i) const
 Gets a shared vector for a column.
 
CONST_SHAREDMATRIXN block (unsigned row_start, unsigned row_end, unsigned col_start, unsigned col_end) const
 Gets a block as a constant shared matrix.
 

Static Public Member Functions

template<class V , class U , class W >
static W & diag_mult (const V &d, const U &v, W &result)
 Determines the transpose of a matrix and stores the result in a given matrix. More...
 

Protected Attributes

SharedResizable< REAL > _data
 
unsigned _rows
 
unsigned _start
 
unsigned _columns
 
unsigned _ld
 

Friends

class MATRIXN
 
class SHAREDMATRIXN
 

Detailed Description

A generic, possibly non-square matrix using constant shared data.

The underlying data is stored in column-major format (e.g., the element at row 1, column 0 is the second element in the flat array).

Member Function Documentation

CONST_COLUMN_ITERATOR CONST_SHAREDMATRIXN::block_column_iterator_begin ( unsigned  row_start,
unsigned  row_end,
unsigned  col_start,
unsigned  col_end 
) const
inline

This file consists of general routines for constant matrices.

Gets a column iterator to a block

template<class V , class U , class W >
static W& CONST_SHAREDMATRIXN::diag_mult ( const V &  d,
const U &  v,
W &  result 
)
inlinestatic

Determines the transpose of a matrix and stores the result in a given matrix.

Multiplies the diagonal matrix formed from d by the vector v

const SHAREDMATRIXN CONST_SHAREDMATRIXN::get ( ) const

Gets this object as a standard shared matrix.

Note
const-ness is not enforced by my compiler!
template<class M >
M& CONST_SHAREDMATRIXN::get_sub_mat ( unsigned  row_start,
unsigned  row_end,
unsigned  col_start,
unsigned  col_end,
M &  m,
Transposition  trans = eNoTranspose 
) const
inline

Gets the specified sub matrix.

Parameters
row_startthe row to start (inclusive)
row_endthe row to end (exclusive)
col_startthe column to start (inclusive)
col_endthe column to end (exclusive)
transposedetermines whether to store the transpose of the submatrix into m
Returns
a (row_end - row_start) x (col_end - col_start) sized matrix
CONST_SHAREDVECTORN CONST_SHAREDMATRIXN::row ( unsigned  i) const
inline

Gets the specified sub matrix.

Parameters
row_startthe row to start (inclusive)
row_endthe row to end (exclusive)
col_startthe column to start (inclusive)
col_endthe column to end (exclusive)
transposedetermines whether to store the transpose of the submatrix into m
Returns
a (row_end - row_start) x (col_end - col_start) sized matrixGets a constant shared vector for a row
template<class ForwardIterator1 , class ForwardIterator2 , class X >
X& CONST_SHAREDMATRIXN::select ( ForwardIterator1  row_start,
ForwardIterator1  row_end,
ForwardIterator2  col_start,
ForwardIterator2  col_end,
X &  m 
) const
inline

Gets a submatrix (not necessarily a block)

Parameters
row_startan iterator pointing to the beginning of a container of row indices (container need not be sorted)
row_endan iterator pointing to the end of a container of row indices (container need not be sorted)
col_startan iterator pointing to the beginning of a container of column indices (container need not be sorted)
col_endan iterator pointing to the end of a container of column indices (container need not be sorted)
Mcontains the submatrix on return
template<class ForwardIterator , class M >
M& CONST_SHAREDMATRIXN::select_columns ( ForwardIterator  col_start,
ForwardIterator  col_end,
M &  m 
) const
inline

Gets a submatrix of columns (not necessarily a block)

Parameters
col_startan iterator pointing to the beginning of a container of column indices (container need not be sorted)
col_endan iterator pointing to the end of a container of column indices (container need not be sorted)
Mcontains the submatrix on return
template<class M >
M& CONST_SHAREDMATRIXN::select_columns ( std::vector< bool > &  col_select,
M &  m 
) const
inline

Gets a submatrix of columns (not necessarily a block)

Parameters
col_selecta vector of bools; if the entry is true in the vector, the column is selected
Mcontains the submatrix on return
template<class ForwardIterator , class M >
M& CONST_SHAREDMATRIXN::select_rows ( ForwardIterator  row_start,
ForwardIterator  row_end,
M &  m 
) const
inline

Gets a submatrix of rows (not necessarily a block)

Parameters
row_startan iterator pointing to the beginning of a container of row indices (container need not be sorted)
row_endan iterator pointing to the end of a container of row indices (container need not be sorted)
Mcontains the submatrix on return
template<class M >
M& CONST_SHAREDMATRIXN::select_rows ( std::vector< bool > &  row_select,
M &  m 
) const
inline

Gets a submatrix of rows (not necessarily a block)

Parameters
row_selecta vector of bools; if the entry is true in the vector, the row is selected
Mcontains the submatrix on return
template<class ForwardIterator , class M >
M& CONST_SHAREDMATRIXN::select_square ( ForwardIterator  start,
ForwardIterator  end,
M &  m 
) const
inline
Parameters
startan iterator pointing to the beginning of a container of row/column indices (container need not be sorted)
endan iterator pointing to the end of a container of row/column indices (container need not be sorted)
Mcontains the submatrix on return

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