MatrixFactory< T > Class Template Reference

Class that creates empty matrix objects of the specified type. More...

#include <MatrixFactory.h>

Collaboration diagram for MatrixFactory< T >:

Public Member Functions
	MatrixFactory (MatrixType type)
	Constructor from enum (internal use) for the MatrixFactory class.
	MatrixFactory (const std::string &type)
	Constructor from string (user config) for the MatrixFactory class.
std::unique_ptr< GenericMatrix< T > >	createUnique ()
	Creation function that creates a Matrix based on the default type.
std::unique_ptr< GenericMatrix< T > >	createUnique (MatrixType type)
	Creation function that creates a Matrix based on the supplied type.
std::shared_ptr< GenericMatrix< T > >	createShared ()
	Creation function that creates a Matrix based on the default type.
std::shared_ptr< GenericMatrix< T > >	createShared (MatrixType type)
	Creation function that creates a Matrix based on the supplied type.

Detailed Description

template<typename T>
class MatrixFactory< T >

Class that creates empty matrix objects of the specified type.

Template Parameters

T	Numeric type used in the simulation (e.g., float, double)

Constructor & Destructor Documentation

MatrixFactory() [1/2]

template<typename T >

MatrixFactory< T >::MatrixFactory

(

MatrixType

type

)

Constructor from enum (internal use) for the MatrixFactory class.

Template Parameters

T	Numeric type used in the simulation (e.g., float, double)

Parameters

type	The default value for the matrix type as MatrixType enum value. Currently implemented: "Dense", "Csr".

MatrixFactory() [2/2]

template<typename T >

MatrixFactory< T >::MatrixFactory

(

const std::string &

type

)

Constructor from string (user config) for the MatrixFactory class.

Template Parameters

T	Numeric type used in the simulation (e.g., float, double)

Parameters

type	The default value for the matrix type. Currently implemented: "dense", "csr".

Member Function Documentation

createShared() [1/2]

template<typename T >

std::shared_ptr< GenericMatrix< T > > MatrixFactory< T >::createShared

(

)

Creation function that creates a Matrix based on the default type.

Template Parameters

T	Numeric type used in the simulation (e.g., float, double)

Parameters

type	The matrix type as MatrixType enum value. Currently implemented: "Dense", "Csr".

createShared() [2/2]

template<typename T >

std::shared_ptr< GenericMatrix< T > > MatrixFactory< T >::createShared

(

MatrixType

type

)

Creation function that creates a Matrix based on the supplied type.

Template Parameters

T	Numeric type used in the simulation (e.g., float, double).

Parameters

type	The matrix type as MatrixType enum value. Currently implemented: "Dense", "Csr".

createUnique() [1/2]

template<typename T >

std::unique_ptr< GenericMatrix< T > > MatrixFactory< T >::createUnique

(

)

Creation function that creates a Matrix based on the default type.

Template Parameters

T	Numeric type used in the simulation (e.g., float, double)

createUnique() [2/2]

template<typename T >

std::unique_ptr< GenericMatrix< T > > MatrixFactory< T >::createUnique

(

MatrixType

type

)

Creation function that creates a Matrix based on the supplied type.

Template Parameters

T	Numeric type used in the simulation (e.g., float, double)

Parameters

type	The matrix type as MatrixType enum value. Currently implemented: "Dense", "Csr".

---

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

• src/MatrixFactory.h