Zoltan2
Public Types | Public Member Functions | List of all members
Zoltan2::BasicIdentifierAdapter< User > Class Template Reference

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 >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::BasicIdentifierAdapter< User >:
Collaboration graph
[legend]

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 >::part_t part_t
 
typedef InputTraits< User >::node_t node_t
 
typedef IdentifierAdapter< User > base_adapter_t
 
typedef User user_t
 
- Public Types inherited from Zoltan2::BaseAdapter< User >
typedef InputTraits< User >::gno_t gno_t
 
typedef InputTraits< User >::scalar_t scalar_t
 
typedef InputTraits< User >::part_t part_t
 

Public Member Functions

 BasicIdentifierAdapter (lno_t numIds, const gno_t *idPtr, std::vector< const scalar_t * > &weights, std::vector< int > &weightStrides)
 Constructor. More...
 
size_t getLocalNumIDs () const
 Returns the number of objects on this process. More...
 
void getIDsView (const gno_t *&Ids) const
 Provide a pointer to this process' identifiers. More...
 
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. More...
 
void getWeightsView (const scalar_t *&weights, int &stride, int idx) const
 Provide pointer to a weight array with stride. More...
 
- Public Member Functions inherited from Zoltan2::IdentifierAdapter< User >
virtual ~IdentifierAdapter ()
 Destructor. More...
 
enum BaseAdapterType adapterType () const
 Returns the type of adapter. More...
 
- Public Member Functions inherited from Zoltan2::BaseAdapter< User >
virtual ~BaseAdapter ()
 Destructor. More...
 
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. More...
 
template<typename Adapter >
void applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
 Apply a PartitioningSolution to an input. More...
 

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

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>::part_t Zoltan2::BasicIdentifierAdapter< User >::part_t

Definition at line 90 of file Zoltan2_BasicIdentifierAdapter.hpp.

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

Definition at line 91 of file Zoltan2_BasicIdentifierAdapter.hpp.

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

Definition at line 92 of file Zoltan2_BasicIdentifierAdapter.hpp.

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

Definition at line 93 of file Zoltan2_BasicIdentifierAdapter.hpp.

Constructor & Destructor Documentation

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

Constructor.

Parameters
numIdsis the number of identifiers in the list
idsshould point to a list of numIds identifiers.
weightsa list of pointers to arrays of weights. The number of weights per identifier is assumed to be weights.size().
weightStridesa 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 147 of file Zoltan2_BasicIdentifierAdapter.hpp.

Member Function Documentation

template<typename User>
size_t Zoltan2::BasicIdentifierAdapter< User >::getLocalNumIDs ( ) const
inlinevirtual

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 117 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>
void Zoltan2::BasicIdentifierAdapter< User >::getIDsView ( const gno_t *&  Ids) const
inlinevirtual

Provide a pointer to this process' identifiers.

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

Implements Zoltan2::BaseAdapter< User >.

Definition at line 119 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>
int Zoltan2::BasicIdentifierAdapter< User >::getNumWeightsPerID ( ) const
inlinevirtual

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 121 of file Zoltan2_BasicIdentifierAdapter.hpp.

template<typename User>
void Zoltan2::BasicIdentifierAdapter< User >::getWeightsView ( const scalar_t *&  wgt,
int &  stride,
int  idx 
) const
inlinevirtual

Provide pointer to a weight array with stride.

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

Implements Zoltan2::BaseAdapter< User >.

Definition at line 123 of file Zoltan2_BasicIdentifierAdapter.hpp.


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