segment_id_range_t< SegmentInfoT > Struct Template Reference

Defines a range of segment IDs which represents segments in which an element is included, use result_of::segment_id_range for defining this type. More...

#include <segmentation.hpp>

Public Types
typedef SegmentInfoT::const_iterator	const_iterator
	An iterator for iterating over all segment IDs.
typedef SegmentInfoT::const_iterator	iterator
	An iterator for iterating over all segment IDs.
Public Member Functions
iterator	begin ()
	Returns an iterator pointing to the first segment ID.
const_iterator	begin () const
	Returns a const iterator pointing to the first segment ID, const version.
const_iterator	cbegin ()
	Returns a const iterator pointing to the first segment ID.
const_iterator	cend ()
	Returns a const iterator pointing to the end of the segment IDs.
bool	empty () const
	Returns if the segment id container is empty.
iterator	end ()
	Returns an iterator pointing to the end of the segment IDs.
const_iterator	end () const
	Returns a const iterator pointing to the end of the segment IDs, const version.
std::size_t	is_equal (segment_id_range_t< SegmentInfoT > const &other) const
	Checks, if two segment id ranges are equal.
	segment_id_range_t (SegmentInfoT &segment_info)
std::size_t	size () const
	Returns the number of segment ids.

---

Detailed Description

template<typename SegmentInfoT>
struct viennagrid::segment_id_range_t< SegmentInfoT >

Defines a range of segment IDs which represents segments in which an element is included, use result_of::segment_id_range for defining this type.

Template Parameters:

SegmentInfoT

For internal use only

---

Member Typedef Documentation

typedef SegmentInfoT::const_iterator const_iterator

An iterator for iterating over all segment IDs.

typedef SegmentInfoT::const_iterator iterator

An iterator for iterating over all segment IDs.

---

Constructor & Destructor Documentation

segment_id_range_t

(

SegmentInfoT &

segment_info

)

[inline]

---

Member Function Documentation

iterator begin

(

)

[inline]

Returns an iterator pointing to the first segment ID.

Returns:

An iterator pointing to the first segment ID

const_iterator begin

(

)

const [inline]

Returns a const iterator pointing to the first segment ID, const version.

Returns:

A const iterator pointing to the first segment ID

const_iterator cbegin

(

)

[inline]

Returns a const iterator pointing to the first segment ID.

Returns:

A const iterator pointing to the first segment ID

const_iterator cend

(

)

[inline]

Returns a const iterator pointing to the end of the segment IDs.

Returns:

A const iterator pointing to the end of the segment IDs

bool empty

(

)

const [inline]

Returns if the segment id container is empty.

Returns:

true if the segment id container is empty, false otherwise

iterator end

(

)

[inline]

Returns an iterator pointing to the end of the segment IDs.

Returns:

An iterator pointing to the end of the segment IDs

const_iterator end

(

)

const [inline]

Returns a const iterator pointing to the end of the segment IDs, const version.

Returns:

A const iterator pointing to the end of the segment IDs

std::size_t is_equal

(

segment_id_range_t< SegmentInfoT > const &

other

)

const [inline]

Checks, if two segment id ranges are equal.

Parameters:

other

The other segment id range

Returns:

true if the segment id ranges are equal, false otherwise

std::size_t size

(

)

const [inline]

Returns the number of segment ids.

Returns:

The number of segment ids

---

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

• viennagrid/mesh/segmentation.hpp