Zoltan2
|
This class represents a collection of global Identifiers and their associated weights, if any. More...
#include <Zoltan2_BasicIdentifierAdapter.hpp>
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 User | user_t |
Public Types inherited from Zoltan2::BaseAdapter< User > | |
typedef InputTraits< User >::lno_t | lno_t |
typedef InputTraits< User >::gno_t | gno_t |
typedef InputTraits< User > ::scalar_t | scalar_t |
typedef InputTraits< User >::part_t | part_t |
typedef InputTraits< User > ::offset_t | offset_t |
Public Member Functions | |
BasicIdentifierAdapter (lno_t numIds, const gno_t *idPtr, std::vector< const scalar_t * > &weights, std::vector< int > &weightStrides) | |
Constructor. More... | |
BasicIdentifierAdapter (lno_t numIds, const gno_t *idPtr) | |
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. Default is zero weights per ID. 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... | |
virtual void | getIDsKokkosView (Kokkos::View< gno_t * > &) const |
Provide a pointer to this process' identifiers. More... | |
virtual void | getWeightsKokkosView (Kokkos::View< scalar_t * > &, int=0) const |
Provide pointer to a weight View. 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... | |
Public Member Functions inherited from Zoltan2::BaseAdapterRoot | |
virtual | ~BaseAdapterRoot () |
Additional Inherited Members | |
Protected Member Functions inherited from Zoltan2::BaseAdapter< User > | |
void | generateWeightFileOnly (const char *fileprefix, const Teuchos::Comm< int > &comm) const |
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
.
Definition at line 82 of file Zoltan2_BasicIdentifierAdapter.hpp.
typedef InputTraits<User>::scalar_t Zoltan2::BasicIdentifierAdapter< User >::scalar_t |
Definition at line 85 of file Zoltan2_BasicIdentifierAdapter.hpp.
typedef InputTraits<User>::lno_t Zoltan2::BasicIdentifierAdapter< User >::lno_t |
Definition at line 86 of file Zoltan2_BasicIdentifierAdapter.hpp.
typedef InputTraits<User>::gno_t Zoltan2::BasicIdentifierAdapter< User >::gno_t |
Definition at line 87 of file Zoltan2_BasicIdentifierAdapter.hpp.
typedef InputTraits<User>::part_t Zoltan2::BasicIdentifierAdapter< User >::part_t |
Definition at line 88 of file Zoltan2_BasicIdentifierAdapter.hpp.
typedef InputTraits<User>::node_t Zoltan2::BasicIdentifierAdapter< User >::node_t |
Definition at line 89 of file Zoltan2_BasicIdentifierAdapter.hpp.
typedef User Zoltan2::BasicIdentifierAdapter< User >::user_t |
Definition at line 90 of file Zoltan2_BasicIdentifierAdapter.hpp.
Zoltan2::BasicIdentifierAdapter< User >::BasicIdentifierAdapter | ( | lno_t | numIds, |
const gno_t * | idPtr, | ||
std::vector< const scalar_t * > & | weights, | ||
std::vector< int > & | weightStrides | ||
) |
Constructor.
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 151 of file Zoltan2_BasicIdentifierAdapter.hpp.
|
inline |
Constructor.
numIds | is the number of identifiers in the list |
ids | should point to a list of numIds identifiers. |
The values pointed to the arguments must remain valid for the lifetime of this Adapter.
Definition at line 116 of file Zoltan2_BasicIdentifierAdapter.hpp.
|
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::BaseAdapterRoot.
Definition at line 123 of file Zoltan2_BasicIdentifierAdapter.hpp.
|
inlinevirtual |
Provide a pointer to this process' identifiers.
ids | will on return point to the list of the global Ids for this process. |
Reimplemented from Zoltan2::BaseAdapter< User >.
Definition at line 125 of file Zoltan2_BasicIdentifierAdapter.hpp.
|
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. Default is zero weights per ID.
Reimplemented from Zoltan2::BaseAdapterRoot.
Definition at line 127 of file Zoltan2_BasicIdentifierAdapter.hpp.
|
inlinevirtual |
Provide pointer to a weight array with stride.
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 This function must be implemented in derived adapter if getNumWeightsPerID > 0. This function should not be called if getNumWeightsPerID is zero. |
Reimplemented from Zoltan2::BaseAdapter< User >.
Definition at line 129 of file Zoltan2_BasicIdentifierAdapter.hpp.