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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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_Assert.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_;
 
  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 bool operator!=(const Range1D& rng1, const Range1D& rng2 )
{
  return !(rng1 == rng2);
}
 

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; }
 

TEUCHOSCORE_LIB_DLL_EXPORT
std::ostream& operator<<(std::ostream &out, const Range1D& rng);
 
 
// //////////////////////////////////////////////////////////
// Inline members
 
inline
Range1D::Range1D()
  : lbound_(0), ubound_(std::numeric_limits<Ordinal>::max()-1)
{}
 
inline
Range1D::Range1D( EInvalidRange )
  : lbound_(0), ubound_(-2)
{}
 
 
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 (lbound_ == 0 && ubound_ == std::numeric_limits<Ordinal>::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
  TEUCHOS_ASSERT_INEQUALITY(lbound_in, >=, 0);
  TEUCHOS_ASSERT_INEQUALITY(ubound_in, >=, lbound_in - 1);
#endif
}
 
} // end namespace Teuchos
 
#endif // end TEUCHOS_RANGE1D_HPP