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 Member Functions
enum BaseAdapterType	adapterType () const override
	Returns the type of adapter. More...

	MatrixAdapter ()

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	getRowIDsView (const gno_t *&rowIds) const
	Sets pointer to this process' rows' global IDs. More...

virtual void	getRowIDsHostView (typename BaseAdapter< User >::ConstIdsHostView &rowIds) const

virtual void	getRowIDsDeviceView (typename BaseAdapter< User >::ConstIdsDeviceView &rowIds) const

virtual void	getCRSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< 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	getCRSHostView (typename BaseAdapter< User >::ConstOffsetsHostView &offsets, typename BaseAdapter< User >::ConstIdsHostView &colIds) const

virtual void	getCRSDeviceView (typename BaseAdapter< User >::ConstOffsetsDeviceView &offsets, typename BaseAdapter< User >::ConstIdsDeviceView &colIds) const

virtual void	getCRSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< const gno_t > &colIds, ArrayRCP< 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 void	getCRSHostView (typename BaseAdapter< User >::ConstOffsetsHostView &offsets, typename BaseAdapter< User >::ConstIdsHostView &colIds, typename BaseAdapter< User >::ConstScalarsHostView &values) const

virtual void	getCRSDeviceView (typename BaseAdapter< User >::ConstOffsetsDeviceView &offsets, typename BaseAdapter< User >::ConstIdsDeviceView &colIds, typename BaseAdapter< User >::ConstScalarsDeviceView &values) const

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 void	getRowWeightsHostView (typename BaseAdapter< User >::WeightsHostView1D &weights, int=0) const

virtual void	getRowWeightsHostView (typename BaseAdapter< User >::WeightsHostView &weights) const

virtual void	getRowWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView1D &weights, int=0) const

virtual void	getRowWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView &weights) const

virtual bool	useNumNonzerosAsRowWeight (int idx) const
	Indicate whether row weight with index idx should be the global number of nonzeros in the row. 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	getColumnIDsHostView (typename BaseAdapter< User >::ConstIdsHostView &colIds) const

virtual void	getColumnIDsDeviceView (typename BaseAdapter< User >::ConstIdsDeviceView &colIds) const

virtual void	getCCSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< 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 (ArrayRCP< const offset_t > &offsets, ArrayRCP< const gno_t > &rowIds, ArrayRCP< 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 void	getColumnWeightsHostView (typename BaseAdapter< User >::WeightsHostView1D &weights, int=0) const

virtual void	getColumnWeightsHostView (typename BaseAdapter< User >::WeightsHostView &weights) const

virtual void	getColumnWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView1D &weights, int=0) const

virtual void	getColumnWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView &weights) const

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< UserCoord > *coordData) override
	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< UserCoord > *	getCoordinateInput () const override
	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 override
	Returns the number of objects on this process. More...

void	getIDsView (const gno_t *&Ids) const override
	Provide a pointer to this process' identifiers. More...

void	getIDsHostView (typename BaseAdapter< User >::ConstIdsHostView &ids) const override

void	getIDsDeviceView (typename BaseAdapter< User >::ConstIdsDeviceView &ids) const override

int	getNumWeightsPerID () const override
	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 override
	Provide pointer to a weight array with stride. More...

void	getWeightsHostView (typename BaseAdapter< User >::WeightsHostView &hostWgts) const override

void	getWeightsHostView (typename BaseAdapter< User >::WeightsHostView1D &hostWgts, int idx=0) const override

void	getWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView &deviceWgts) const override

void	getWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView1D &deviceWgts, int idx=0) const override

bool	useDegreeAsWeight (int idx) const

Public Member Functions inherited from Zoltan2::BaseAdapter< User >
virtual void	getIDsKokkosView (ConstIdsDeviceView &ids) const
	Provide a Kokkos view to this process' identifiers. More...

virtual void	getIDsHostView (ConstIdsHostView &hostIds) const
	Provide a Kokkos view (Host side) to this process' identifiers. More...

virtual void	getIDsDeviceView (ConstIdsDeviceView &deviceIds) const
	Provide a Kokkos view (Device side) to this process' identifiers. More...

virtual void	getWeightsKokkosView (Kokkos::View< scalar_t **, device_t > &wgt) const
	Provide kokkos view of weights. More...

virtual void	getWeightsHostView (WeightsHostView1D &hostWgts, int idx=0) const
	Provide a Kokkos view (Host side) of the weights. More...

virtual void	getWeightsHostView (WeightsHostView &hostWgts) const
	Provide a Kokkos view (Host side) of the weights. More...

virtual void	getWeightsDeviceView (WeightsDeviceView1D &deviceWgts, int idx=0) const
	Provide a Kokkos view (Device side) of the weights. More...

virtual void	getWeightsDeviceView (WeightsDeviceView &deviceWgts) const
	Provide a Kokkos view (Device side) of the weights. More...

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

virtual void	getPartsHostView (Kokkos::View< part_t *, host_t > &inputPart) const

virtual void	getPartsDeviceView (Kokkos::View< part_t *, device_t > &inputPart) const

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 ()=default

Additional Inherited Members
Public Types inherited from Zoltan2::BaseAdapter< User >
using	lno_t = typename InputTraits< User >::lno_t

using	gno_t = typename InputTraits< User >::gno_t

using	scalar_t = typename InputTraits< User >::scalar_t

using	node_t = typename InputTraits< User >::node_t

using	part_t = typename InputTraits< User >::part_t

using	offset_t = typename InputTraits< User >::offset_t

using	host_t = typename Kokkos::HostSpace::memory_space

using	device_t = typename node_t::device_type

using	ConstIdsDeviceView = Kokkos::View< const gno_t *, device_t >

using	ConstIdsHostView = typename ConstIdsDeviceView::HostMirror

using	IdsDeviceView = Kokkos::View< gno_t *, device_t >

using	IdsHostView = typename IdsDeviceView::HostMirror

using	ConstOffsetsDeviceView = Kokkos::View< const offset_t *, device_t >

using	ConstOffsetsHostView = typename ConstOffsetsDeviceView::HostMirror

using	OffsetsDeviceView = Kokkos::View< offset_t *, device_t >

using	OffsetsHostView = typename OffsetsDeviceView::HostMirror

using	ConstScalarsDeviceView = Kokkos::View< const scalar_t *, device_t >

using	ConstScalarsHostView = typename ConstScalarsDeviceView::HostMirror

using	ScalarsDeviceView = Kokkos::View< scalar_t *, device_t >

using	ScalarsHostView = typename ScalarsDeviceView::HostMirror

using	ConstWeightsDeviceView1D = Kokkos::View< const scalar_t *, device_t >

using	ConstWeightsHostView1D = typename ConstWeightsDeviceView1D::HostMirror

using	WeightsDeviceView1D = Kokkos::View< scalar_t *, device_t >

using	WeightsHostView1D = typename WeightsDeviceView1D::HostMirror

using	ConstWeightsDeviceView = Kokkos::View< const scalar_t **, device_t >

using	ConstWeightsHostView = typename ConstWeightsDeviceView::HostMirror

using	WeightsDeviceView = Kokkos::View< scalar_t **, device_t >

using	WeightsHostView = typename WeightsDeviceView::HostMirror

Protected Member Functions inherited from Zoltan2::BaseAdapter< User >
void	generateWeightFileOnly (const char *fileprefix, const Teuchos::Comm< int > &comm) const

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
node_t is a Kokkos Node type

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

Constructor & Destructor Documentation

template<typename User, typename UserCoord = User>

Zoltan2::MatrixAdapter< User, UserCoord >::MatrixAdapter ( )

inline

Definition at line 130 of file Zoltan2_MatrixAdapter.hpp.

Member Function Documentation

template<typename User, typename UserCoord = User>

enum BaseAdapterType Zoltan2::MatrixAdapter< User, UserCoord >::adapterType ( ) const

inlineoverridevirtual

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 127 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::TpetraRowMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraCrsMatrixAdapter< 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::TpetraRowMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraCrsMatrixAdapter< 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::TpetraRowMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >.

template<typename User, typename UserCoord = User>

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

inlinevirtual

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::TpetraRowMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >.

Definition at line 153 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< 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

Definition at line 158 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getRowIDsHostView ( typename BaseAdapter< User >::ConstIdsHostView & rowIds ) const

inlinevirtual

Definition at line 164 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getRowIDsDeviceView ( typename BaseAdapter< User >::ConstIdsDeviceView & rowIds ) const

inlinevirtual

Definition at line 169 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCRSView	(	ArrayRCP< const offset_t > &	offsets,
		ArrayRCP< const gno_t > &	colIds
	)		const

inlinevirtual

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.

Definition at line 185 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCRSHostView	(	typename BaseAdapter< User >::ConstOffsetsHostView &	offsets,
		typename BaseAdapter< User >::ConstIdsHostView &	colIds
	)		const

inlinevirtual

Definition at line 193 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCRSDeviceView	(	typename BaseAdapter< User >::ConstOffsetsDeviceView &	offsets,
		typename BaseAdapter< User >::ConstIdsDeviceView &	colIds
	)		const

inlinevirtual

Definition at line 199 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCRSView	(	ArrayRCP< const offset_t > &	offsets,
		ArrayRCP< const gno_t > &	colIds,
		ArrayRCP< const scalar_t > &	values
	)		const

inlinevirtual

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.

Definition at line 220 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCRSHostView	(	typename BaseAdapter< User >::ConstOffsetsHostView &	offsets,
		typename BaseAdapter< User >::ConstIdsHostView &	colIds,
		typename BaseAdapter< User >::ConstScalarsHostView &	values
	)		const

inlinevirtual

Definition at line 231 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCRSDeviceView	(	typename BaseAdapter< User >::ConstOffsetsDeviceView &	offsets,
		typename BaseAdapter< User >::ConstIdsDeviceView &	colIds,
		typename BaseAdapter< User >::ConstScalarsDeviceView &	values
	)		const

inlinevirtual

Definition at line 238 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

inlinevirtual

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

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

Definition at line 249 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

inlinevirtual

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::TpetraRowMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >.

Definition at line 257 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getRowWeightsHostView	(	typename BaseAdapter< User >::WeightsHostView1D &	weights,
		int	= `0`
	)		const

inlinevirtual

Definition at line 266 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getRowWeightsHostView ( typename BaseAdapter< User >::WeightsHostView & weights ) const

inlinevirtual

Definition at line 271 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getRowWeightsDeviceView	(	typename BaseAdapter< User >::WeightsDeviceView1D &	weights,
		int	= `0`
	)		const

inlinevirtual

Definition at line 275 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getRowWeightsDeviceView ( typename BaseAdapter< User >::WeightsDeviceView & weights ) const

inlinevirtual

Definition at line 280 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual bool Zoltan2::MatrixAdapter< 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 in Zoltan2::TpetraRowMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >.

Definition at line 287 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

inlinevirtual

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

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnIDsView ( const gno_t *& colIds ) const

inlinevirtual

Sets pointer to this process' columns' global IDs.

Parameters

colIds will on return a pointer to column global Ids

Definition at line 302 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnIDsHostView ( typename BaseAdapter< User >::ConstIdsHostView & colIds ) const

inlinevirtual

Definition at line 308 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnIDsDeviceView ( typename BaseAdapter< User >::ConstIdsDeviceView & colIds ) const

inlinevirtual

Definition at line 313 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCCSView	(	ArrayRCP< const offset_t > &	offsets,
		ArrayRCP< const gno_t > &	rowIds
	)		const

inlinevirtual

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

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getCCSView	(	ArrayRCP< const offset_t > &	offsets,
		ArrayRCP< const gno_t > &	rowIds,
		ArrayRCP< const scalar_t > &	values
	)		const

inlinevirtual

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

template<typename User, typename UserCoord = User>

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

inlinevirtual

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

Definition at line 366 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

inlinevirtual

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

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnWeightsHostView	(	typename BaseAdapter< User >::WeightsHostView1D &	weights,
		int	= `0`
	)		const

inlinevirtual

Definition at line 383 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnWeightsHostView ( typename BaseAdapter< User >::WeightsHostView & weights ) const

inlinevirtual

Definition at line 388 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnWeightsDeviceView	(	typename BaseAdapter< User >::WeightsDeviceView1D &	weights,
		int	= `0`
	)		const

inlinevirtual

Definition at line 392 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

virtual void Zoltan2::MatrixAdapter< User, UserCoord >::getColumnWeightsDeviceView ( typename BaseAdapter< User >::WeightsDeviceView & weights ) const

inlinevirtual

Definition at line 397 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

inlinevirtual

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

Definition at line 404 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

inlineoverridevirtual

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.

Implements Zoltan2::AdapterWithCoordsWrapper< User, UserCoord >.

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

template<typename User, typename UserCoord = User>

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

inlineoverridevirtual

Obtain the coordinate data registered by the user.

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

Implements Zoltan2::AdapterWithCoordsWrapper< User, UserCoord >.

Definition at line 436 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 447 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 457 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

size_t Zoltan2::MatrixAdapter< User, UserCoord >::getLocalNumIDs ( ) const

inlineoverridevirtual

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

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::getIDsView ( const gno_t *& ids ) const

inlineoverridevirtual

Provide a pointer to this process' identifiers.

Deprecated:: Use getIDsHostView instead.

Parameters

ids	will on return point to the list of the global Ids for this process.

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 492 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::getIDsHostView ( typename BaseAdapter< User >::ConstIdsHostView & ids ) const

inlineoverride

Definition at line 515 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::getIDsDeviceView ( typename BaseAdapter< User >::ConstIdsDeviceView & ids ) const

inlineoverride

Definition at line 537 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

int Zoltan2::MatrixAdapter< User, UserCoord >::getNumWeightsPerID ( ) const

inlineoverridevirtual

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 559 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

inlineoverridevirtual

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 This function or getWeightsKokkosView 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 573 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::getWeightsHostView ( typename BaseAdapter< User >::WeightsHostView & hostWgts ) const

inlineoverride

Definition at line 598 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::getWeightsHostView	(	typename BaseAdapter< User >::WeightsHostView1D &	hostWgts,
		int	idx = `0`
	)		const

inlineoverride

Definition at line 620 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::getWeightsDeviceView ( typename BaseAdapter< User >::WeightsDeviceView & deviceWgts ) const

inlineoverride

Definition at line 643 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::MatrixAdapter< User, UserCoord >::getWeightsDeviceView	(	typename BaseAdapter< User >::WeightsDeviceView1D &	deviceWgts,
		int	idx = `0`
	)		const

inlineoverride

Definition at line 665 of file Zoltan2_MatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

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

inline

Definition at line 688 of file Zoltan2_MatrixAdapter.hpp.

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

Zoltan2_MatrixAdapter.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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