MUQ  0.4.3
Public Member Functions | List of all members
muq::Approximation::ColumnSlice< MatType > Class Template Reference

#include <TemplatedArrayUtilities.h>

Detailed Description

template<typename MatType>
class muq::Approximation::ColumnSlice< MatType >

This class is used like mat.col(colNum) in Eigen, but can be used with more general matrix types (e.g., Kokkos::View<double**>). Based on a two dimensional matrix (anything implementing operator()(int,int), this class provides a mechanism for accessing elements in a particular column.

This class is usually not constructed directly, but is created using the "ColumnSlice" function, allowing the compiler to detect the correct template type.

Definition at line 105 of file TemplatedArrayUtilities.h.

Public Member Functions

 ColumnSlice (MatType &matrixIn, unsigned colIn)
 
double operator() (unsigned row) const
 
double operator() (unsigned row, unsigned col2) const
 
double & operator() (unsigned row)
 
double & operator() (unsigned row, unsigned col2)
 
unsigned dimension (unsigned dim) const
 
unsigned rows () const
 
unsigned cols () const
 
Eigen::VectorXd eval () const
 

Constructor & Destructor Documentation

◆ ColumnSlice()

template<typename MatType >
muq::Approximation::ColumnSlice< MatType >::ColumnSlice ( MatType &  matrixIn,
unsigned  colIn 
)
inline

Definition at line 109 of file TemplatedArrayUtilities.h.

Member Function Documentation

◆ cols()

template<typename MatType >
unsigned muq::Approximation::ColumnSlice< MatType >::cols ( ) const
inline

Definition at line 130 of file TemplatedArrayUtilities.h.

◆ dimension()

template<typename MatType >
unsigned muq::Approximation::ColumnSlice< MatType >::dimension ( unsigned  dim) const
inline

Definition at line 117 of file TemplatedArrayUtilities.h.

References muq::Approximation::GetShape(), and muq::Approximation::ColumnSlice< MatType >::matrix.

◆ eval()

template<typename MatType >
Eigen::VectorXd muq::Approximation::ColumnSlice< MatType >::eval ( ) const
inline

Definition at line 140 of file TemplatedArrayUtilities.h.

References muq::Approximation::ColumnSlice< MatType >::rows().

◆ operator()() [1/4]

template<typename MatType >
double& muq::Approximation::ColumnSlice< MatType >::operator() ( unsigned  row)
inline

Definition at line 114 of file TemplatedArrayUtilities.h.

References muq::Approximation::ColumnSlice< MatType >::col, and muq::Approximation::ColumnSlice< MatType >::matrix.

◆ operator()() [2/4]

template<typename MatType >
double muq::Approximation::ColumnSlice< MatType >::operator() ( unsigned  row) const
inline

Definition at line 111 of file TemplatedArrayUtilities.h.

References muq::Approximation::ColumnSlice< MatType >::col, and muq::Approximation::ColumnSlice< MatType >::matrix.

◆ operator()() [3/4]

template<typename MatType >
double& muq::Approximation::ColumnSlice< MatType >::operator() ( unsigned  row,
unsigned  col2 
)
inline

Definition at line 115 of file TemplatedArrayUtilities.h.

References muq::Approximation::ColumnSlice< MatType >::col, and muq::Approximation::ColumnSlice< MatType >::matrix.

◆ operator()() [4/4]

template<typename MatType >
double muq::Approximation::ColumnSlice< MatType >::operator() ( unsigned  row,
unsigned  col2 
) const
inline

Definition at line 112 of file TemplatedArrayUtilities.h.

References muq::Approximation::ColumnSlice< MatType >::col, and muq::Approximation::ColumnSlice< MatType >::matrix.

◆ rows()

template<typename MatType >
unsigned muq::Approximation::ColumnSlice< MatType >::rows ( ) const
inline

Definition at line 125 of file TemplatedArrayUtilities.h.

References muq::Approximation::GetShape(), and muq::Approximation::ColumnSlice< MatType >::matrix.

Referenced by muq::Approximation::ColumnSlice< MatType >::eval().

Member Data Documentation

◆ col

template<typename MatType >
const unsigned muq::Approximation::ColumnSlice< MatType >::col
private

Definition at line 148 of file TemplatedArrayUtilities.h.

Referenced by muq::Approximation::ColumnSlice< MatType >::operator()().

◆ matrix

template<typename MatType >
MatType& muq::Approximation::ColumnSlice< MatType >::matrix
private

Definition at line 149 of file TemplatedArrayUtilities.h.

Referenced by muq::Approximation::ColumnSlice< MatType >::dimension(), muq::Approximation::ColumnSlice< MatType >::operator()(), and muq::Approximation::ColumnSlice< MatType >::rows().

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