MatrixAdapter defines the adapter interface for matrices. More...

#include <Zoltan2_MatrixAdapter.hpp>

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

Collaboration diagram for Zoltan2::MatrixAdapter< 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
enum BaseAdapterType	adapterType () const
	Returns the type of adapter.
	MatrixAdapter ()
virtual	~MatrixAdapter ()
	Destructor.
virtual size_t	getLocalNumRows () const =0
	Returns the number of rows on this process.
virtual size_t	getLocalNumColumns () const =0
	Returns the number of columns on this process.
virtual size_t	getLocalNumEntries () const =0
	Returns the number of nonzeros on this process.
virtual bool	CRSViewAvailable () const
	Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.
virtual void	getRowIDsView (const zgid_t *&rowIds) const
	Sets pointer to this process' rows' global IDs.
virtual void	getCRSView (const lno_t &offsets, const zgid_t &colIds) const
	Sets pointers to this process' matrix entries using compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.
virtual void	getCRSView (const lno_t &offsets, const zgid_t &colIds, const scalar_t *&values) const
	Sets pointers to this process' matrix entries and their values using compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.
virtual int	getNumWeightsPerRow () const
	Returns the number of weights per row (0 or greater). Row weights may be used when partitioning matrix rows.
virtual void	getRowWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
	Provide a pointer to the row weights, if any.
virtual bool	useNumNonzerosAsRowWeight (int idx) const
	Indicate whether row weight with index idx should be the global number of nonzeros in the row.
virtual bool	CCSViewAvailable () const
	Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.
virtual void	getColumnIDsView (const zgid_t *&colIds) const
	Sets pointer to this process' columns' global IDs.
virtual void	getCCSView (const lno_t &offsets, const zgid_t &rowIds) const
	Sets pointers to this process' matrix entries using compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.
virtual void	getCCSView (const lno_t &offsets, const zgid_t &rowIds, const scalar_t *&values) const
	Sets pointers to this process' matrix entries and their values using compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.
virtual int	getNumWeightsPerColumn () const
	Returns the number of weights per column (0 or greater). Column weights may be used when partitioning matrix columns.
virtual void	getColumnWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
	Provide a pointer to the column weights, if any.
virtual bool	useNumNonzerosAsColumnWeight (int idx) const
	Indicate whether column weight with index idx should be the global number of nonzeros in the column.
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 MatrixEntityType	getPrimaryEntityType () const
	Returns the entity to be partitioned, ordered, colored, etc. Valid values are MATRIX_ROW, MATRIX_COLUMN, MATRIX_NONZERO.
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.
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.
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, typename UserCoord = User>
class Zoltan2::MatrixAdapter< User, UserCoord >

MatrixAdapter defines the adapter interface for matrices.

Adapter objects provide access for Zoltan2 to the user's data. 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:

scalar_t row, column or non-zero weights
lno_t local indices and local counts
gno_t global indices and global counts
zgid_t application global Ids
node_t is a sub class of KokkosClassic::StandardNodeMemoryModel

See IdentifierTraits to understand why the user's global ID type (zgid_t) may differ from that used by Zoltan2 (gno_t).

The Kokkos node type can be safely ignored.

The template parameter User is a user-defined data type which, through a traits mechanism, provides the actual data types with which the Zoltan2 library will be compiled. User may be the actual class or structure used by application to represent a vector, or it may be the helper class BasicUserTypes. See InputTraits for more information.

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.

Todo:

Create BasicCrsMatrixAdapter subclass

Do we want to require adapters to give us the global number of rows, columns etc? We can figure that out.

This is a row-oriented matrix. Do we need a column-oriented matrix? In particular - we assumed coordinates are for rows.

If the user can tell us there are no diagonal entries in a square matrix, it can save time if we have to remove them for the algorithm. Should we have a set method in subclasses for setMatrixHasDiagonalEntries yes, no and maybe?

Definition at line 110 of file Zoltan2_MatrixAdapter.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::MatrixAdapter< User, UserCoord >::MatrixAdapter ( ) [inline]

Definition at line 132 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

Destructor.

Definition at line 138 of file Zoltan2_MatrixAdapter.hpp.

Member Function Documentation

template<typename User, typename UserCoord = User>

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

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 129 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual size_t Zoltan2::MatrixAdapter< User, UserCoord >::getLocalNumRows ( ) const [pure virtual]

Returns the number of rows on this process.

Implemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

template<typename User, typename UserCoord = User>

virtual size_t Zoltan2::MatrixAdapter< User, UserCoord >::getLocalNumColumns ( ) const [pure virtual]

Returns the number of columns on this process.

Implemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

template<typename User, typename UserCoord = User>

virtual size_t Zoltan2::MatrixAdapter< User, UserCoord >::getLocalNumEntries ( ) const [pure virtual]

Returns the number of nonzeros on this process.

Implemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

template<typename User, typename UserCoord = User>

virtual bool Zoltan2::MatrixAdapter< User, UserCoord >::CRSViewAvailable ( ) const [inline, virtual]

Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.

Reimplemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

Definition at line 159 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getRowIDsView ( const zgid_t *& rowIds ) const [inline, virtual]

Sets pointer to this process' rows' global IDs.

Parameters:

rowIds will on return a pointer to row global Ids

Reimplemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

Definition at line 164 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCRSView	(	const lno_t *&	offsets,
		const zgid_t *&	colIds
	)		const `[inline, virtual]`

Sets pointers to this process' matrix entries using compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.

Parameters:

offsets	is an array of size numRows + 1. The column Ids for rowIds[i] (returned by getRowIDsView) begin at colIds[offsets[i]]. The last element of offsets is the size of the colIds array.
colIds	on return will point to the global column Ids for the non-zeros for each row.

Reimplemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

Definition at line 181 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCRSView	(	const lno_t *&	offsets,
		const zgid_t *&	colIds,
		const scalar_t *&	values
	)		const `[inline, virtual]`

Sets pointers to this process' matrix entries and their values using compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.

Parameters:

offsets	is an array of size numRows + 1. The column Ids for rowIds[i] (returned by getRowIDsView) begin at colIds[offsets[i]]. The last element of offsets is the size of the colIds array.
colIds	on return will point to the global column Ids for the non-zeros for each row.
values	on return will point to the values stored in the non-zeros for each row.

Reimplemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

Definition at line 204 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual int Zoltan2::MatrixAdapter< User, UserCoord >::getNumWeightsPerRow ( ) const [inline, virtual]

Returns the number of weights per row (0 or greater). Row weights may be used when partitioning matrix rows.

Reimplemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

Definition at line 218 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getRowWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx = `0`
	)		const `[inline, virtual]`

Provide a pointer to the row weights, if any.

Parameters:

weights	is the list of weights with a given index for the rows returned in getRowIDsView().
stride	The k'th weight is located at weights[stride*k]
idx	ranges from zero to one less than getNumWeightsPerRow().

Reimplemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

Definition at line 226 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

Indicate whether row weight with index idx should be the global number of nonzeros in the row.

Reimplemented in Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >.

Definition at line 238 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual bool Zoltan2::MatrixAdapter< User, UserCoord >::CCSViewAvailable ( ) const [inline, virtual]

Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.

Definition at line 248 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnIDsView ( const zgid_t *& colIds ) const [inline, virtual]

Sets pointer to this process' columns' global IDs.

Parameters:

colIds will on return a pointer to column global Ids

Definition at line 253 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCCSView	(	const lno_t *&	offsets,
		const zgid_t *&	rowIds
	)		const `[inline, virtual]`

Sets pointers to this process' matrix entries using compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.

Parameters:

offsets	is an array of size numCols + 1. The row Ids for colIds[i] (returned by getColumnIDsView) begin at rowIds[offsets[i]]. The last element of offsets is the size of the rowIds array.
rowIds	on return will point to the global row Ids for the non-zeros for each column.

Definition at line 270 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCCSView	(	const lno_t *&	offsets,
		const zgid_t *&	rowIds,
		const scalar_t *&	values
	)		const `[inline, virtual]`

Sets pointers to this process' matrix entries and their values using compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.

Parameters:

offsets	is an array of size numCols + 1. The row Ids for colIds[i] (returned by getColumnIDsView) begin at rowIds[offsets[i]]. The last element of offsets is the size of the rowIds array.
rowIds	on return will point to the global row Ids for the non-zeros for each column.
values	on return will point to the values stored in the non-zeros for each column.

Definition at line 293 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual int Zoltan2::MatrixAdapter< User, UserCoord >::getNumWeightsPerColumn ( ) const [inline, virtual]

Returns the number of weights per column (0 or greater). Column weights may be used when partitioning matrix columns.

Definition at line 307 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx = `0`
	)		const `[inline, virtual]`

Provide a pointer to the column weights, if any.

Parameters:

weights	is the list of weights with a given index for the columns returned in getColumnIDsView().
stride	The k'th weight is located at weights[stride*k]
idx	ranges from zero to one less than getNumWeightsPerColumn().

Definition at line 315 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

Indicate whether column weight with index idx should be the global number of nonzeros in the column.

Definition at line 327 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

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 345 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

bool Zoltan2::MatrixAdapter< User, UserCoord >::coordinatesAvailable ( ) const [inline]

Indicate whether coordinate information has been set for this MatrixAdapter.

Definition at line 354 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

VectorAdapter<UserCoord>* Zoltan2::MatrixAdapter< User, UserCoord >::getCoordinateInput ( ) const [inline]

Obtain the coordinate data registered by the user.

Returns:: pointer a VectorAdapter with the user's coordinate data.

Definition at line 359 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

enum MatrixEntityType Zoltan2::MatrixAdapter< User, UserCoord >::getPrimaryEntityType ( ) const [inline]

Returns the entity to be partitioned, ordered, colored, etc. Valid values are MATRIX_ROW, MATRIX_COLUMN, MATRIX_NONZERO.

Definition at line 370 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::setPrimaryEntityType ( std::string typestr ) [inline]

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 380 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

size_t Zoltan2::MatrixAdapter< User, UserCoord >::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 401 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::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 415 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

int Zoltan2::MatrixAdapter< User, UserCoord >::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 439 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::getWeightsView	(	const scalar_t *&	wgt,
		int &	stride,
		int	idx = `0`
	)		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 453 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

bool Zoltan2::MatrixAdapter< User, UserCoord >::useDegreeAsWeight ( int idx ) const [inline]

Definition at line 478 of file Zoltan2_MatrixAdapter.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_MatrixAdapter.hpp

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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