Public Member Functions | Private Attributes | List of all members
gnsstk::ConstMatrixSlice< T > Class Template Reference

Detailed Description

template<class T>
class gnsstk::ConstMatrixSlice< T >

An unmodifiable matrix slice.

Definition at line 345 of file Matrix.hpp.

#include <Matrix.hpp>

Inheritance diagram for gnsstk::ConstMatrixSlice< T >:
Inheritance graph
[legend]

Public Member Functions

size_t cols () const
 the number of columns in the slice More...
 
size_t colSize () const
 returns the number of columns in this slice More...
 
size_t colStart () const
 returns the starting row in the base matrix of this slice More...
 
size_t colStride () const
 returns the number of elements between the i'th and i+1'th row More...
 
 ConstMatrixSlice (const Matrix< T > &mat)
 makes a const slice of the whole matrix More...
 
 ConstMatrixSlice (const Matrix< T > &mat, const std::slice &rowSlice, const std::slice &colSlice)
 makes a slice given std::slices for rows and columns More...
 
 ConstMatrixSlice (const Matrix< T > &mat, size_t topRow, size_t topCol, size_t numRows, size_t numCols)
 submatrix slice More...
 
 ConstMatrixSlice (void)
 default constructor More...
 
operator() (size_t i, size_t j) const
 the (i,j) element of the slice, const. More...
 
size_t rows () const
 the number of rows in the slice More...
 
size_t rowSize () const
 returns the number of rows in this slice More...
 
size_t rowStart () const
 returns the starting row in the base matrix of this slice More...
 
size_t rowStride () const
 returns the number of elements between the i'th and i+1'th row More...
 
size_t size () const
 the size of the slice More...
 
- Public Member Functions inherited from gnsstk::ConstMatrixSliceBase< T, ConstMatrixSlice< T > >
 ConstMatrixSliceBase ()
 
- Public Member Functions inherited from gnsstk::ConstMatrixBase< T, ConstMatrixSlice< T > >
Vector< T > colCopy (size_t c, size_t r=0) const
 
size_t cols () const
 the number of columns in the matrix More...
 
 ConstMatrixBase ()
 default constructor More...
 
Vector< T > diagCopy (void) const
 
bool isDiagonal () const
 returns true if this is a diagonal matrix More...
 
bool isLT () const
 returns true if this is a lower triangular matrix. More...
 
bool isSquare () const
 returns true if this is a square matrix (false for a null matrix). More...
 
bool isSymmetric () const
 
bool isUT () const
 returns true if this is an upper triangular matrix. More...
 
operator() (size_t i, size_t j) const
 
Vector< T > rowCopy (size_t r, size_t c=0) const
 
size_t rows () const
 the number of rows in the matrix More...
 
size_t size () const
 the rows()*cols() size of the matrix. More...
 
virtual ~ConstMatrixBase ()
 

Private Attributes

std::slice cSlice
 the column slice More...
 
const Matrix< T > * m
 the matrix this slice refers to. More...
 
std::slice rSlice
 the row slice More...
 
size_t s
 the size of the slice More...
 

Additional Inherited Members

- Protected Member Functions inherited from gnsstk::MatrixSliceBase< T, ConstMatrixSlice< T > >
void matSliceCheck (size_t sourceRowSize, size_t sourceColSize) const
 
- Protected Member Functions inherited from gnsstk::ConstMatrixBase< T, ConstMatrixSlice< T > >
constMatrixRef (size_t i, size_t j) const
 

Constructor & Destructor Documentation

◆ ConstMatrixSlice() [1/4]

template<class T >
gnsstk::ConstMatrixSlice< T >::ConstMatrixSlice ( void  )
inline

default constructor

Definition at line 349 of file Matrix.hpp.

◆ ConstMatrixSlice() [2/4]

template<class T >
gnsstk::ConstMatrixSlice< T >::ConstMatrixSlice ( const Matrix< T > &  mat)
inline

makes a const slice of the whole matrix

Definition at line 354 of file Matrix.hpp.

◆ ConstMatrixSlice() [3/4]

template<class T >
gnsstk::ConstMatrixSlice< T >::ConstMatrixSlice ( const Matrix< T > &  mat,
const std::slice &  rowSlice,
const std::slice &  colSlice 
)
inline

makes a slice given std::slices for rows and columns

Definition at line 362 of file Matrix.hpp.

◆ ConstMatrixSlice() [4/4]

template<class T >
gnsstk::ConstMatrixSlice< T >::ConstMatrixSlice ( const Matrix< T > &  mat,
size_t  topRow,
size_t  topCol,
size_t  numRows,
size_t  numCols 
)
inline

submatrix slice

Definition at line 371 of file Matrix.hpp.

Member Function Documentation

◆ cols()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::cols ( ) const
inline

the number of columns in the slice

Definition at line 383 of file Matrix.hpp.

◆ colSize()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::colSize ( ) const
inline

returns the number of columns in this slice

Definition at line 398 of file Matrix.hpp.

◆ colStart()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::colStart ( ) const
inline

returns the starting row in the base matrix of this slice

Definition at line 400 of file Matrix.hpp.

◆ colStride()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::colStride ( ) const
inline

returns the number of elements between the i'th and i+1'th row

Definition at line 402 of file Matrix.hpp.

◆ operator()()

template<class T >
T gnsstk::ConstMatrixSlice< T >::operator() ( size_t  i,
size_t  j 
) const
inline

the (i,j) element of the slice, const.

Definition at line 387 of file Matrix.hpp.

◆ rows()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::rows ( ) const
inline

the number of rows in the slice

Definition at line 385 of file Matrix.hpp.

◆ rowSize()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::rowSize ( ) const
inline

returns the number of rows in this slice

Definition at line 392 of file Matrix.hpp.

◆ rowStart()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::rowStart ( ) const
inline

returns the starting row in the base matrix of this slice

Definition at line 394 of file Matrix.hpp.

◆ rowStride()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::rowStride ( ) const
inline

returns the number of elements between the i'th and i+1'th row

Definition at line 396 of file Matrix.hpp.

◆ size()

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::size ( ) const
inline

the size of the slice

Definition at line 381 of file Matrix.hpp.

Member Data Documentation

◆ cSlice

template<class T >
std::slice gnsstk::ConstMatrixSlice< T >::cSlice
private

the column slice

Definition at line 407 of file Matrix.hpp.

◆ m

template<class T >
const Matrix<T>* gnsstk::ConstMatrixSlice< T >::m
private

the matrix this slice refers to.

Definition at line 405 of file Matrix.hpp.

◆ rSlice

template<class T >
std::slice gnsstk::ConstMatrixSlice< T >::rSlice
private

the row slice

Definition at line 406 of file Matrix.hpp.

◆ s

template<class T >
size_t gnsstk::ConstMatrixSlice< T >::s
private

the size of the slice

Definition at line 408 of file Matrix.hpp.


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


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:44