Reference documentation for deal.II version Git 08727cc441 2020-07-02 15:45:42 -0400
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
IndexSet::Range Struct Reference

Public Member Functions

 Range ()
 
 Range (const size_type i1, const size_type i2)
 
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)
 
static std::size_t memory_consumption ()
 

Public Attributes

size_type begin
 
size_type end
 
size_type 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 874 of file index_set.h.

Constructor & Destructor Documentation

◆ Range() [1/2]

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

◆ Range() [2/2]

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

Member Function Documentation

◆ end_compare()

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

Definition at line 909 of file index_set.h.

◆ nth_index_compare()

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

Definition at line 915 of file index_set.h.

◆ memory_consumption()

static std::size_t IndexSet::Range::memory_consumption ( )
inlinestatic

Definition at line 928 of file index_set.h.

◆ serialize()

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

Friends And Related Function Documentation

◆ operator<

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

Definition at line 901 of file index_set.h.

◆ operator==

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

Definition at line 922 of file index_set.h.

Member Data Documentation

◆ begin

size_type IndexSet::Range::begin

Definition at line 876 of file index_set.h.

◆ end

size_type IndexSet::Range::end

Definition at line 877 of file index_set.h.

◆ nth_index_in_set

size_type IndexSet::Range::nth_index_in_set

Definition at line 879 of file index_set.h.


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