RangeId.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
#ifndef viskores_RangeId_h
#define viskores_RangeId_h
 
#include <viskores/Math.h>
#include <viskores/Types.h>
 
namespace viskores
{
 
struct RangeId
{
  viskores::Id Min;
  viskores::Id Max;
 
  VISKORES_EXEC_CONT
  RangeId()
    : Min(0)
    , Max(0)
  {
  }
 
  VISKORES_EXEC_CONT
  RangeId(viskores::Id min, viskores::Id max)
    : Min(min)
    , Max(max)
  {
  }
 
  VISKORES_EXEC_CONT
  bool IsNonEmpty() const { return (this->Min < this->Max); }
 
  VISKORES_EXEC_CONT
  bool Contains(viskores::Id value) const { return ((this->Min <= value) && (this->Max > value)); }
 
  VISKORES_EXEC_CONT
  viskores::Id Length() const { return this->Max - this->Min; }
 
  VISKORES_EXEC_CONT
  viskores::Id Center() const { return (this->Min + this->Max) / 2; }
 
  VISKORES_EXEC_CONT
  void Include(viskores::Id value)
  {
    this->Min = viskores::Min(this->Min, value);
    this->Max = viskores::Max(this->Max, value + 1);
  }
 
  VISKORES_EXEC_CONT
  void Include(const viskores::RangeId& range)
  {
    this->Min = viskores::Min(this->Min, range.Min);
    this->Max = viskores::Max(this->Max, range.Max);
  }
 
  VISKORES_EXEC_CONT
  viskores::RangeId Union(const viskores::RangeId& other) const
  {
    viskores::RangeId unionRange(*this);
    unionRange.Include(other);
    return unionRange;
  }
 
  VISKORES_EXEC_CONT
  viskores::RangeId operator+(const viskores::RangeId& other) const { return this->Union(other); }
 
  VISKORES_EXEC_CONT
  bool operator==(const viskores::RangeId& other) const
  {
    return ((this->Min == other.Min) && (this->Max == other.Max));
  }
 
  VISKORES_EXEC_CONT
  bool operator!=(const viskores::RangeId& other) const
  {
    return ((this->Min != other.Min) || (this->Max != other.Max));
  }
};
 
static inline VISKORES_CONT std::ostream& operator<<(std::ostream& stream,
                                                     const viskores::RangeId& range)
{
  return stream << "[" << range.Min << ".." << range.Max << ")";
} // Declared inside of viskores namespace so that the operator work with ADL lookup
} // namespace viskores
 
#endif // viskores_RangeId_h