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

Detailed Description

template<class T>
class gnsstk::ConstMatrixColSlice< T >

a constant slice of a single column from a matrix.

Definition at line 60 of file Matrix.hpp.

#include <Matrix.hpp>

Public Member Functions

size_t cols () const
 returns the size of the slice in columns 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...
 
 ConstMatrixColSlice ()
 default constructor More...
 
 ConstMatrixColSlice (const Matrix< T > &mat, size_t col)
 constructor taking a slice of column col from the matrix. More...
 
 ConstMatrixColSlice (const Matrix< T > &mat, size_t col, const std::slice &s)
 
operator() (size_t i) const
 returns the i'th element of the column slice More...
 
operator() (size_t i, size_t j) const
 returns the (i,j) element of the column slice More...
 
operator[] (size_t i) const
 returns the i'th element of the column slice More...
 
size_t rows () const
 returns the size of the slice in rows 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
 returns the overall size of the slice More...
 

Private Attributes

size_t c
 the column this slice refers to More...
 
const Matrix< T > * m
 the matrix this slice refers to More...
 
std::slice rSlice
 a slice down the rows More...
 

Constructor & Destructor Documentation

◆ ConstMatrixColSlice() [1/3]

template<class T >
gnsstk::ConstMatrixColSlice< T >::ConstMatrixColSlice ( )
inline

default constructor

Definition at line 512 of file Matrix.hpp.

◆ ConstMatrixColSlice() [2/3]

template<class T >
gnsstk::ConstMatrixColSlice< T >::ConstMatrixColSlice ( const Matrix< T > &  mat,
size_t  col 
)
inline

constructor taking a slice of column col from the matrix.

Definition at line 517 of file Matrix.hpp.

◆ ConstMatrixColSlice() [3/3]

template<class T >
gnsstk::ConstMatrixColSlice< T >::ConstMatrixColSlice ( const Matrix< T > &  mat,
size_t  col,
const std::slice &  s 
)
inline

constructor taking a slice of column col from the matrix, slicing the column by s.

Definition at line 523 of file Matrix.hpp.

Member Function Documentation

◆ cols()

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

returns the size of the slice in columns

Definition at line 545 of file Matrix.hpp.

◆ colSize()

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

returns the number of columns in this slice

Definition at line 556 of file Matrix.hpp.

◆ colStart()

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

returns the starting row in the base matrix of this slice

Definition at line 558 of file Matrix.hpp.

◆ colStride()

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

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

Definition at line 560 of file Matrix.hpp.

◆ operator()() [1/2]

template<class T >
T gnsstk::ConstMatrixColSlice< T >::operator() ( size_t  i) const
inline

returns the i'th element of the column slice

Definition at line 535 of file Matrix.hpp.

◆ operator()() [2/2]

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

returns the (i,j) element of the column slice

Definition at line 539 of file Matrix.hpp.

◆ operator[]()

template<class T >
T gnsstk::ConstMatrixColSlice< T >::operator[] ( size_t  i) const
inline

returns the i'th element of the column slice

Definition at line 532 of file Matrix.hpp.

◆ rows()

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

returns the size of the slice in rows

Definition at line 543 of file Matrix.hpp.

◆ rowSize()

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

returns the number of rows in this slice

Definition at line 550 of file Matrix.hpp.

◆ rowStart()

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

returns the starting row in the base matrix of this slice

Definition at line 552 of file Matrix.hpp.

◆ rowStride()

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

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

Definition at line 554 of file Matrix.hpp.

◆ size()

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

returns the overall size of the slice

Definition at line 547 of file Matrix.hpp.

Member Data Documentation

◆ c

template<class T >
size_t gnsstk::ConstMatrixColSlice< T >::c
private

the column this slice refers to

Definition at line 565 of file Matrix.hpp.

◆ m

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

the matrix this slice refers to

Definition at line 563 of file Matrix.hpp.

◆ rSlice

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

a slice down the rows

Definition at line 567 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