Teuchos::Range1D Class Reference

Subregion Index Range Class. More...

#include <Teuchos_Range1D.hpp>

List of all members.

Public Types

typedef Teuchos_Index Index

enum EInvalidRange

More...

Public Member Functions

Range1D ()

Constructs a range representing the entire range.

Range1D (EInvalidRange)

Range1D (Index lbound, Index ubound)

Constructs a range that represents the range [lbound, ubound].

bool full_range () const

Index lbound () const

Return lower bound of the range.

Index ubound () const

Return upper bound of the range.

Index size () const

Return the size of the range (ubound() - lbound() + 1).

bool in_range (Index i) const

Return true if the index is in range.

Range1D & operator+= (Index incr)

Increment the range by a constant.

Range1D & operator-= (Index incr)

Deincrement the range by a constant.

Static Public Attributes

const Range1D Invalid

Used for Range1D(INVALID).

Related Functions

(Note that these are not member functions.)

bool operator== (const Range1D &rng1, const Range1D &rng2)

rng1 == rng2.

Range1D operator+ (const Range1D &rng_rhs, Range1D::Index i)

rng_lhs = rng_rhs + i.

Range1D operator+ (Range1D::Index i, const Range1D &rng_rhs)

rng_lhs = i + rng_rhs.

Range1D operator- (const Range1D &rng_rhs, Range1D::Index i)

rng_lhs = rng_rhs - i.

Range1D full_range (const Range1D &rng, Range1D::Index lbound, Range1D::Index ubound)

Return a bounded index range from a potentially unbounded index range.

Detailed Description

Subregion Index Range Class.

The class Range1D abstracts a 1-D, zero-based, range of indexes. It is used to index into vectors and matrices and return subregions of them respectively.

Constructing using Range1D() yields a range that represents the entire dimension of an object [0, max_ubound-1] (an entire vector, all the rows in a matrix, or all the columns in a matrix etc.).

Constructing using Range1D(INVALID) yields an invalid range [0,-1] with size() == 0. In fact the condition size()==0 is the determining flag that a range is not valid. Once constructed with Range1D(INVALID), a Range1D object can pass through many other operations that may change lbound() and ubound() but will never change size()==0.

Constructing using Range1D(lbound,ubound) yields a finite-dimensional zero-based range. The validity of constructed range will only be checked if TEUCHOS_DEBUG is defined.

There are many non-member functions that can be used with Range1D objects.

The default copy constructor and assignment operator functions are allowed since they have the correct semantics.

Definition at line 74 of file Teuchos_Range1D.hpp.

Member Typedef Documentation

typedef Teuchos_Index Teuchos::Range1D::Index

Definition at line 78 of file Teuchos_Range1D.hpp.

Member Enumeration Documentation

enum Teuchos::Range1D::EInvalidRange

Definition at line 81 of file Teuchos_Range1D.hpp.

Constructor & Destructor Documentation

Teuchos::Range1D::Range1D ( ) [inline]

Constructs a range representing the entire range.
Postconditions:

this->full_range()==true

this->size() is a very large number

this->lbound()==0

this->ubound() is a very large number

Definition at line 238 of file Teuchos_Range1D.hpp.

Teuchos::Range1D::Range1D ( EInvalidRange ) [inline]

Constructs an invalid (zero) range.
Postconditions:

this->full_range() == false

this->size() == 0

this->lbound()==0

this->ubound()==-1

Definition at line 243 of file Teuchos_Range1D.hpp.

Teuchos::Range1D::Range1D ( Index lbound,

Index ubound

) [inline]

Constructs a range that represents the range [lbound, ubound].
Preconditions:

lbound >= 0 (throw range_error)

lbound <= ubound (throw range_error)

Postconditions:

this->full_range() == false

this->size() == ubound - lbound + 1

this->lbound() == lbound

this->ubound() == ubound

Definition at line 249 of file Teuchos_Range1D.hpp.

Member Function Documentation

bool Teuchos::Range1D::full_range ( ) const [inline]

Returns true if the range represents the entire region (constructed from Range1D())
Definition at line 256 of file Teuchos_Range1D.hpp.

Range1D::Index Teuchos::Range1D::lbound ( ) const [inline]

Return lower bound of the range.

Definition at line 261 of file Teuchos_Range1D.hpp.

Range1D::Index Teuchos::Range1D::ubound ( ) const [inline]

Return upper bound of the range.

Definition at line 266 of file Teuchos_Range1D.hpp.

Range1D::Index Teuchos::Range1D::size ( ) const [inline]

Return the size of the range (ubound() - lbound() + 1).

Definition at line 271 of file Teuchos_Range1D.hpp.

bool Teuchos::Range1D::in_range ( Index i ) const [inline]

Return true if the index is in range.

Definition at line 276 of file Teuchos_Range1D.hpp.

Range1D & Teuchos::Range1D::operator+= ( Index incr ) [inline]

Increment the range by a constant.

Definition at line 281 of file Teuchos_Range1D.hpp.

Range1D & Teuchos::Range1D::operator-= ( Index incr ) [inline]

Deincrement the range by a constant.

Definition at line 289 of file Teuchos_Range1D.hpp.

Friends And Related Function Documentation

bool operator== ( const Range1D & rng1,

const Range1D & rng2

) [related]

rng1 == rng2.

Returns:
Returns rng1.lbound() == rng2.ubound() && rng1.ubound() == rng2.ubound().

Definition at line 163 of file Teuchos_Range1D.hpp.

Range1D operator+ ( const Range1D & rng_rhs,

Range1D::Index i

) [related]

rng_lhs = rng_rhs + i.
Increments the upper and lower bounds by a constant.
Postcondition:

rng_lhs.lbound() == rng_rhs.lbound() + i

rng_lhs.ubound() == rng_rhs.ubound() + i

Definition at line 179 of file Teuchos_Range1D.hpp.

Range1D operator+ ( Range1D::Index i,

const Range1D & rng_rhs

) [related]

rng_lhs = i + rng_rhs.
Increments the upper and lower bounds by a constant.
Postcondition:

rng_lhs.lbound() == i + rng_rhs.lbound()

rng_lhs.ubound() == i + rng_rhs.ubound()

Definition at line 195 of file Teuchos_Range1D.hpp.

Range1D operator- ( const Range1D & rng_rhs,

Range1D::Index i

) [related]

rng_lhs = rng_rhs - i.
Deincrements the upper and lower bounds by a constant.
Postcondition:

rng_lhs.lbound() == rng_rhs.lbound() - i

rng_lhs.ubound() == rng_rhs.ubound() - i

Definition at line 211 of file Teuchos_Range1D.hpp.

Range1D full_range ( const Range1D & rng,

Range1D::Index lbound,

Range1D::Index ubound

) [related]

Return a bounded index range from a potentially unbounded index range.
Return a index range of lbound to ubound if rng.full_range() == true , otherwise just return a copy of rng.
Postconditions:

[rng.full_range() == true] return.lbound() == lbound

[rng.full_range() == true] return.ubound() == ubound

[rng.full_range() == false] return.lbound() == rng.lbound()

[rng.full_range() == false] return.ubound() == rng.ubound()

Definition at line 231 of file Teuchos_Range1D.hpp.

Member Data Documentation

const Range1D Teuchos::Range1D::Invalid [static]

Used for Range1D(INVALID).

The documentation for this class was generated from the following files:

Generated on Thu Sep 18 12:30:32 2008 for Teuchos - Trilinos Tools Package by

1.3.9.1


Public Types
typedef Teuchos_Index	Index

enum	EInvalidRange
	More...
Public Member Functions
	Range1D ()
	Constructs a range representing the entire range.
	Range1D (EInvalidRange)
	Range1D (Index lbound, Index ubound)
	Constructs a range that represents the range `[lbound, ubound]`.
bool	full_range () const
Index	lbound () const
	Return lower bound of the range.
Index	ubound () const
	Return upper bound of the range.
Index	size () const
	Return the size of the range (`ubound() - lbound() + 1`).
bool	in_range (Index i) const
	Return true if the index is in range.
Range1D &	operator+= (Index incr)
	Increment the range by a constant.
Range1D &	operator-= (Index incr)
	Deincrement the range by a constant.
Static Public Attributes
const Range1D	Invalid
	Used for Range1D(INVALID).
Related Functions
(Note that these are not member functions.)
bool	operator== (const Range1D &rng1, const Range1D &rng2)
	rng1 == rng2.
Range1D	operator+ (const Range1D &rng_rhs, Range1D::Index i)
	rng_lhs = rng_rhs + i.
Range1D	operator+ (Range1D::Index i, const Range1D &rng_rhs)
	rng_lhs = i + rng_rhs.
Range1D	operator- (const Range1D &rng_rhs, Range1D::Index i)
	rng_lhs = rng_rhs - i.
Range1D	full_range (const Range1D &rng, Range1D::Index lbound, Range1D::Index ubound)
	Return a bounded index range from a potentially unbounded index range.