This class represents a collection of global Identifiers and their associated weights, if any. More...

#include <Zoltan2_BasicIdentifierAdapter.hpp>

Inheritance diagram for Zoltan2::BasicIdentifierAdapter< User >:

Collaboration diagram for Zoltan2::BasicIdentifierAdapter< User >:

Public Types
typedef InputTraits< User > ::scalar_t	scalar_t
typedef InputTraits< User >::lno_t	lno_t
typedef InputTraits< User >::gno_t	gno_t
typedef InputTraits< User >::zgid_t	zgid_t
typedef InputTraits< User >::part_t	part_t
typedef InputTraits< User >::node_t	node_t
typedef IdentifierAdapter< User >	base_adapter_t
typedef User	user_t
Public Member Functions
	BasicIdentifierAdapter (lno_t numIds, const zgid_t idPtr, std::vector< const scalar_t > &weights, std::vector< int > &weightStrides)
	Constructor.
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 *&weights, int &stride, int idx) const
	Provide pointer to a weight array with stride.
enum BaseAdapterType	adapterType () const
	Returns the type of adapter.
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>
class Zoltan2::BasicIdentifierAdapter< User >

This class represents a collection of global Identifiers and their associated weights, if any.

The user supplies the identifiers and weights by way of pointers to arrays.

The template parameter (User) is a C++ class type which provides the actual data types with which the Zoltan2 library will be compiled, through a Traits mechanism. User may be the actual class used by application to represent coordinates, or it may be the empty helper class BasicUserTypes with which a Zoltan2 user can easily supply the data types for the library.

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.

Examples:: block.cpp.

Definition at line 83 of file Zoltan2_BasicIdentifierAdapter.hpp.

Member Typedef Documentation

template<typename User>

typedef InputTraits<User>::scalar_t Zoltan2::BasicIdentifierAdapter< User >::scalar_t

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 87 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

typedef InputTraits<User>::lno_t Zoltan2::BasicIdentifierAdapter< User >::lno_t

Definition at line 88 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

typedef InputTraits<User>::gno_t Zoltan2::BasicIdentifierAdapter< User >::gno_t

Definition at line 89 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

typedef InputTraits<User>::zgid_t Zoltan2::BasicIdentifierAdapter< User >::zgid_t

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 90 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

typedef InputTraits<User>::part_t Zoltan2::BasicIdentifierAdapter< User >::part_t

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 91 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

typedef InputTraits<User>::node_t Zoltan2::BasicIdentifierAdapter< User >::node_t

Definition at line 92 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

typedef IdentifierAdapter<User> Zoltan2::BasicIdentifierAdapter< User >::base_adapter_t

Definition at line 93 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

typedef User Zoltan2::BasicIdentifierAdapter< User >::user_t

Definition at line 94 of file Zoltan2_BasicIdentifierAdapter.hpp.

Constructor & Destructor Documentation

template<typename User >

Zoltan2::BasicIdentifierAdapter< User >::BasicIdentifierAdapter	(	lno_t	numIds,
		const zgid_t *	idPtr,
		std::vector< const scalar_t * > &	weights,
		std::vector< int > &	weightStrides
	)

Constructor.

Parameters:

numIds	is the number of identifiers in the list
ids	should point to a list of numIds identifiers.
weights	a list of pointers to arrays of weights. The number of weights per identifier is assumed to be `weights.size()`.
weightStrides	a list of strides for the `weights`. The weight for weight index `n` for `ids`[k] should be found at `weights[n][weightStrides[n] * k]`. If `weightStrides.size()` is zero, it is assumed all strides are one.

The values pointed to the arguments must remain valid for the lifetime of this Adapter.

Definition at line 148 of file Zoltan2_BasicIdentifierAdapter.hpp.

Member Function Documentation

template<typename User>

size_t Zoltan2::BasicIdentifierAdapter< User >::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 118 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

void Zoltan2::BasicIdentifierAdapter< User >::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 120 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

int Zoltan2::BasicIdentifierAdapter< User >::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 122 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

void Zoltan2::BasicIdentifierAdapter< User >::getWeightsView	(	const scalar_t *&	wgt,
		int &	stride,
		int	idx
	)		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 124 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>

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

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 120 of file Zoltan2_IdentifierAdapter.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_BasicIdentifierAdapter.hpp

Public Types

Public Member Functions

Detailed Description

template<typename User> class Zoltan2::BasicIdentifierAdapter< User >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename User>
class Zoltan2::BasicIdentifierAdapter< User >