Chombo + EB  3.0
Public Member Functions | Private Attributes | List of all members
Interval Struct Reference

Structure for passing component ranges in code. More...

#include <Interval.H>

Public Member Functions

 Interval ()
 
 Interval (int a_firstComp, int a_lastComp)
 
void define (int a_firstComp, int a_lastComp)
 
int begin () const
 
int end () const
 
int size () const
 
bool contains (int a_val) const
 
bool operator== (const Interval &p) const
 test for equality More...
 

Private Attributes

int m_begin
 
int m_end
 

Detailed Description

Structure for passing component ranges in code.

A class to encapsulate component ranges

Constructor & Destructor Documentation

◆ Interval() [1/2]

Interval::Interval ( )
inline

◆ Interval() [2/2]

Interval::Interval ( int  a_firstComp,
int  a_lastComp 
)
inline

initialize with first and last component numbers

Member Function Documentation

◆ define()

void Interval::define ( int  a_firstComp,
int  a_lastComp 
)
inline

References begin(), end(), m_begin, and m_end.

◆ begin()

int Interval::begin ( ) const
inline

◆ end()

int Interval::end ( ) const
inline

◆ size()

int Interval::size ( ) const
inline

◆ contains()

bool Interval::contains ( int  a_val) const
inline

References m_begin, and m_end.

◆ operator==()

bool Interval::operator== ( const Interval p) const
inline

test for equality

References m_begin, and m_end.

Member Data Documentation

◆ m_begin

int Interval::m_begin
private

Referenced by begin(), contains(), define(), operator==(), and size().

◆ m_end

int Interval::m_end
private

Referenced by contains(), define(), end(), operator==(), and size().


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