Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
IndexSet::Range Struct Reference

Public Member Functions

 Range ()
 
 Range (const types::global_dof_index i1, const types::global_dof_index 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

types::global_dof_index begin
 
types::global_dof_index end
 
types::global_dof_index 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 459 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 624 of file index_set.h.

IndexSet::Range::Range ( const types::global_dof_index  i1,
const types::global_dof_index  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 632 of file index_set.h.

Member Function Documentation

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 1090 of file index_set.h.


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