Public Member Functions | Static Public Member Functions | Public Attributes | Friends

IndexSet::Range Struct Reference

List of all members.

Public Member Functions

 Range ()
 Range (const unsigned int i1, const unsigned int i2)
std::size_t memory_consumption () const
template<class Archive >
void serialize (Archive &ar, const unsigned int version)

Static Public Member Functions

static bool end_compare (const IndexSet::Range &x, const IndexSet::Range &y)
static bool nth_index_compare (const IndexSet::Range &x, const IndexSet::Range &y)

Public Attributes

unsigned int begin
unsigned int end
unsigned int nth_index_in_set

Friends

bool operator< (const Range &range_1, const Range &range_2)
bool operator== (const Range &range_1, const Range &range_2)

Detailed Description

A type that denotes the half open index range [begin,end).

The nth_index_in_set denotes the how many-th index within this IndexSet the first element of the current range is. This information is only accurate if IndexSet::compress() has been called after the last insertion.

Definition at line 396 of file index_set.h.


Constructor & Destructor Documentation

IndexSet::Range::Range (  ) [inline]

Default constructor. Since there is no useful choice for a default constructed interval, this constructor simply creates something that resembles an invalid range. We need this constructor for serialization purposes, but the invalid range should be filled with something read from the archive before it is used, so we should hopefully never get to see an invalid range in the wild.

Definition at line 535 of file index_set.h.

Referenced by memory_consumption().

IndexSet::Range::Range ( const unsigned int  i1,
const unsigned int  i2 
) [inline]

Constructor. Create a half-open interval with the given indices.

Parameters:
i1Left end point of the interval.
i2First index greater than the last index of the indicated range.

Definition at line 543 of file index_set.h.


Member Function Documentation

static bool IndexSet::Range::end_compare ( const IndexSet::Range x,
const IndexSet::Range y 
) [inline, static]

Definition at line 434 of file index_set.h.

References end.

Referenced by IndexSet::index_within_set().

static bool IndexSet::Range::nth_index_compare ( const IndexSet::Range x,
const IndexSet::Range y 
) [inline, static]

Definition at line 439 of file index_set.h.

References begin, end, and nth_index_in_set.

Referenced by IndexSet::nth_index_in_set().

std::size_t IndexSet::Range::memory_consumption (  ) const [inline]

Definition at line 455 of file index_set.h.

References Range().

template<class Archive >
void IndexSet::Range::serialize ( Archive &  ar,
const unsigned int  version 
) [inline]

Write or read the data of this object to or from a stream for the purpose of serialization

Definition at line 965 of file index_set.h.

References begin, end, and nth_index_in_set.


Friends And Related Function Documentation

bool operator< ( const Range range_1,
const Range range_2 
) [friend]

Definition at line 424 of file index_set.h.

bool operator== ( const Range range_1,
const Range range_2 
) [friend]

Definition at line 447 of file index_set.h.


Member Data Documentation

Definition at line 398 of file index_set.h.

Referenced by IndexSet::n_elements(), nth_index_compare(), and serialize().

Definition at line 399 of file index_set.h.

Referenced by end_compare(), IndexSet::n_elements(), nth_index_compare(), and serialize().


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:09 by doxygen 1.7.2