Non-Member Functions Associated with Range1D.


Functions

bool RangePack::operator== (const Range1D &rng1, const Range1D &rng2)
 rng1 == rng2.
Range1D RangePack::operator+ (const Range1D &rng_rhs, Range1D::Index i)
 rng_lhs = rng_rhs + i.
Range1D RangePack::operator+ (Range1D::Index i, const Range1D &rng_rhs)
 rng_lhs = i + rng_rhs.
Range1D RangePack::operator- (const Range1D &rng_rhs, Range1D::Index i)
 rng_lhs = rng_rhs - i.
Range1D RangePack::full_range (const Range1D &rng, Range1D::Index lbound, Range1D::Index ubound)

Detailed Description

The first three are arithmetic operator functions for incrementing the index and the last is utility function.

Function Documentation

bool operator== const Range1D &  rng1,
const Range1D &  rng2
[inline]
 

rng1 == rng2.

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

Definition at line 149 of file Thyra_Range1D.hpp.

Range1D operator+ const Range1D &  rng_rhs,
Range1D::Index  i
[inline]
 

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 163 of file Thyra_Range1D.hpp.

Range1D operator+ Range1D::Index  i,
const Range1D &  rng_rhs
[inline]
 

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 177 of file Thyra_Range1D.hpp.

Range1D operator- const Range1D &  rng_rhs,
Range1D::Index  i
[inline]
 

rng_lhs = rng_rhs - i.

Deincrements the upper and lower bounds by a constant.

Postcondition:

  • rng_lhs.lbound() == rng_rhs.lbound() - 1
  • rng_lhs.ubound() == rng_rhs.ubound() - 1

Definition at line 191 of file Thyra_Range1D.hpp.

Range1D full_range const Range1D &  rng,
Range1D::Index  lbound,
Range1D::Index  ubound
[inline]
 

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:

Definition at line 209 of file Thyra_Range1D.hpp.


Generated on Thu Sep 18 12:39:42 2008 for Thyra Miscellaneous Utilities by doxygen 1.3.9.1