Base class for operator and vector (i.e. global/local matrix/stencil/vector) classes, all the backend-related interface and data are defined here. More...

#include <base_paralution.hpp>

Inheritance diagram for paralution::BaseParalution< ValueType >:

Public Member Functions
	BaseParalution ()

	BaseParalution (const BaseParalution< ValueType > &src)

virtual	~BaseParalution ()

BaseParalution< ValueType > &	operator= (const BaseParalution< ValueType > &src)

virtual void	MoveToAccelerator (void)=0
	Move the object to the Accelerator backend. More...

virtual void	MoveToHost (void)=0
	Move the object to the Host backend. More...

virtual void	MoveToAcceleratorAsync (void)
	Move the object to the Accelerator backend with async move. More...

virtual void	MoveToHostAsync (void)
	Move the object to the Host backend with async move. More...

virtual void	Sync (void)

void	CloneBackend (const BaseParalution< ValueType > &src)
	Clone the Backend descriptor from another object. More...

template<typename ValueType2 >
void	CloneBackend (const BaseParalution< ValueType2 > &src)
	Clone the Backend descriptor from another object with different template ValueType. More...

virtual void	info () const =0
	Print the object information (properties, backends) More...

virtual void	Clear ()=0
	Clear (free all data) the object. More...

Protected Member Functions
virtual bool	is_host (void) const =0
	Return true if the object is on the host. More...

virtual bool	is_accel (void) const =0
	Return true if the object is on the accelerator. More...

Protected Attributes
std::string	object_name_
	Name of the object. More...

Paralution_Backend_Descriptor	local_backend_
	Backend descriptor. More...

bool	asyncf

size_t	global_obj_id

Friends
class	BaseParalution< double >

class	BaseParalution< float >

class	BaseParalution< std::complex< double > >

class	BaseParalution< std::complex< float > >

class	BaseParalution< int >

Detailed Description

template<typename ValueType>
class paralution::BaseParalution< ValueType >

Base class for operator and vector (i.e. global/local matrix/stencil/vector) classes, all the backend-related interface and data are defined here.

Constructor & Destructor Documentation

template<typename ValueType >

paralution::BaseParalution< ValueType >::BaseParalution ( )

template<typename ValueType >

paralution::BaseParalution< ValueType >::BaseParalution ( const BaseParalution< ValueType > & src )

template<typename ValueType >

paralution::BaseParalution< ValueType >::~BaseParalution ( )

virtual

Member Function Documentation

template<typename ValueType>

virtual void paralution::BaseParalution< ValueType >::Clear ( )

pure virtual

Clear (free all data) the object.

Implements paralution::ParalutionObj.

Implemented in paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, paralution::LocalMatrix< ValueTypeH >, paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, paralution::LocalVector< ValueTypeH >, paralution::LocalStencil< ValueType >, and paralution::Vector< ValueType >.

template<typename ValueType >

void paralution::BaseParalution< ValueType >::CloneBackend ( const BaseParalution< ValueType > & src )

Clone the Backend descriptor from another object.

Referenced by paralution::AMG< OperatorType, VectorType, ValueType >::Aggregate(), paralution::SIRA< OperatorTypeH, VectorTypeH, ValueTypeH, OperatorTypeL, VectorTypeL, ValueTypeL >::Build_(), paralution::MultiColored< OperatorType, VectorType, ValueType >::Decompose_(), main(), paralution::LocalMatrix< ValueType >::MaximalIndependentSet(), paralution::LocalMatrix< ValueType >::MultiColoring(), and paralution::LocalMatrix< ValueType >::UpdateValuesCSR().

template<typename ValueType >

template<typename ValueType2 >

void paralution::BaseParalution< ValueType >::CloneBackend ( const BaseParalution< ValueType2 > & src )

Clone the Backend descriptor from another object with different template ValueType.

template<typename ValueType>

virtual void paralution::BaseParalution< ValueType >::info ( ) const

pure virtual

Print the object information (properties, backends)

Implemented in paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, paralution::LocalVector< ValueTypeH >, paralution::LocalStencil< ValueType >, paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, and paralution::LocalMatrix< ValueTypeH >.

template<typename ValueType>

virtual bool paralution::BaseParalution< ValueType >::is_accel ( void ) const

protectedpure virtual

Return true if the object is on the accelerator.

Implemented in paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, paralution::LocalMatrix< ValueTypeH >, paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, paralution::LocalVector< ValueTypeH >, and paralution::LocalStencil< ValueType >.

Referenced by paralution::BaseParalution< ValueType >::CloneBackend().

template<typename ValueType>

virtual bool paralution::BaseParalution< ValueType >::is_host ( void ) const

protectedpure virtual

Return true if the object is on the host.

Implemented in paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, paralution::LocalMatrix< ValueTypeH >, paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, paralution::LocalVector< ValueTypeH >, and paralution::LocalStencil< ValueType >.

Referenced by paralution::BaseParalution< ValueType >::CloneBackend().

template<typename ValueType>

virtual void paralution::BaseParalution< ValueType >::MoveToAccelerator ( void )

pure virtual

Move the object to the Accelerator backend.

Implemented in paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, paralution::LocalMatrix< ValueTypeH >, paralution::LocalStencil< ValueType >, paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, and paralution::LocalVector< ValueTypeH >.

template<typename ValueType >

void paralution::BaseParalution< ValueType >::MoveToAcceleratorAsync ( void )

virtual

Move the object to the Accelerator backend with async move.

Reimplemented in paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, paralution::LocalMatrix< ValueTypeH >, paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, and paralution::LocalVector< ValueTypeH >.

template<typename ValueType>

virtual void paralution::BaseParalution< ValueType >::MoveToHost ( void )

pure virtual

Move the object to the Host backend.

Implemented in paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, paralution::LocalMatrix< ValueTypeH >, paralution::LocalStencil< ValueType >, paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, and paralution::LocalVector< ValueTypeH >.

template<typename ValueType >

void paralution::BaseParalution< ValueType >::MoveToHostAsync ( void )

virtual

Move the object to the Host backend with async move.

Reimplemented in paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, paralution::LocalMatrix< ValueTypeH >, paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, and paralution::LocalVector< ValueTypeH >.

template<typename ValueType >

BaseParalution< ValueType > & paralution::BaseParalution< ValueType >::operator= ( const BaseParalution< ValueType > & src )

template<typename ValueType >

void paralution::BaseParalution< ValueType >::Sync ( void )

virtual

Reimplemented in paralution::LocalMatrix< ValueType >, paralution::LocalMatrix< ValueTypeL >, paralution::LocalMatrix< ValueTypeH >, paralution::LocalVector< ValueType >, paralution::LocalVector< ValueTypeL >, paralution::LocalVector< int >, and paralution::LocalVector< ValueTypeH >.

Friends And Related Function Documentation

template<typename ValueType>

friend class BaseParalution< double >

friend

template<typename ValueType>

friend class BaseParalution< float >

friend

template<typename ValueType>

friend class BaseParalution< int >

friend

template<typename ValueType>

friend class BaseParalution< std::complex< double > >

friend

template<typename ValueType>

friend class BaseParalution< std::complex< float > >

friend

Field Documentation

template<typename ValueType>

bool paralution::BaseParalution< ValueType >::asyncf

protected

size_t paralution::ParalutionObj::global_obj_id

protectedinherited

Referenced by paralution::ParalutionObj::ParalutionObj(), and paralution::ParalutionObj::~ParalutionObj().

template<typename ValueType>

Paralution_Backend_Descriptor paralution::BaseParalution< ValueType >::local_backend_

protected

Backend descriptor.

Referenced by paralution::BaseParalution< ValueType >::CloneBackend(), and paralution::LocalMatrix< ValueType >::CloneFrom().

template<typename ValueType>

std::string paralution::BaseParalution< ValueType >::object_name_

protected

Name of the object.

Referenced by paralution::LocalMatrix< ValueType >::CloneFrom(), paralution::LocalMatrix< ValueType >::CMK(), paralution::LocalMatrix< ValueType >::ExtractSubMatrix(), paralution::LocalMatrix< ValueType >::MatrixMult(), and paralution::LocalMatrix< ValueType >::RCMK().

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

base/base_paralution.hpp
base/base_paralution.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<typename ValueType> class paralution::BaseParalution< ValueType >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation

template<typename ValueType>
class paralution::BaseParalution< ValueType >