AMP::LinearAlgebra::VS_Stride Class Reference

Create a subset based on a stride in the vector. More...

#include <VectorSelector.h>

Inheritance diagram for AMP::LinearAlgebra::VS_Stride:

Public Member Functions
virtual AMP_MPI	communicator (const Vector &vec) const
	Returns the communicator for the subset.
virtual bool	isSelected (const Vector &v) const override
	Returns true if Vector grossly matches a selection condition.
std::shared_ptr< const Vector >	subset (std::shared_ptr< const Vector > vec) const
	Subset the given vector.
virtual std::shared_ptr< Vector >	subset (std::shared_ptr< Vector > vec) const override
	Subset the given vector.
virtual std::shared_ptr< Vector >	subset (std::shared_ptr< Vector > vec) const=0
	Subset the given vector.
	VS_Stride (size_t offset, size_t length)
	Constructor.

Static Public Member Functions
static std::shared_ptr< VectorSelector >	create (const std::vector< std::shared_ptr< VectorSelector > > &selectors)
	Create a VectorSelector.

Protected Attributes
size_t	d_Offset
size_t	d_Stride

Detailed Description

Create a subset based on a stride in the vector.

This will pick every \(b\)th element starting at \(a\) in an vector

Definition at line 100 of file VectorSelector.h.

Constructor & Destructor Documentation

VS_Stride()

AMP::LinearAlgebra::VS_Stride::VS_Stride ( size_t  offset, size_t  length  )

explicit

Constructor.

Parameters

[in]	offset	The offset to stride
[in]	length	The length to stride

Member Function Documentation

communicator()

virtual AMP_MPI AMP::LinearAlgebra::VectorSelector::communicator ( const Vector &  vec ) const

virtualinherited

Returns the communicator for the subset.

Parameters

[in]

vec

The Vector to match

This function will return the proper communicator given the current vector. For most subsetters, this will be the same communicator as the current vector, however some subsetters (MeshSelector) may opperate on a different (smaller) comm.

Reimplemented in AMP::LinearAlgebra::VS_Comm, and AMP::LinearAlgebra::VS_Mesh.

create()

static std::shared_ptr< VectorSelector > AMP::LinearAlgebra::VectorSelector::create ( const std::vector< std::shared_ptr< VectorSelector > > &  selectors )

staticinherited

Create a VectorSelector.

Create a VectorSelector that applies a set of selectors which all must be met for the subset operation

Parameters

[in]

selectors

A list of subsequent selectors to apply

isSelected()

virtual bool AMP::LinearAlgebra::VS_Stride::isSelected ( const Vector &  vec ) const

overridevirtual

Returns true if Vector grossly matches a selection condition.

Parameters

[in]

vec

The Vector to match

Base class defaults to accepting all vectors.

Implements AMP::LinearAlgebra::VectorSelector.

subset() [1/3]

std::shared_ptr< const Vector > AMP::LinearAlgebra::VectorSelector::subset ( std::shared_ptr< const Vector >  vec ) const

virtual

Subset the given vector.

Parameters

[in]

vec

The Vector to subset

Base class defaults to returning all data in the vector

Implements AMP::LinearAlgebra::VectorSelector.

subset() [2/3]

virtual std::shared_ptr< Vector > AMP::LinearAlgebra::VS_Stride::subset ( std::shared_ptr< Vector >  vec ) const

overridevirtual

Subset the given vector.

Parameters

[in]

vec

The Vector to subset

Base class defaults to returning all data in the vector

Implements AMP::LinearAlgebra::VectorSelector.

subset() [3/3]

virtual std::shared_ptr< Vector > AMP::LinearAlgebra::VectorSelector::subset ( std::shared_ptr< Vector >  vec ) const

virtual

Subset the given vector.

Parameters

[in]

vec

The Vector to subset

Base class defaults to returning all data in the vector

Implements AMP::LinearAlgebra::VectorSelector.

Member Data Documentation

d_Offset

size_t AMP::LinearAlgebra::VS_Stride::d_Offset

protected

Definition at line 115 of file VectorSelector.h.

d_Stride

size_t AMP::LinearAlgebra::VS_Stride::d_Stride

protected

Definition at line 116 of file VectorSelector.h.

---

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

• src/vectors/VectorSelector.h