BasicVectorAdapter represents a vector (plus optional weights) supplied by the user as pointers to strided arrays. More...

#include <Zoltan2_BasicVectorAdapter.hpp>

Inheritance diagram for Zoltan2::BasicVectorAdapter< User >:

[legend]

Collaboration diagram for Zoltan2::BasicVectorAdapter< User >:

[legend]

Public Member Functions
	BasicVectorAdapter (lno_t numIds, const gno_t ids, const scalar_t entries, int entryStride=1, bool usewgts=false, const scalar_t *wgts=NULL, int wgtStride=1)
	Constructor for one vector with (optionally) one weight. More...

	BasicVectorAdapter (lno_t numIds, const gno_t ids, std::vector< const scalar_t > &entries, std::vector< int > &entryStride, std::vector< const scalar_t * > &weights, std::vector< int > &weightStrides)
	Constructor for multivector (a set of vectors sharing the same global numbering and data distribution across processes). More...

	BasicVectorAdapter (lno_t numIds, const gno_t ids, const scalar_t x, const scalar_t y, const scalar_t z, int xStride=1, int yStride=1, int zStride=1, bool usewgts=false, const scalar_t *wgts=NULL, int wgtStride=1)
	A simple constructor for coordinate-based problems with dimension 1, 2 or 3 and (optionally) one weight per coordinate. 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...

void	getIDsKokkosView (typename Base::ConstIdsDeviceView &ids) const

void	getIDsHostView (typename Base::ConstIdsHostView &ids) const override

void	getIDsDeviceView (typename Base::ConstIdsDeviceView &ids) const override

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

virtual void	getWeightsKokkos2dView (typename Base::WeightsDeviceView &wgt) const

void	getWeightsView (const scalar_t *&weights, int &stride, int idx) const
	Provide pointer to a weight array with stride. More...

void	getWeightsHostView (typename Base::WeightsHostView1D &hostWgts, int idx=0) const override

void	getWeightsHostView (typename Base::WeightsHostView &wgts) const override

void	getWeightsDeviceView (typename Base::WeightsDeviceView1D &deviceWgts, int idx=0) const override

void	getWeightsDeviceView (typename Base::WeightsDeviceView &wgts) const override

int	getNumEntriesPerID () const
	Return the number of vectors. More...

void	getEntriesView (const scalar_t *&entries, int &stride, int idx=0) const
	Provide a pointer to the elements of the specified vector. More...

void	getEntriesKokkosView (typename AdapterWithCoords< User >::CoordsDeviceView &entries) const

void	getEntriesHostView (typename AdapterWithCoords< User >::CoordsHostView &entries) const override
	Provide a Kokkos view (Host side) to the elements of the specified vector. More...

void	getEntriesDeviceView (typename AdapterWithCoords< User >::CoordsDeviceView &entries) const override
	Provide a Kokkos view (Device side) to the elements of the specified vector. More...

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

virtual void	getEntriesKokkosView (Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > &elements) const
	Provide a Kokkos view to the elements of the specified vector. More...

void	generateFiles (const char *fileprefix, const Teuchos::Comm< int > &comm) const
	Write files that can be used as input to Zoltan or Zoltan2 driver Creates chaco-formatted input files for coordinates and weights that can be used as input for Zoltan or Zoltan2 drivers. This routine is SERIAL and can be quite slow. It is meant as a debugging tool only, to allow Zoltan developers to replicate performance that applications are seeing using the applicatios' input. More...

int	getDimension () const

void	getCoordinatesView (const scalar_t *&elements, int &stride, int idx=0) const override

void	getCoordinatesKokkosView (typename AdapterWithCoords< User >::CoordsDeviceView &elements) const override

void	getCoordinatesHostView (typename AdapterWithCoords< User >::CoordsHostView &elements) const override

void	getCoordinatesDeviceView (typename AdapterWithCoords< User >::CoordsDeviceView &elements) const override

Public Member Functions inherited from Zoltan2::AdapterWithCoords< User >
virtual void	getCoordinatesKokkosView (CoordsDeviceView &elements) const =0

virtual void	getCoordinatesHostView (CoordsHostView &) const

virtual void	getCoordinatesDeviceView (CoordsDeviceView &elements) 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::AdapterWithCoords< User >
using	scalar_t = typename BaseAdapter< User >::scalar_t

using	device_t = typename BaseAdapter< User >::node_t::device_type

using	host_t = typename Kokkos::HostSpace::memory_space

using	CoordsDeviceView = Kokkos::View< scalar_t **, Kokkos::LayoutLeft, device_t >

using	CoordsHostView = typename CoordsDeviceView::HostMirror

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>
class Zoltan2::BasicVectorAdapter< User >

BasicVectorAdapter represents a vector (plus optional weights) supplied by the user as pointers to strided arrays.

BasicVectorAdapter may be a single vector or multivector (set of corresponding vectors with the same global identifiers and distribution across processes). A constructor specifically for use of BasicVectorAdapter to represent geometric coordinates is also provided.

Data types:

scalar_t is the data type for weights and vector entry values.
lno_t is the integral data type used by Zoltan2 for local indices and local counts.
gno_t is the data type used by the application for global Ids; must be a Teuchos Ordinal. (Teuchos Ordinals are those data types for which traits are defined in Trilinos/packages/teuchos/src/Teuchos_OrdinalTraits.hpp.)
node_t is a Kokkos CPU Node type. If you don't use Kokkos, you can ignore this data type.

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 a vector, or it may be the empty helper class BasicUserTypes with which a Zoltan2 user can easily supply the data types for the library.

Examples:: rcb_C.cpp.

Definition at line 86 of file Zoltan2_BasicVectorAdapter.hpp.

Constructor & Destructor Documentation

template<typename User>

Zoltan2::BasicVectorAdapter< User >::BasicVectorAdapter	(	lno_t	numIds,
		const gno_t *	ids,
		const scalar_t *	entries,
		int	entryStride = `1`,
		bool	usewgts = `false`,
		const scalar_t *	wgts = `NULL`,
		int	wgtStride = `1`
	)

inline

Constructor for one vector with (optionally) one weight.

Parameters

numIds	the local length of the vector
ids	pointer to the global ids of the local vector entries
entries	pointer to the entries corresponding to the ids
entryStride	the k'th entry is at entries[kentryStride] and entries is of length at least `numIds entryStride`.
usewgts	flag indicating whether weights are provided on any process
wgts	the number of weights per vector entry
wgtStride	the weight for the k'th entry is at wgts[kwgtStride] and wgts is of length at least `numIds wgtStride`. The values pointed to the arguments must remain valid for the lifetime of this Adapter.

Definition at line 117 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

Zoltan2::BasicVectorAdapter< User >::BasicVectorAdapter	(	lno_t	numIds,
		const gno_t *	ids,
		std::vector< const scalar_t * > &	entries,
		std::vector< int > &	entryStride,
		std::vector< const scalar_t * > &	weights,
		std::vector< int > &	weightStrides
	)

inline

Constructor for multivector (a set of vectors sharing the same global numbering and data distribution across processes).

Parameters

numIds	the local length of each vector
ids	a pointer to the global ids of the local vector entries
entries	a std::vector of pointers to the vector entries corresponding to the `numIds` ids. The number of vectors assumed to be `entries.size()`.
entryStride	The strides for `entries`. The vector entry for vector `n` for `ids`[k] should be found at `entries[n][entryStride[n] * k]`. If `entryStride.size()` is zero, it is assumed all strides are one.
weights	a list of pointers to arrays of weights. The number of weights per vector entry 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 162 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

Zoltan2::BasicVectorAdapter< User >::BasicVectorAdapter	(	lno_t	numIds,
		const gno_t *	ids,
		const scalar_t *	x,
		const scalar_t *	y,
		const scalar_t *	z,
		int	xStride = `1`,
		int	yStride = `1`,
		int	zStride = `1`,
		bool	usewgts = `false`,
		const scalar_t *	wgts = `NULL`,
		int	wgtStride = `1`
	)

inline

A simple constructor for coordinate-based problems with dimension 1, 2 or 3 and (optionally) one weight per coordinate.

Parameters

numIds	The number of local coordinates.
ids	The global identifiers for the coordinates.
x	A pointer to the x-dimension coordinates.
y	A pointer to the y-dimension coordinates, if any.
z	A pointer to the z-dimension coordinates, if any.
xStride	The stride for the `x` array. The coordinate for point `ids`[n] should be found at `x[xStride * n]`. Default = 1.
yStride	The stride for the `y` array. The coordinate for point `ids`[n] should be found at `y[yStride * n]`. Default = 1.
zStride	The stride for the `z` array. The coordinate for point `ids`[n] should be found at `z[zStride * n]`. Default = 1.
usewgts	flag indicating whether weights are provided on any process.
wgts	the number of weights per vector entry
wgtStride	the weight for the k'th coordinate is at wgts[kwgtStride] and wgts is of length at least `numIds wgtStride`.

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

Definition at line 198 of file Zoltan2_BasicVectorAdapter.hpp.

Member Function Documentation

template<typename User>

size_t Zoltan2::BasicVectorAdapter< User >::getLocalNumIDs ( ) const

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 233 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getIDsView ( const gno_t *& ids ) const

inlinevirtual

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 235 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getIDsKokkosView ( typename Base::ConstIdsDeviceView & ids ) const

inline

Definition at line 237 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getIDsHostView ( typename Base::ConstIdsHostView & ids ) const

inlineoverride

Definition at line 241 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getIDsDeviceView ( typename Base::ConstIdsDeviceView & ids ) const

inlineoverride

Definition at line 247 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

int Zoltan2::BasicVectorAdapter< User >::getNumWeightsPerID ( ) const

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 251 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

virtual void Zoltan2::BasicVectorAdapter< User >::getWeightsKokkos2dView ( typename Base::WeightsDeviceView & wgt ) const

inlinevirtual

Definition at line 254 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getWeightsView	(	const scalar_t *&	wgt,
		int &	stride,
		int	idx
	)		const

inlinevirtual

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 258 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

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

inlineoverride

Definition at line 266 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getWeightsHostView ( typename Base::WeightsHostView & wgts ) const

inlineoverride

Definition at line 279 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

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

inlineoverride

Definition at line 285 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getWeightsDeviceView ( typename Base::WeightsDeviceView & wgts ) const

inlineoverride

Definition at line 302 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

int Zoltan2::BasicVectorAdapter< User >::getNumEntriesPerID ( ) const

inlinevirtual

Return the number of vectors.

Implements Zoltan2::VectorAdapter< User >.

Definition at line 310 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getEntriesView	(	const scalar_t *&	elements,
		int &	stride,
		int	idx = `0`
	)		const

inlinevirtual

Provide a pointer to the elements of the specified vector.

Parameters

elements	will on return point to the vector values corresponding to the global Ids.
stride	the k'th element is located at elements[stride*k]
idx	ranges from zero to one less than getNumEntriesPerID(), and represents the vector for which data is being requested.

Reimplemented from Zoltan2::VectorAdapter< User >.

Definition at line 312 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getEntriesKokkosView ( typename AdapterWithCoords< User >::CoordsDeviceView & entries ) const

inline

Definition at line 324 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getEntriesHostView ( typename AdapterWithCoords< User >::CoordsHostView & elements ) const

inlineoverridevirtual

Provide a Kokkos view (Host side) to the elements of the specified vector.

Parameters

elements will on return point to the vector values corresponding to the global Ids.

Reimplemented from Zoltan2::VectorAdapter< User >.

Definition at line 329 of file Zoltan2_BasicVectorAdapter.hpp.

template<typename User>

void Zoltan2::BasicVectorAdapter< User >::getEntriesDeviceView ( typename AdapterWithCoords< User >::CoordsDeviceView & elements ) const

inlineoverridevirtual

Provide a Kokkos view (Device side) to the elements of the specified vector.

Parameters

elements will on return point to the vector values corresponding to the global Ids.

Reimplemented from Zoltan2::VectorAdapter< User >.

Definition at line 336 of file Zoltan2_BasicVectorAdapter.hpp.

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

Zoltan2_BasicVectorAdapter.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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