Teuchos_Range1D.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

// Range1D class used for representing a range of positive integers.
// Its primary usage is in accessing vectors and matrices by subregions
// of rows and columns
//

#ifndef TEUCHOS_RANGE1D_HPP
#define TEUCHOS_RANGE1D_HPP

#include "Teuchos_ScalarTraits.hpp"
#include "Teuchos_TestForException.hpp"

namespace Teuchos {

class Range1D {
public:

  typedef Teuchos_Ordinal  Index;

  typedef Teuchos_Ordinal  Ordinal;

  enum EInvalidRange { INVALID };

  static const Range1D Invalid;

  inline Range1D();

  inline Range1D( EInvalidRange );

  inline Range1D(Ordinal lbound, Ordinal ubound);

  inline bool full_range() const;

  inline Ordinal lbound() const;

  inline Ordinal ubound() const;

  inline Ordinal size() const;

  inline bool in_range(Ordinal i) const;

  inline Range1D& operator+=( Ordinal incr );

  inline Range1D& operator-=( Ordinal incr );

private:
  Ordinal lbound_;
  Ordinal ubound_;  // = INT_MAX-1 flag for entire range
  // lbound == ubound == 0 flag for invalid range.
  
  // assert that the range is valid
  inline void assert_valid_range(Ordinal lbound, Ordinal ubound) const;
  
}; // end class Range1D
  
inline bool operator==(const Range1D& rng1, const Range1D& rng2 )
{
  return rng1.lbound() == rng2.lbound() && rng1.ubound() == rng2.ubound();
}

inline Range1D operator+(const Range1D &rng_rhs, Range1D::Ordinal i)
{
    return Range1D(i+rng_rhs.lbound(), i+rng_rhs.ubound());
}

inline Range1D operator+(Range1D::Ordinal i, const Range1D &rng_rhs)
{
    return Range1D(i+rng_rhs.lbound(), i+rng_rhs.ubound());
}

inline Range1D operator-(const Range1D &rng_rhs, Range1D::Ordinal i)
{
    return Range1D(rng_rhs.lbound()-i, rng_rhs.ubound()-i);
}

inline Range1D full_range(const Range1D &rng, Range1D::Ordinal lbound, Range1D::Ordinal ubound)
{ return rng.full_range() ? Range1D(lbound,ubound) : rng; }

// //////////////////////////////////////////////////////////
// Inline members

inline
Range1D::Range1D()
  : lbound_(0), ubound_(INT_MAX-1)
{}

inline
Range1D::Range1D( EInvalidRange )
  : lbound_(0), ubound_(-1)
{}


inline
Range1D::Range1D(Ordinal lbound_in, Ordinal ubound_in)
  : lbound_(lbound_in), ubound_(ubound_in)
{
  assert_valid_range(lbound_in,ubound_in);
}

inline
bool Range1D::full_range() const {
  return ubound_ == INT_MAX-1;
}

inline
Range1D::Ordinal Range1D::lbound() const {
  return lbound_;
}

inline
Range1D::Ordinal Range1D::ubound() const {
  return ubound_;
}

inline
Range1D::Ordinal Range1D::size() const {
  return ubound_ - lbound_ + 1;
}

inline
bool Range1D::in_range(Ordinal i) const {
  return lbound_ <= i && i <= ubound_;
}

inline
Range1D& Range1D::operator+=( Ordinal incr ) {
  assert_valid_range( lbound_ + incr, ubound_ + incr );
  lbound_ += incr;
  ubound_ += incr;
  return *this;
}

inline
Range1D& Range1D::operator-=( Ordinal incr )
{
  assert_valid_range( lbound_ - incr, ubound_ - incr );
  lbound_ -= incr;
  ubound_ -= incr;
  return *this;
}


// See Range1D.cpp
inline
void Range1D::assert_valid_range(Ordinal lbound_in, Ordinal ubound_in) const
{
  (void)lbound_in; (void)ubound_in;
#ifdef TEUCHOS_DEBUG
  TEST_FOR_EXCEPTION(
    lbound_in < 0, std::range_error
    ,"Range1D::assert_valid_range(): Error, lbound ="
    <<lbound_in<<" must be greater than or equal to 0."
    );
  TEST_FOR_EXCEPTION(
    lbound_in > ubound_in, std::range_error
    ,"Range1D::assert_valid_range(): Error, lbound = "
    <<lbound_in<<" > ubound = "<<ubound_in
    );
#endif
}

} // end namespace Teuchos

#endif // end TEUCHOS_RANGE1D_HPP