Zoltan 2 Version 0.5
Public Member Functions | Static Public Member Functions
Zoltan2::BasicCoordinateInput< User > Class Template Reference

BasicCoordinateInput represents geometric coordinates that are supplied by the user as pointers to strided arrays. More...

#include <Zoltan2_BasicCoordinateInput.hpp>

Inheritance diagram for Zoltan2::BasicCoordinateInput< User >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::BasicCoordinateInput< User >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BasicCoordinateInput (lno_t numIds, const gid_t *ids, const scalar_t *x, const scalar_t *y, const scalar_t *z, int xStride=1, int yStride=1, int zStride=1)
 Constructor for dimension 1, 2 or 3 and no weights.
 BasicCoordinateInput (lno_t numIds, const gid_t *ids, vector< const scalar_t * > &values, vector< int > &valueStrides, vector< const scalar_t * > &weights, vector< int > &weightStrides)
 Constructor for arbitrary dimension with weights.
 ~BasicCoordinateInput ()
string inputAdapterName () const
 Returns a descriptive name that identifies the concrete adapter.
size_t getLocalNumberOfObjects () const
 Returns the number of objects in the input.
int getNumberOfWeightsPerObject () 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.
size_t getObjectWeights (int dim, const scalar_t *&wgt, int &stride) const
 Provide pointer to a weight array with stride.
int getCoordinateDimension () const
 Return dimension of the coordinates.
int getNumberOfWeights () const
 Return the number of weights per coordinate.
size_t getLocalNumberOfCoordinates () const
 Return the number of coordinates on this process.
size_t getCoordinates (int dim, const gid_t *&gids, const scalar_t *&coords, int &stride) const
 Provide a pointer to one dimension of this process' coordinates.
size_t getCoordinateWeights (int dim, const scalar_t *&weights, int &stride) const
 Provide a pointer to the weights, if any, corresponding to the coordinates returned in getCoordinates().
enum InputAdapterType inputAdapterType () const
 Returns the type of adapter.
template<typename Adapter >
size_t applyPartitioningSolution (User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
 Apply a PartitioningSolution to an input.

Static Public Member Functions

static string inputAdapterTypeName (InputAdapterType iaType)
 Returns the name of the input adapter.

Detailed Description

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

BasicCoordinateInput represents geometric coordinates that are supplied by the user as pointers to strided arrays.

Input adapters provide access for Zoltan2 to the user's data. The methods in the interface must be defined by users. 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:

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:

rcb_C.cpp.

Definition at line 93 of file Zoltan2_BasicCoordinateInput.hpp.


Constructor & Destructor Documentation

template<typename User >
Zoltan2::BasicCoordinateInput< User >::BasicCoordinateInput ( lno_t  numIds,
const gid_t *  ids,
const scalar_t *  x,
const scalar_t *  y,
const scalar_t *  z,
int  xStride = 1,
int  yStride = 1,
int  zStride = 1 
)

Constructor for dimension 1, 2 or 3 and no weights.

Parameters:
numIdsThe number of local coordinates.
idsThe global identifiers for the coordinates.
xA pointer to the first dimension of the coordinates.
yA pointer to the second dimension, if any.
zA pointer to the third dimension, if any.
xStrideThe stride for the x list. The coordinate for point ids[n] should be found at x[xStride * n].
yStrideThe stride for the y list. The coordinate for point ids[n] should be found at y[yStride * n].
zStrideThe stride for the z list. The coordinate for point ids[n] should be found at z[zStride * n].

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

Definition at line 239 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User >
Zoltan2::BasicCoordinateInput< User >::BasicCoordinateInput ( lno_t  numIds,
const gid_t *  ids,
vector< const scalar_t * > &  values,
vector< int > &  valueStrides,
vector< const scalar_t * > &  weights,
vector< int > &  weightStrides 
)

Constructor for arbitrary dimension with weights.

Parameters:
numIdsthe local number of coordinates.
idsis a pointer to the coordinate global Ids.
valuesa list of pointers to the coordinate values corresponding to the numIds ids. The coordinate dimension is taken to be values.size().
valueStridesThe strides for the values list. The coordinate for dimension n for ids[k] should be found at values[n][valueStrides[n] * k]. If valueStrides.size() is zero, it is assumed all strides are one.
weightsa list of pointers to arrays of weights. The number of weights per coordinate is assumed to be weights.size().
weightStridesa list of strides for the weights. The weight for weight dimension 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 InputAdapter.

Definition at line 273 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
Zoltan2::BasicCoordinateInput< User >::~BasicCoordinateInput ( ) [inline]

Destructor

Definition at line 161 of file Zoltan2_BasicCoordinateInput.hpp.


Member Function Documentation

template<typename User>
string Zoltan2::BasicCoordinateInput< User >::inputAdapterName ( ) const [inline, virtual]

Returns a descriptive name that identifies the concrete adapter.

Implements Zoltan2::InputAdapter< User >.

Definition at line 167 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
size_t Zoltan2::BasicCoordinateInput< User >::getLocalNumberOfObjects ( ) const [inline, virtual]

Returns the number of objects in the input.

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

Implements Zoltan2::InputAdapter< User >.

Definition at line 169 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
int Zoltan2::BasicCoordinateInput< User >::getNumberOfWeightsPerObject ( ) 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::InputAdapter< User >.

Definition at line 171 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
size_t Zoltan2::BasicCoordinateInput< User >::getObjectWeights ( int  dim,
const scalar_t *&  wgt,
int &  stride 
) const [inline, virtual]

Provide pointer to a weight array with stride.

Parameters:
dimthe weight dimension, zero or greater
wgton return a pointer to the weights for this dimension
strideon return, the value such that the nth weight should be found at wgt[n*stride] .
Returns:
the length of the wgt array, which should be at least equal to getLocalNumberOfObjects() * stride .

Implements Zoltan2::InputAdapter< User >.

Definition at line 173 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
int Zoltan2::BasicCoordinateInput< User >::getCoordinateDimension ( ) const [inline, virtual]

Return dimension of the coordinates.

Implements Zoltan2::CoordinateInput< User >.

Definition at line 182 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
int Zoltan2::BasicCoordinateInput< User >::getNumberOfWeights ( ) const [inline, virtual]

Return the number of weights per coordinate.

Returns:
the count of weights, zero or more per coordinate.

Implements Zoltan2::CoordinateInput< User >.

Definition at line 184 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
size_t Zoltan2::BasicCoordinateInput< User >::getLocalNumberOfCoordinates ( ) const [inline, virtual]

Return the number of coordinates on this process.

Returns:
the count of coordinates on the local process.

Implements Zoltan2::CoordinateInput< User >.

Definition at line 186 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
size_t Zoltan2::BasicCoordinateInput< User >::getCoordinates ( int  coordDim,
const gid_t *&  gids,
const scalar_t *&  coords,
int &  stride 
) const [inline, virtual]

Provide a pointer to one dimension of this process' coordinates.

Parameters:
coordDimis a value from 0 to one less than getLocalNumberOfCoordinates() specifying which dimension is being provided in the coords list.
coordspoints to a list of coordinate values for the dimension.
stridedescribes the layout of the coordinate values in the coords list. If stride is one, then the ith coordinate value is coords[i], but if stride is two, then the ith coordinate value is coords[2*i].
Returns:
The length of the coords list. This may be more than getLocalNumberOfCoordinates() because the stride may be more than one.

Zoltan2 does not copy your data. The data pointed to coords must remain valid for the lifetime of this InputAdapter.

Implements Zoltan2::CoordinateInput< User >.

Definition at line 188 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User>
size_t Zoltan2::BasicCoordinateInput< User >::getCoordinateWeights ( int  weightDim,
const scalar_t *&  weights,
int &  stride 
) const [inline, virtual]

Provide a pointer to the weights, if any, corresponding to the coordinates returned in getCoordinates().

Parameters:
weightDimranges from zero to one less than getNumberOfWeights()
weightsis the list of weights of the given dimension for the coordinates listed in getCoordinates(). If weights for this dimension are to be uniform for all coordinates in the global problem, the weights should be a NULL pointer.
strideThe k'th weight is located at weights[stride*k]
Returns:
The number of weights listed, which should be at least the local number of coordinates times the stride for non-uniform weights, zero otherwise.

Implements Zoltan2::CoordinateInput< User >.

Definition at line 203 of file Zoltan2_BasicCoordinateInput.hpp.

template<typename User >
enum InputAdapterType Zoltan2::CoordinateInput< User >::inputAdapterType ( ) const [inline, virtual, inherited]

Returns the type of adapter.

Implements Zoltan2::InputAdapter< User >.

Definition at line 127 of file Zoltan2_CoordinateInput.hpp.

template<typename User >
template<typename Adapter >
size_t Zoltan2::CoordinateInput< User >::applyPartitioningSolution ( 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 CoordinateInput interface. However if the Caller calls a Problem method to redistribute data, it needs this method to perform the redistribution.

Parameters:
inAn input object with a structure and assignment of of global Ids to processes that matches that of the input data that instantiated this InputAdapter.
outOn return this should point to a newly created object with the specified partitioning.
solutionThe 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 partitioning.

Definition at line 204 of file Zoltan2_CoordinateInput.hpp.

template<typename User >
string Zoltan2::InputAdapter< User >::inputAdapterTypeName ( InputAdapterType  iaType) [static, inherited]

Returns the name of the input adapter.

Definition at line 134 of file Zoltan2_InputAdapter.hpp.


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