stapl::ndom2D< Index_Type > Struct Template Reference

Two dimensional domain with ovelap information support. More...

Public Member Functions
	ndom2D ()
	Default constructor (empty domain)
	ndom2D (ndom2D const &other)
	Copy constructor.
	ndom2D (ndom2D const *other)
	Copy constructor based on a pointer.
	ndom2D (index_type lower, index_type upper, bool is_cont_dom=false)
	Domain constructor [lower .. upper]. More...
size_type	size () const
	Return how many element the domain is indexing.
gid_type	first () const
	Returns the first index (gid) in the domain.
gid_type	last () const
	Returns the last index (gid) in the domain.
bool	contains (index_type idx) const
	Returns whether the specified index is in the domain.
bool	empty () const
	Return whether the domain is empty.
index_type	advance (index_type idx, long n) const
	Return an the result of advancing the index provided n positions for the domain ordering provided at instantiation.
size_t	distance (index_type const &i0, index_type const &i1) const
	Return the positive distance between two indices based on the domain order.
bool	is_same_container_domain () const

Public Types
typedef Index_Type	index_type
typedef Index_Type	gid_type
typedef size_t	size_type

Friends
template<typename IT >
std::ostream &	operator<< (std::ostream &os, ndom2D< IT > const &d)

Detailed Description

template<typename Index_Type>
struct stapl::ndom2D< Index_Type >

Two dimensional domain with ovelap information support.

Template Parameters

Index_Type

define the type of the gids in the domain

Constructor & Destructor Documentation

ndom2D()

template<typename Index_Type >

stapl::ndom2D< Index_Type >::ndom2D	(	index_type	lower,
		index_type	upper,
		bool	is_cont_dom = false
	)

Domain constructor [lower .. upper].

Parameters

lower	lower index in the domain
upper	upper index in the domain
left	how many elements are overlap to the left (default: 0)
right	how many elements are overlap to the right (default: 0)

---

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

• domains.hpp