Logo ROOT   6.10/09
Reference Guide
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
TMVA::DNN::TCpuMatrix< AFloat > Class Template Reference

template<typename AFloat>
class TMVA::DNN::TCpuMatrix< AFloat >

The TCpuMatrix class.

Matrix class for multi-threaded CPU architectures. Uses the TCpuBuffer class to store the matrices in column-major format for compatibility with BLAS. Provides Map and MapFrom member functions to simplify the application of activation functions and derivatives to matrices.

Copying and assignment of TCpuMatrix objects only performs shallow copies, i.e. copying is fast and the resulting objects share the element data.

Template Parameters
AFloatThe floating point type used to represent the matrix elements.

Definition at line 46 of file CpuMatrix.h.

Public Member Functions

 TCpuMatrix (size_t nRows, size_t nCols)
 Construct matrix and allocate space for its elements. More...
 
 TCpuMatrix (const TMatrixT< Double_t > &)
 Construct a TCpuMatrix object by (deeply) copying from a TMatrixT<Double_t> matrix. More...
 
 TCpuMatrix (const TCpuBuffer< AFloat > &buffer, size_t m, size_t n)
 Construct a m-times-n matrix from the given buffer. More...
 
 TCpuMatrix (const TCpuMatrix &)=default
 
 TCpuMatrix (TCpuMatrix &&)=default
 
 ~TCpuMatrix ()=default
 
size_t GetNcols () const
 
size_t GetNElements () const
 
size_t GetNrows () const
 
AFloat * GetRawDataPointer ()
 Return raw pointer to the elements stored contiguously in column-major order. More...
 
const AFloat * GetRawDataPointer () const
 
ROOT::TThreadExecutorGetThreadExecutor () const
 
template<typename Function_t >
void Map (Function_t &f)
 Map the given function over the matrix elements. More...
 
template<typename Function_t >
void MapFrom (Function_t &f, const TCpuMatrix &A)
 Same as maps but takes the input values from the matrix A and writes the results in this matrix. More...
 
 operator TMatrixT< Double_t > () const
 Convert to a TMatrixT<Double_t> object. More...
 
AFloat operator() (size_t i, size_t j) const
 Return matrix element in row i and column j. More...
 
AFloat & operator() (size_t i, size_t j)
 
TCpuMatrixoperator= (const TCpuMatrix &)=default
 
TCpuMatrixoperator= (TCpuMatrix &&)=default
 

Static Public Member Functions

static const AFloat * GetOnePointer ()
 Returns pointer to a vector holding only ones with a guaranteed length of the number of columns of every instantiated CpuMatrix object. More...
 

Private Member Functions

void Initialize ()
 

Private Attributes

TCpuBuffer< AFloat > fBuffer
 The buffer holding the matrix elements in column-major format. More...
 
size_t fNCols
 
size_t fNRows
 

Static Private Attributes

static std::vector< AFloat > fOnes {}
 Vector filled with ones used for BLAS calls. More...
 
static ROOT::TThreadExecutor fPool {}
 

#include <TMVA/DNN/Architectures/Cpu/CpuMatrix.h>

Constructor & Destructor Documentation

◆ TCpuMatrix() [1/5]

template<typename AReal >
TMVA::DNN::TCpuMatrix< AReal >::TCpuMatrix ( size_t  nRows,
size_t  nCols 
)

Construct matrix and allocate space for its elements.

Definition at line 23 of file CpuMatrix.cxx.

◆ TCpuMatrix() [2/5]

template<typename AReal >
TMVA::DNN::TCpuMatrix< AReal >::TCpuMatrix ( const TMatrixT< Double_t > &  B)

Construct a TCpuMatrix object by (deeply) copying from a TMatrixT<Double_t> matrix.

Definition at line 31 of file CpuMatrix.cxx.

◆ TCpuMatrix() [3/5]

template<typename AFloat>
TMVA::DNN::TCpuMatrix< AFloat >::TCpuMatrix ( const TCpuBuffer< AFloat > &  buffer,
size_t  m,
size_t  n 
)

Construct a m-times-n matrix from the given buffer.

The size must of course match.

◆ TCpuMatrix() [4/5]

template<typename AFloat>
TMVA::DNN::TCpuMatrix< AFloat >::TCpuMatrix ( const TCpuMatrix< AFloat > &  )
default

◆ TCpuMatrix() [5/5]

template<typename AFloat>
TMVA::DNN::TCpuMatrix< AFloat >::TCpuMatrix ( TCpuMatrix< AFloat > &&  )
default

◆ ~TCpuMatrix()

template<typename AFloat>
TMVA::DNN::TCpuMatrix< AFloat >::~TCpuMatrix ( )
default

Member Function Documentation

◆ GetNcols()

template<typename AFloat>
size_t TMVA::DNN::TCpuMatrix< AFloat >::GetNcols ( ) const
inline

Definition at line 94 of file CpuMatrix.h.

◆ GetNElements()

template<typename AFloat>
size_t TMVA::DNN::TCpuMatrix< AFloat >::GetNElements ( ) const
inline

Definition at line 95 of file CpuMatrix.h.

◆ GetNrows()

template<typename AFloat>
size_t TMVA::DNN::TCpuMatrix< AFloat >::GetNrows ( ) const
inline

Definition at line 93 of file CpuMatrix.h.

◆ GetOnePointer()

template<typename AFloat>
static const AFloat* TMVA::DNN::TCpuMatrix< AFloat >::GetOnePointer ( )
inlinestatic

Returns pointer to a vector holding only ones with a guaranteed length of the number of columns of every instantiated CpuMatrix object.

Definition at line 62 of file CpuMatrix.h.

◆ GetRawDataPointer() [1/2]

template<typename AFloat>
AFloat* TMVA::DNN::TCpuMatrix< AFloat >::GetRawDataPointer ( )
inline

Return raw pointer to the elements stored contiguously in column-major order.

Definition at line 103 of file CpuMatrix.h.

◆ GetRawDataPointer() [2/2]

template<typename AFloat>
const AFloat* TMVA::DNN::TCpuMatrix< AFloat >::GetRawDataPointer ( ) const
inline

Definition at line 104 of file CpuMatrix.h.

◆ GetThreadExecutor()

template<typename AFloat>
ROOT::TThreadExecutor& TMVA::DNN::TCpuMatrix< AFloat >::GetThreadExecutor ( ) const
inline

Definition at line 106 of file CpuMatrix.h.

◆ Initialize()

template<typename AReal >
void TMVA::DNN::TCpuMatrix< AReal >::Initialize ( )
private

Definition at line 69 of file CpuMatrix.cxx.

◆ Map()

template<typename AFloat >
template<typename Function_t >
void TMVA::DNN::TCpuMatrix< AFloat >::Map ( Function_t &  f)
inline

Map the given function over the matrix elements.

Executed in parallel using TThreadExecutor.

Definition at line 125 of file CpuMatrix.h.

◆ MapFrom()

template<typename AFloat >
template<typename Function_t >
void TMVA::DNN::TCpuMatrix< AFloat >::MapFrom ( Function_t &  f,
const TCpuMatrix< AFloat > &  A 
)
inline

Same as maps but takes the input values from the matrix A and writes the results in this matrix.

Definition at line 140 of file CpuMatrix.h.

◆ operator TMatrixT< Double_t >()

template<typename AReal >
TMVA::DNN::TCpuMatrix< AReal >::operator TMatrixT< Double_t > ( ) const

Convert to a TMatrixT<Double_t> object.

Performs a deep copy of the matrix elements.

Definition at line 54 of file CpuMatrix.cxx.

◆ operator()() [1/2]

template<typename AFloat>
AFloat TMVA::DNN::TCpuMatrix< AFloat >::operator() ( size_t  i,
size_t  j 
) const
inline

Return matrix element in row i and column j.

Definition at line 98 of file CpuMatrix.h.

◆ operator()() [2/2]

template<typename AFloat>
AFloat& TMVA::DNN::TCpuMatrix< AFloat >::operator() ( size_t  i,
size_t  j 
)
inline

Definition at line 99 of file CpuMatrix.h.

◆ operator=() [1/2]

template<typename AFloat>
TCpuMatrix& TMVA::DNN::TCpuMatrix< AFloat >::operator= ( const TCpuMatrix< AFloat > &  )
default

◆ operator=() [2/2]

template<typename AFloat>
TCpuMatrix& TMVA::DNN::TCpuMatrix< AFloat >::operator= ( TCpuMatrix< AFloat > &&  )
default

Member Data Documentation

◆ fBuffer

template<typename AFloat>
TCpuBuffer<AFloat> TMVA::DNN::TCpuMatrix< AFloat >::fBuffer
private

The buffer holding the matrix elements in column-major format.

Definition at line 53 of file CpuMatrix.h.

◆ fNCols

template<typename AFloat>
size_t TMVA::DNN::TCpuMatrix< AFloat >::fNCols
private

Definition at line 55 of file CpuMatrix.h.

◆ fNRows

template<typename AFloat>
size_t TMVA::DNN::TCpuMatrix< AFloat >::fNRows
private

Definition at line 56 of file CpuMatrix.h.

◆ fOnes

template<typename AFloat>
std::vector< AFloat > TMVA::DNN::TCpuMatrix< AFloat >::fOnes {}
staticprivate

Vector filled with ones used for BLAS calls.

Definition at line 51 of file CpuMatrix.h.

◆ fPool

template<typename AFloat>
ROOT::TThreadExecutor TMVA::DNN::TCpuMatrix< AFloat >::fPool {}
staticprivate

Definition at line 50 of file CpuMatrix.h.


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