Provides access for Zoltan2 to Tpetra::RowMatrix data. More...

#include <Zoltan2_TpetraRowMatrixAdapter.hpp>

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

Collaboration diagram for Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >:

Public Member Functions
	~TpetraRowMatrixAdapter ()
	Destructor. More...

	TpetraRowMatrixAdapter (const RCP< const User > &inmatrix, int nWeightsPerRow=0)
	Constructor More...

void	setWeights (const scalar_t *weightVal, int stride, int idx=0)
	Specify a weight for each entity of the primaryEntityType. More...

void	setRowWeights (const scalar_t *weightVal, int stride, int idx=0)
	Specify a weight for each row. More...

void	setWeightIsDegree (int idx)
	Specify an index for which the weight should be the degree of the entity. More...

void	setRowWeightIsNumberOfNonZeros (int idx)
	Specify an index for which the row weight should be the global number of nonzeros in the row. More...

size_t	getLocalNumRows () const

size_t	getLocalNumColumns () const

size_t	getLocalNumEntries () const

bool	CRSViewAvailable () const

void	getRowIDsView (const gno_t *&rowIds) const
	Sets pointer to this process' rows' global IDs. More...

void	getCRSView (const offset_t &offsets, const gno_t &colIds) const

void	getCRSView (const offset_t &offsets, const gno_t &colIds, const scalar_t *&values) const

int	getNumWeightsPerRow () const

void	getRowWeightsView (const scalar_t *&weights, int &stride, int idx=0) const

bool	useNumNonzerosAsRowWeight (int idx) const
	Indicate whether row weight with index idx should be the global number of nonzeros in the row. More...

template<typename Adapter >
void	applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const

template<typename Adapter >
void	applyPartitioningSolution (const User &in, RCP< User > &out, const PartitioningSolution< Adapter > &solution) const

Public Member Functions inherited from Zoltan2::MatrixAdapter< User, User >
enum BaseAdapterType	adapterType () const
	Returns the type of adapter. More...

	MatrixAdapter ()

virtual	~MatrixAdapter ()
	Destructor. More...

virtual size_t	getLocalNumRows () const=0
	Returns the number of rows on this process. More...

virtual size_t	getLocalNumColumns () const=0
	Returns the number of columns on this process. More...

virtual size_t	getLocalNumEntries () const=0
	Returns the number of nonzeros on this process. More...

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. More...

virtual void	getCRSView (const offset_t &offsets, const gno_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. More...

virtual void	getCRSView (const offset_t &offsets, const gno_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. More...

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

virtual void	getRowWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
	Provide a pointer to the row weights, if any. More...

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. More...

virtual void	getColumnIDsView (const gno_t *&colIds) const
	Sets pointer to this process' columns' global IDs. More...

virtual void	getCCSView (const offset_t &offsets, const gno_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. More...

virtual void	getCCSView (const offset_t &offsets, const gno_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. More...

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

virtual void	getColumnWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
	Provide a pointer to the column weights, if any. More...

virtual bool	useNumNonzerosAsColumnWeight (int idx) const
	Indicate whether column weight with index idx should be the global number of nonzeros in the column. More...

void	setCoordinateInput (VectorAdapter< User > *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. More...

bool	coordinatesAvailable () const
	Indicate whether coordinate information has been set for this MatrixAdapter. More...

VectorAdapter< User > *	getCoordinateInput () const
	Obtain the coordinate data registered by the user. More...

enum MatrixEntityType	getPrimaryEntityType () const
	Returns the entity to be partitioned, ordered, colored, etc. Valid values are MATRIX_ROW, MATRIX_COLUMN, MATRIX_NONZERO. More...

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. 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 *&wgt, int &stride, int idx=0) const

bool	useDegreeAsWeight (int idx) const

Public Member Functions inherited from Zoltan2::BaseAdapter< User >
virtual enum BaseAdapterType	adapterType () const =0
	Returns the type of adapter. More...

virtual	~BaseAdapter ()
	Destructor. More...

virtual void	getIDsKokkosView (Kokkos::View< gno_t * > &ids) const
	Provide a pointer to this process' identifiers. More...

void	getPartsView (const part_t *&inputPart) const
	Provide pointer to a weight array with stride. 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 ()

virtual size_t	getLocalNumIDs () const =0
	Returns the number of objects on this process. More...

virtual 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...

Additional Inherited Members
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

Detailed Description

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

Provides access for Zoltan2 to Tpetra::RowMatrix data.

The scalar_t type, representing user data such as matrix values, is used by Zoltan2 for weights, coordinates, part sizes and quality metrics. Some User types (like Tpetra::RowMatrix) have an inherent scalar type, and some (like Tpetra::RowGraph) 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 76 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

Constructor & Destructor Documentation

◆ ~TpetraRowMatrixAdapter()

template<typename User , typename UserCoord = User>

Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::~TpetraRowMatrixAdapter ( )

inline

Destructor.

Definition at line 92 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ TpetraRowMatrixAdapter()

template<typename User , typename UserCoord >

Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::TpetraRowMatrixAdapter	(	const RCP< const User > &	inmatrix,
		int	nWeightsPerRow = `0`
	)

Constructor

Parameters

inmatrix	The user's Tpetra RowMatrix object
nWeightsPerRow	If row weights will be provided in setRowWeights(), the set `nWeightsPerRow` to the number of weights per row.

Definition at line 238 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

Member Function Documentation

◆ setWeights()

template<typename User , typename UserCoord >

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::setWeights	(	const scalar_t *	weightVal,
		int	stride,
		int	idx = `0`
	)

Specify a weight for each entity of the primaryEntityType.

Parameters

weightVal	A pointer to the weights for this index. \stride A stride to be used in reading the values. The index `idx` weight for entity \k should be found at `weightVal[k*stride]`.
idx	A value between zero and one less that the `nWeightsPerRow` argument to the constructor.

The order of weights should correspond to the order of the primary entity type; see, e.g., setRowWeights below.

Definition at line 283 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ setRowWeights()

template<typename User , typename UserCoord >

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::setRowWeights	(	const scalar_t *	weightVal,
		int	stride,
		int	idx = `0`
	)

Specify a weight for each row.

Parameters

weightVal	A pointer to the weights for this index. \stride A stride to be used in reading the values. The index `idx` weight for row \k should be found at `weightVal[k*stride]`.
idx	A value between zero and one less that the `nWeightsPerRow` argument to the constructor.

The order of weights should correspond to the order of rows returned by

theMatrix->getRowMap()->getNodeElementList();

Definition at line 301 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ setWeightIsDegree()

template<typename User , typename UserCoord >

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::setWeightIsDegree ( int idx )

Specify an index for which the weight should be the degree of the entity.

Parameters

idx	Zoltan2 will use the entity's degree as the entity weight for index `idx`.

Definition at line 320 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ setRowWeightIsNumberOfNonZeros()

template<typename User , typename UserCoord >

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::setRowWeightIsNumberOfNonZeros ( int idx )

Specify an index for which the row weight should be the global number of nonzeros in the row.

Parameters

idx	Zoltan2 will use the global number of nonzeros in a row as the row weight for index `idx`.

Definition at line 337 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ getLocalNumRows()

template<typename User , typename UserCoord = User>

size_t Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::getLocalNumRows ( ) const

inline

Definition at line 151 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ getLocalNumColumns()

template<typename User , typename UserCoord = User>

size_t Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::getLocalNumColumns ( ) const

inline

Definition at line 155 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ getLocalNumEntries()

template<typename User , typename UserCoord = User>

size_t Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::getLocalNumEntries ( ) const

inline

Definition at line 159 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ CRSViewAvailable()

template<typename User , typename UserCoord = User>

bool Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::CRSViewAvailable ( ) const

inline

Definition at line 163 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ getRowIDsView()

template<typename User , typename UserCoord = User>

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::getRowIDsView ( const gno_t *& rowIds ) const

inlinevirtual

Sets pointer to this process' rows' global IDs.

Parameters

rowIds will on return a pointer to row global Ids

Reimplemented from Zoltan2::MatrixAdapter< User, User >.

Definition at line 165 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ getCRSView() [1/2]

template<typename User , typename UserCoord = User>

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::getCRSView	(	const offset_t *&	offsets,
		const gno_t *&	colIds
	)		const

inline

Definition at line 171 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ getCRSView() [2/2]

template<typename User , typename UserCoord = User>

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::getCRSView	(	const offset_t *&	offsets,
		const gno_t *&	colIds,
		const scalar_t *&	values
	)		const

inline

Definition at line 177 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ getNumWeightsPerRow()

template<typename User , typename UserCoord = User>

int Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::getNumWeightsPerRow ( ) const

inline

Definition at line 186 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ getRowWeightsView()

template<typename User , typename UserCoord = User>

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::getRowWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx = `0`
	)		const

inline

Definition at line 188 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ useNumNonzerosAsRowWeight()

template<typename User , typename UserCoord = User>

bool Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::useNumNonzerosAsRowWeight ( int idx ) const

inlinevirtual

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

Reimplemented from Zoltan2::MatrixAdapter< User, User >.

Definition at line 204 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ applyPartitioningSolution() [1/2]

template<typename User , typename UserCoord >

template<typename Adapter >

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::applyPartitioningSolution	(	const User &	in,
		User *&	out,
		const PartitioningSolution< Adapter > &	solution
	)		const

Definition at line 355 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

◆ applyPartitioningSolution() [2/2]

template<typename User , typename UserCoord >

template<typename Adapter >

void Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >::applyPartitioningSolution	(	const User &	in,
		RCP< User > &	out,
		const PartitioningSolution< Adapter > &	solution
	)		const

Definition at line 378 of file Zoltan2_TpetraRowMatrixAdapter.hpp.

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

Zoltan2_TpetraRowMatrixAdapter.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ ~TpetraRowMatrixAdapter()

◆ TpetraRowMatrixAdapter()

Member Function Documentation

◆ setWeights()

◆ setRowWeights()

◆ setWeightIsDegree()

◆ setRowWeightIsNumberOfNonZeros()

◆ getLocalNumRows()

◆ getLocalNumColumns()

◆ getLocalNumEntries()

◆ CRSViewAvailable()

◆ getRowIDsView()

◆ getCRSView() [1/2]

◆ getCRSView() [2/2]

◆ getNumWeightsPerRow()

◆ getRowWeightsView()

◆ useNumNonzerosAsRowWeight()

◆ applyPartitioningSolution() [1/2]

◆ applyPartitioningSolution() [2/2]

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