Provides access for Zoltan2 to Xpetra::CrsGraph data. More...

#include <Zoltan2_XpetraCrsGraphAdapter.hpp>

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

Collaboration diagram for Zoltan2::XpetraCrsGraphAdapter< 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
	~XpetraCrsGraphAdapter ()
	Destructor.
	XpetraCrsGraphAdapter (const RCP< const User > &ingraph, int nVtxWeights=0, int nEdgeWeights=0)
	Constructor for graph with no weights or coordinates.
void	setWeights (const scalar_t *val, int stride, int idx)
	Provide a pointer to weights for the primary entity type.
void	setVertexWeights (const scalar_t *val, int stride, int idx)
	Provide a pointer to vertex weights.
void	setWeightIsDegree (int idx)
	Specify an index for which the weight should be the degree of the entity.
void	setVertexWeightIsDegree (int idx)
	Specify an index for which the vertex weight should be the degree of the vertex.
void	setEdgeWeights (const scalar_t *val, int stride, int idx)
	Provide a pointer to edge weights.
RCP< const xgraph_t >	getXpetraGraph () const
	Access to Xpetra-wrapped user's graph.
RCP< const User >	getUserGraph () const
	Access to user's graph.
size_t	getLocalNumVertices () const
	Returns the number of vertices on this process.
void	getVertexIDsView (const zgid_t *&ids) const
	Sets pointers to this process' graph entries.
size_t	getLocalNumEdges () const
	Returns the number of edges on this process.
void	getEdgesView (const lno_t &offsets, const zgid_t &adjIds) const
	Gets adjacency lists for all vertices in a compressed sparse row (CSR) format.
int	getNumWeightsPerVertex () const
	Returns the number (0 or greater) of weights per vertex.
void	getVertexWeightsView (const scalar_t *&weights, int &stride, int idx) const
	Provide a pointer to the vertex weights, if any.
bool	useDegreeAsVertexWeight (int idx) const
	Indicate whether vertex weight with index idx should be the global degree of the vertex.
int	getNumWeightsPerEdge () const
	Returns the number (0 or greater) of edge weights.
void	getEdgeWeightsView (const scalar_t *&weights, int &stride, int idx) const
	Provide a pointer to the edge weights, if any.
template<typename Adapter >
void	applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
	Apply a PartitioningSolution to an input.
enum BaseAdapterType	adapterType () const
	Returns the type of adapter.
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.

Detailed Description

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

Provides access for Zoltan2 to Xpetra::CrsGraph data.

Todo:

test for memory alloc failure when we resize a vector

we assume FillComplete has been called. Should we support objects that are not FillCompleted.

The template parameter is the user's input object:

Tpetra::CrsGraph
Xpetra::CrsGraph
Epetra_CrsGraph

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 84 of file Zoltan2_XpetraCrsGraphAdapter.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>

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

Destructor.

Definition at line 103 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User , typename UserCoord >

Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::XpetraCrsGraphAdapter	(	const RCP< const User > &	ingraph,
		int	nVtxWeights = `0`,
		int	nEdgeWeights = `0`
	)

Constructor for graph with no weights or coordinates.

Parameters:

ingraph	the Epetra_CrsGraph, Tpetra::CrsGraph or Xpetra::CrsGraph
numVtxWeights	the number of weights per vertex (default = 0)
numEdgeWeights	the number of weights per edge (default = 0)

Most adapters do not have RCPs in their interface. This one does because the user is obviously a Trilinos user.

Definition at line 279 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

Member Function Documentation

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::setWeights	(	const scalar_t *	val,
		int	stride,
		int	idx
	)

Provide a pointer to weights for the primary entity type.

Parameters:

val	A pointer to the weights for index `idx`.
stride	A stride for the `val` array. If is `k`, then val[n * k] is the weight for the `n` th entity for index .
idx	A number from 0 to one less than weight idx specified in the constructor.

The order of the weights should match the order that entities appear in the input data structure.

Definition at line 334 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::setVertexWeights	(	const scalar_t *	val,
		int	stride,
		int	idx
	)

Provide a pointer to vertex weights.

Parameters:

val	A pointer to the weights for index `idx`.
stride	A stride for the `val` array. If is `k`, then val[n * k] is the weight for the `n` th vertex for index .
idx	A number from 0 to one less than number of vertex weights specified in the constructor.

The order of the vertex weights should match the order that vertices appear in the input data structure.

       TheGraph->getRowMap()->getNodeElementList()

Definition at line 345 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::setWeightIsDegree ( int idx )

Specify an index for which the weight should be the degree of the entity.

Parameters:

idx	Zoltan2 will use the entity's degree as the entity weight for index `idx`.

Definition at line 358 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::setVertexWeightIsDegree ( int idx )

Specify an index for which the vertex weight should be the degree of the vertex.

Parameters:

idx	Zoltan2 will use the vertex's degree as the vertex weight for index `idx`.

Definition at line 374 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::setEdgeWeights	(	const scalar_t *	val,
		int	stride,
		int	idx
	)

Provide a pointer to edge weights.

Parameters:

val	A pointer to the weights for index `idx`.
stride	A stride for the `val` array. If is `k`, then val[n * k] is the weight for the `n` th edge for index .
dim	A number from 0 to one less than the number of edge weights specified in the constructor.

The order of the edge weights should follow the order that the the vertices and edges appear in the input data structure.

By vertex:

       TheGraph->getRowMap()->getNodeElementList()

Then by vertex neighbor:

       TheGraph->getLocalRowView(vertexNum, neighborList);

Definition at line 385 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

RCP<const xgraph_t> Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::getXpetraGraph ( ) const [inline]

Access to Xpetra-wrapped user's graph.

Definition at line 188 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

RCP<const User> Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::getUserGraph ( ) const [inline]

Access to user's graph.

Definition at line 192 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

size_t Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::getLocalNumVertices ( ) const [inline, virtual]

Returns the number of vertices on this process.

Implements Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 204 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

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

Sets pointers to this process' graph entries.

Parameters:

vertexIds will on return a pointer to vertex global Ids

Implements Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 206 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

size_t Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::getLocalNumEdges ( ) const [inline, virtual]

Returns the number of edges on this process.

Implements Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 213 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::getEdgesView	(	const lno_t *&	offsets,
		const zgid_t *&	adjIds
	)		const `[inline, 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.

Implements Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 215 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

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

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

Reimplemented from Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 221 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::getVertexWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx
	)		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 from Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 223 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

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

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

Reimplemented from Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 232 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

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

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

Reimplemented from Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 234 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::getEdgeWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx
	)		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 from Zoltan2::GraphAdapter< User, UserCoord >.

Definition at line 236 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User , typename UserCoord >

template<typename Adapter >

void Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >::applyPartitioningSolution	(	const User &	in,
		User *&	out,
		const PartitioningSolution< Adapter > &	solution
	)		const

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 from Zoltan2::BaseAdapter< User >.

Definition at line 399 of file Zoltan2_XpetraCrsGraphAdapter.hpp.

template<typename User, typename UserCoord = User>

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

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 131 of file Zoltan2_GraphAdapter.hpp.

template<typename User, typename UserCoord = User>

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

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, inherited]

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, inherited]

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, inherited]

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, inherited]

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, inherited]

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, inherited]

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, inherited]

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, inherited]

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, inherited]

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, inherited]`

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, inherited]

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.

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

Zoltan2_XpetraCrsGraphAdapter.hpp

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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