GraphAdapter defines the interface for graph-based user data. More...

#include <Zoltan2_GraphAdapter.hpp>

Inheritance diagram for Zoltan2::GraphAdapter< User, UserCoord >:

Collaboration diagram for Zoltan2::GraphAdapter< User, UserCoord >:

Public Types
typedef InputTraits< User >::zgid_t	zgid_t
typedef InputTraits< User > ::scalar_t	scalar_t
typedef InputTraits< User >::part_t	part_t
Public Member Functions
enum BaseAdapterType	adapterType () const
	Returns the type of adapter.
virtual	~GraphAdapter ()
	Destructor.
	GraphAdapter ()
virtual size_t	getLocalNumVertices () const =0
	Returns the number of vertices on this process.
virtual size_t	getLocalNumEdges () const =0
	Returns the number of edges on this process.
virtual void	getVertexIDsView (const zgid_t *&vertexIds) const =0
	Sets pointers to this process' graph entries.
virtual void	getEdgesView (const lno_t &offsets, const zgid_t &adjIds) const =0
	Gets adjacency lists for all vertices in a compressed sparse row (CSR) format.
virtual int	getNumWeightsPerVertex () const
	Returns the number (0 or greater) of weights per vertex.
virtual void	getVertexWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
	Provide a pointer to the vertex weights, if any.
virtual bool	useDegreeAsVertexWeight (int idx) const
	Indicate whether vertex weight with index idx should be the global degree of the vertex.
virtual int	getNumWeightsPerEdge () const
	Returns the number (0 or greater) of edge weights.
virtual void	getEdgeWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
	Provide a pointer to the edge weights, if any.
void	setCoordinateInput (VectorAdapter< UserCoord > *coordData)
	Allow user to provide additional data that contains coordinate info associated with the MatrixAdapter's primaryEntityType. Associated data must have the same parallel distribution and ordering of entries as the primaryEntityType.
bool	coordinatesAvailable () const
	Indicate whether coordinate information has been set for this MatrixAdapter.
VectorAdapter< UserCoord > *	getCoordinateInput () const
	Obtain the coordinate data registered by the user.
enum GraphEntityType	getPrimaryEntityType () const
	Returns the entity to be partitioned, ordered, colored, etc. Valid values are GRAPH_VERTEX or GRAPH_EDGE.
void	setPrimaryEntityType (std::string typestr)
	Sets the primary entity type. Called by algorithm based on parameter value in parameter list from application. Also sets to adjacencyEntityType to something reasonable: opposite of primaryEntityType.
enum GraphEntityType	getAdjacencyEntityType () const
	Returns the entity that describes adjacencies between the entities to be partitioned, ordered, colored, etc. Valid values are GRAPH_VERTEX or GRAPH_EDGE.
void	setAdjacencyEntityType (std::string typestr)
	Sets the adjacency entity type. Called by algorithm based on parameter value in parameter list from application. Also sets to primaryEntityType to something reasonable: opposite of adjacencyEntityType.
size_t	getLocalNumIDs () const
	Returns the number of objects on this process.
void	getIDsView (const zgid_t *&Ids) const
	Provide a pointer to this process' identifiers.
int	getNumWeightsPerID () const
	Returns the number of weights per object. Number of weights per object should be zero or greater. If zero, then it is assumed that all objects are equally weighted.
void	getWeightsView (const scalar_t *&wgt, int &stride, int idx=0) const
	Provide pointer to a weight array with stride.
bool	useDegreeAsWeight (int idx) const
void	getPartsView (const part_t *&inputPart) const
	Provide pointer to an array containing the input part assignment for each ID. The input part information may be used for re-partitioning to reduce data movement, or for mapping parts to processes. Adapters may return NULL for this pointer (the default behavior); if NULL is returned, algorithms will assume the rank.
template<typename Adapter >
void	applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
	Apply a PartitioningSolution to an input.

Detailed Description

template<typename User, typename UserCoord = User>
class Zoltan2::GraphAdapter< User, UserCoord >

GraphAdapter defines the interface for graph-based user data.

Adapter objects provide access for Zoltan2 to the user's data. Many built-in adapters are already defined for common data structures, such as Tpetra and Epetra objects and C-language pointers to arrays.

Data types:

scalar_t vertex and edge weights
lno_t local indices and local counts
gno_t global indices and global counts
zgid_t application global Ids
node_t is a sub class of KokkosClassic::StandardNodeMemoryModel

See IdentifierTraits to understand why the user's global ID type (zgid_t) may differ from that used by Zoltan2 (gno_t).

The Kokkos node type can be safely ignored.

The template parameter User is a user-defined data type which, through a traits mechanism, provides the actual data types with which the Zoltan2 library will be compiled. User may be the actual class or structure used by application to represent a vector, or it may be the helper class BasicUserTypes. See InputTraits for more information.

The scalar_t type, representing use data such as matrix values, is used by Zoltan2 for weights, coordinates, part sizes and quality metrics. Some User types (like Tpetra::CrsMatrix) have an inherent scalar type, and some (like Tpetra::CrsGraph) do not. For such objects, the scalar type is set by Zoltan2 to float. If you wish to change it to double, set the second template parameter to double.

Definition at line 103 of file Zoltan2_GraphAdapter.hpp.

Member Typedef Documentation

template<typename User>

typedef InputTraits<User>::zgid_t Zoltan2::BaseAdapter< User >::zgid_t [inherited]

Reimplemented in Zoltan2::PamgenMeshAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

Definition at line 97 of file Zoltan2_Adapter.hpp.

template<typename User>

typedef InputTraits<User>::scalar_t Zoltan2::BaseAdapter< User >::scalar_t [inherited]

Reimplemented in Zoltan2::PamgenMeshAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

Definition at line 98 of file Zoltan2_Adapter.hpp.

template<typename User>

typedef InputTraits<User>::part_t Zoltan2::BaseAdapter< User >::part_t [inherited]

Reimplemented in Zoltan2::PamgenMeshAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

Definition at line 100 of file Zoltan2_Adapter.hpp.

Constructor & Destructor Documentation

template<typename User, typename UserCoord = User>

virtual Zoltan2::GraphAdapter< User, UserCoord >::~GraphAdapter ( ) [inline, virtual]

Destructor.

Definition at line 135 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

Zoltan2::GraphAdapter< User, UserCoord >::GraphAdapter ( ) [inline]

Definition at line 138 of file Zoltan2_GraphAdapter.hpp.

Member Function Documentation

template<typename User, typename UserCoord = User>

enum BaseAdapterType Zoltan2::GraphAdapter< User, UserCoord >::adapterType ( ) const [inline, virtual]

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 131 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual size_t Zoltan2::GraphAdapter< User, UserCoord >::getLocalNumVertices ( ) const [pure virtual]

Returns the number of vertices on this process.

Implemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

template<typename User, typename UserCoord = User>

virtual size_t Zoltan2::GraphAdapter< User, UserCoord >::getLocalNumEdges ( ) const [pure virtual]

Returns the number of edges on this process.

Implemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::GraphAdapter< User, UserCoord >::getVertexIDsView ( const zgid_t *& vertexIds ) const [pure virtual]

Sets pointers to this process' graph entries.

Parameters:

vertexIds will on return a pointer to vertex global Ids

Implemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::GraphAdapter< User, UserCoord >::getEdgesView	(	const lno_t *&	offsets,
		const zgid_t *&	adjIds
	)		const `[pure virtual]`

Gets adjacency lists for all vertices in a compressed sparse row (CSR) format.

Parameters:

offsets	is an array of size getLocalNumVertices() + 1. The neighboring vertices for vertexId[i] begin at adjIds[offsets[i]]. The last element of offsets is the size of the adjIds array.
adjIds	on return will point to the array of adjacent vertices for for each vertex.

Implemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

template<typename User, typename UserCoord = User>

virtual int Zoltan2::GraphAdapter< User, UserCoord >::getNumWeightsPerVertex ( ) const [inline, virtual]

Returns the number (0 or greater) of weights per vertex.

Reimplemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

Definition at line 173 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::GraphAdapter< User, UserCoord >::getVertexWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx = `0`
	)		const `[inline, virtual]`

Provide a pointer to the vertex weights, if any.

Parameters:

weights	is the list of weights of the given index for the vertices returned in getVertexIDsView().
stride	The k'th weight is located at weights[stride*k]
idx	ranges from zero to one less than getNumWeightsPerVertex().

Reimplemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

Definition at line 181 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual bool Zoltan2::GraphAdapter< User, UserCoord >::useDegreeAsVertexWeight ( int idx ) const [inline, virtual]

Indicate whether vertex weight with index idx should be the global degree of the vertex.

Reimplemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

Definition at line 193 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual int Zoltan2::GraphAdapter< User, UserCoord >::getNumWeightsPerEdge ( ) const [inline, virtual]

Returns the number (0 or greater) of edge weights.

Reimplemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

Definition at line 200 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::GraphAdapter< User, UserCoord >::getEdgeWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx = `0`
	)		const `[inline, virtual]`

Provide a pointer to the edge weights, if any.

Parameters:

weights	is the list of weights of the given index for the edges returned in getEdgeView().
stride	The k'th weight is located at weights[stride*k]
idx	ranges from zero to one less than getNumWeightsPerEdge().

Reimplemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >.

Definition at line 208 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::GraphAdapter< User, UserCoord >::setCoordinateInput ( VectorAdapter< UserCoord > * coordData ) [inline]

Allow user to provide additional data that contains coordinate info associated with the MatrixAdapter's primaryEntityType. Associated data must have the same parallel distribution and ordering of entries as the primaryEntityType.

Parameters:

coordData is a pointer to a VectorAdapter with the user's coordinate data.

Definition at line 225 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

bool Zoltan2::GraphAdapter< User, UserCoord >::coordinatesAvailable ( ) const [inline]

Indicate whether coordinate information has been set for this MatrixAdapter.

Definition at line 234 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

VectorAdapter<UserCoord>* Zoltan2::GraphAdapter< User, UserCoord >::getCoordinateInput ( ) const [inline]

Obtain the coordinate data registered by the user.

Returns:: pointer a VectorAdapter with the user's coordinate data.

Definition at line 239 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

enum GraphEntityType Zoltan2::GraphAdapter< User, UserCoord >::getPrimaryEntityType ( ) const [inline]

Returns the entity to be partitioned, ordered, colored, etc. Valid values are GRAPH_VERTEX or GRAPH_EDGE.

Definition at line 250 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::GraphAdapter< User, UserCoord >::setPrimaryEntityType ( std::string typestr ) [inline]

Sets the primary entity type. Called by algorithm based on parameter value in parameter list from application. Also sets to adjacencyEntityType to something reasonable: opposite of primaryEntityType.

Definition at line 259 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

enum GraphEntityType Zoltan2::GraphAdapter< User, UserCoord >::getAdjacencyEntityType ( ) const [inline]

Returns the entity that describes adjacencies between the entities to be partitioned, ordered, colored, etc. Valid values are GRAPH_VERTEX or GRAPH_EDGE.

Definition at line 281 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::GraphAdapter< User, UserCoord >::setAdjacencyEntityType ( std::string typestr ) [inline]

Sets the adjacency entity type. Called by algorithm based on parameter value in parameter list from application. Also sets to primaryEntityType to something reasonable: opposite of adjacencyEntityType.

Definition at line 290 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

size_t Zoltan2::GraphAdapter< User, UserCoord >::getLocalNumIDs ( ) const [inline, virtual]

Returns the number of objects on this process.

Objects may be coordinates, graph vertices, matrix rows, etc. They are the objects to be partitioned, ordered, or colored.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 309 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::GraphAdapter< User, UserCoord >::getIDsView ( const zgid_t *& Ids ) const [inline, virtual]

Provide a pointer to this process' identifiers.

Parameters:

Ids	will on return point to the list of the global Ids for this process.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 316 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

int Zoltan2::GraphAdapter< User, UserCoord >::getNumWeightsPerID ( ) const [inline, virtual]

Returns the number of weights per object. Number of weights per object should be zero or greater. If zero, then it is assumed that all objects are equally weighted.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 330 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::GraphAdapter< User, UserCoord >::getWeightsView	(	const scalar_t *&	wgt,
		int &	stride,
		int	idx = `0`
	)		const `[inline, virtual]`

Provide pointer to a weight array with stride.

Parameters:

wgt	on return a pointer to the weights for this idx
stride	on return, the value such that the nth weight should be found at `wgt[n*stride]` .
idx	the weight index, zero or greater

Implements Zoltan2::BaseAdapter< User >.

Definition at line 337 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

bool Zoltan2::GraphAdapter< User, UserCoord >::useDegreeAsWeight ( int idx ) const [inline]

Definition at line 351 of file Zoltan2_GraphAdapter.hpp.

template<typename User>

void Zoltan2::BaseAdapter< User >::getPartsView ( const part_t *& inputPart ) const [inline, inherited]

Provide pointer to an array containing the input part assignment for each ID. The input part information may be used for re-partitioning to reduce data movement, or for mapping parts to processes. Adapters may return NULL for this pointer (the default behavior); if NULL is returned, algorithms will assume the rank.

Parameters:

inputPart on return a pointer to input part numbers

Definition at line 148 of file Zoltan2_Adapter.hpp.

template<typename User>

template<typename Adapter >

void Zoltan2::BaseAdapter< User >::applyPartitioningSolution	(	const User &	in,
		User *&	out,
		const PartitioningSolution< Adapter > &	solution
	)		const `[inline, inherited]`

Apply a PartitioningSolution to an input.

This is not a required part of the InputAdapter interface. However if the Caller calls a Problem method to redistribute data, it needs this method to perform the redistribution.

Parameters:

in	An input object with a structure and assignment of of global Ids to processes that matches that of the input data that instantiated this Adapter.
out	On return this should point to a newly created object with the specified partitioning.
solution	The Solution object created by a Problem should be supplied as the third argument. It must have been templated on user data that has the same global ID distribution as this user data.

Returns:: Returns the number of local Ids in the new partition.

Reimplemented in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >, Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraMultiVectorAdapter< User >.

Definition at line 174 of file Zoltan2_Adapter.hpp.

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

Zoltan2_GraphAdapter.hpp

Public Types

Public Member Functions

Detailed Description

template<typename User, typename UserCoord = User> class Zoltan2::GraphAdapter< User, UserCoord >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename User, typename UserCoord = User>
class Zoltan2::GraphAdapter< User, UserCoord >