AMP::LinearAlgebra::VectorIndexer Class Reference

#include <VectorIndexer.h>

Inheritance diagram for AMP::LinearAlgebra::VectorIndexer:

Public Member Functions
virtual size_t	getIncrement (size_t underlyingID) const =0
	Given a global id in the underlying vector, return the distance to the next id in the SubsetVector.
virtual size_t	getNumLocalElements (std::shared_ptr< Vector > v) const =0
	Given a particular underlying vector, compute the number of local elements that are in this mapping.
virtual size_t	getSubID (size_t underlyingID) const =0
	Given a global id in the underlying vector, return the subset global id.
virtual size_t	getSuperID (size_t subsetID) const =0
	Given a global id in the SubsetVector, return the corresponding global id in the underlying vector.
virtual bool	isInSub (size_t underlyingID) const =0
	Given a global id in the underlying vector, this returns true if the global id is in the SubsetVector.
virtual	~VectorIndexer ()
	Destructor.

Detailed Description

Definition at line 22 of file VectorIndexer.h.

Constructor & Destructor Documentation

~VectorIndexer()

virtual AMP::LinearAlgebra::VectorIndexer::~VectorIndexer ( )

inlinevirtual

Destructor.

Definition at line 26 of file VectorIndexer.h.

Member Function Documentation

getIncrement()

virtual size_t AMP::LinearAlgebra::VectorIndexer::getIncrement ( size_t  underlyingID ) const

pure virtual

Given a global id in the underlying vector, return the distance to the next id in the SubsetVector.

Parameters

[in]

underlyingID

The global ID of the underlying vector

Returns

getSubID ( underlyingID + 1 ) - getSubID ( underlyingID )

Implemented in AMP::LinearAlgebra::RandomAccessIndexer.

getNumLocalElements()

virtual size_t AMP::LinearAlgebra::VectorIndexer::getNumLocalElements ( std::shared_ptr< Vector >  v ) const

pure virtual

Given a particular underlying vector, compute the number of local elements that are in this mapping.

Parameters

[in]

v

A vector

Returns

The number of local objects in the vector also in the subset.

getSubID()

virtual size_t AMP::LinearAlgebra::VectorIndexer::getSubID ( size_t  underlyingID ) const

pure virtual

Given a global id in the underlying vector, return the subset global id.

Parameters

[in]

underlyingID

The global ID of the underlying vector

Returns

The global ID in the SubsetVector

Implemented in AMP::LinearAlgebra::RandomAccessIndexer.

getSuperID()

virtual size_t AMP::LinearAlgebra::VectorIndexer::getSuperID ( size_t  subsetID ) const

pure virtual

Given a global id in the SubsetVector, return the corresponding global id in the underlying vector.

Parameters

[in]

subsetID

The global ID of the SubsetVector

Returns

The global ID in underlying vector

Implemented in AMP::LinearAlgebra::RandomAccessIndexer.

isInSub()

virtual bool AMP::LinearAlgebra::VectorIndexer::isInSub ( size_t  underlyingID ) const

pure virtual

Given a global id in the underlying vector, this returns true if the global id is in the SubsetVector.

Parameters

[in]

underlyingID

The global ID of the underlying vector

Returns

True if the underlying ID is in the subset. False otherwise.

Implemented in AMP::LinearAlgebra::RandomAccessIndexer.

---

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

• src/vectors/VectorIndexer.h