fdaccc22db
Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
196 lines
5.3 KiB
C++
196 lines
5.3 KiB
C++
//============================================================================
|
|
// 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.
|
|
//
|
|
// Copyright 2016 Sandia Corporation.
|
|
// Copyright 2016 UT-Battelle, LLC.
|
|
// Copyright 2016 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
// the U.S. Government retains certain rights in this software.
|
|
//
|
|
// Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
|
|
// Laboratory (LANL), the U.S. Government retains certain rights in
|
|
// this software.
|
|
//============================================================================
|
|
|
|
#ifndef vtk_m_Range_h
|
|
#define vtk_m_Range_h
|
|
|
|
#include <vtkm/Assert.h>
|
|
#include <vtkm/Math.h>
|
|
#include <vtkm/Types.h>
|
|
|
|
namespace vtkm {
|
|
|
|
/// \brief Represent a continuous scalar range of values.
|
|
///
|
|
/// \c vtkm::Range is a helper class for representing a range of floating point
|
|
/// values from a minimum value to a maximum value. This is specified simply
|
|
/// enough with a \c Min and \c Max value.
|
|
///
|
|
/// \c Range also contains several helper functions for computing and
|
|
/// maintaining the range.
|
|
///
|
|
struct Range
|
|
{
|
|
vtkm::Float64 Min;
|
|
vtkm::Float64 Max;
|
|
|
|
VTKM_EXEC_CONT
|
|
Range() : Min(vtkm::Infinity64()), Max(vtkm::NegativeInfinity64()) { }
|
|
|
|
template<typename T1, typename T2>
|
|
VTKM_EXEC_CONT
|
|
Range(const T1 &min, const T2 &max)
|
|
: Min(static_cast<vtkm::Float64>(min)), Max(static_cast<vtkm::Float64>(max))
|
|
{ }
|
|
|
|
VTKM_EXEC_CONT
|
|
const vtkm::Range &operator=(const vtkm::Range &src)
|
|
{
|
|
this->Min = src.Min;
|
|
this->Max = src.Max;
|
|
return *this;
|
|
}
|
|
|
|
/// \b Determine if the range is valid (i.e. has at least one valid point).
|
|
///
|
|
/// \c IsNonEmpty return true if the range contains some valid values between
|
|
/// \c Min and \c Max. If \c Max is less than \c Min, then no values satisfy
|
|
/// the range and \c IsNonEmpty returns false. Otherwise, return true.
|
|
///
|
|
/// \c IsNonEmpty assumes \c Min and \c Max are inclusive. That is, if they
|
|
/// are equal then true is returned.
|
|
///
|
|
VTKM_EXEC_CONT
|
|
bool IsNonEmpty() const
|
|
{
|
|
return (this->Min <= this->Max);
|
|
}
|
|
|
|
/// \b Determines if a value is within the range.
|
|
///
|
|
/// \c Contains returns true if the give value is within the range, false
|
|
/// otherwise. \c Contains treats the min and max as inclusive. That is, if
|
|
/// the value is exactly the min or max, true is returned.
|
|
///
|
|
template<typename T>
|
|
VTKM_EXEC_CONT
|
|
bool Contains(const T &value) const
|
|
{
|
|
return ((this->Min <= static_cast<vtkm::Float64>(value)) &&
|
|
(this->Max >= static_cast<vtkm::Float64>(value)));
|
|
}
|
|
|
|
/// \b Returns the length of the range.
|
|
///
|
|
/// \c Length computes the distance between the min and max. If the range
|
|
/// is empty, 0 is returned.
|
|
///
|
|
VTKM_EXEC_CONT
|
|
vtkm::Float64 Length() const
|
|
{
|
|
if (this->IsNonEmpty())
|
|
{
|
|
return (this->Max - this->Min);
|
|
}
|
|
else
|
|
{
|
|
return 0.0;
|
|
}
|
|
}
|
|
|
|
/// \b Returns the center of the range.
|
|
///
|
|
/// \c Center computes the middle value of the range. If the range is empty,
|
|
/// NaN is returned.
|
|
///
|
|
VTKM_EXEC_CONT
|
|
vtkm::Float64 Center() const
|
|
{
|
|
if (this->IsNonEmpty())
|
|
{
|
|
return 0.5*(this->Max + this->Min);
|
|
}
|
|
else
|
|
{
|
|
return vtkm::Nan64();
|
|
}
|
|
}
|
|
|
|
/// \b Expand range to include a value.
|
|
///
|
|
/// This version of \c Include expands the range just enough to include the
|
|
/// given value. If the range already includes this value, then nothing is
|
|
/// done.
|
|
///
|
|
template<typename T>
|
|
VTKM_EXEC_CONT
|
|
void Include(const T &value)
|
|
{
|
|
this->Min = vtkm::Min(this->Min, static_cast<vtkm::Float64>(value));
|
|
this->Max = vtkm::Max(this->Max, static_cast<vtkm::Float64>(value));
|
|
}
|
|
|
|
/// \b Expand range to include other range.
|
|
///
|
|
/// This version of \c Include expands this range just enough to include that
|
|
/// of another range. Esentially it is the union of the two ranges.
|
|
///
|
|
VTKM_EXEC_CONT
|
|
void Include(const vtkm::Range &range)
|
|
{
|
|
this->Include(range.Min);
|
|
this->Include(range.Max);
|
|
}
|
|
|
|
/// \b Return the union of this and another range.
|
|
///
|
|
/// This is a nondestructive form of \c Include.
|
|
///
|
|
VTKM_EXEC_CONT
|
|
vtkm::Range Union(const vtkm::Range &otherRange) const
|
|
{
|
|
vtkm::Range unionRange(*this);
|
|
unionRange.Include(otherRange);
|
|
return unionRange;
|
|
}
|
|
|
|
/// \b Operator for union
|
|
///
|
|
VTKM_EXEC_CONT
|
|
vtkm::Range operator+(const vtkm::Range &otherRange) const
|
|
{
|
|
return this->Union(otherRange);
|
|
}
|
|
|
|
VTKM_EXEC_CONT
|
|
bool operator==(const vtkm::Range &otherRange) const
|
|
{
|
|
return ((this->Min == otherRange.Min) && (this->Max == otherRange.Max));
|
|
}
|
|
|
|
VTKM_EXEC_CONT
|
|
bool operator!=(const vtkm::Range &otherRange) const
|
|
{
|
|
return ((this->Min != otherRange.Min) || (this->Max != otherRange.Max));
|
|
}
|
|
};
|
|
|
|
} // namespace vtkm
|
|
|
|
/// Helper function for printing ranges during testing
|
|
///
|
|
static inline VTKM_CONT
|
|
std::ostream &operator<<(std::ostream &stream, const vtkm::Range &range)
|
|
{
|
|
return stream << "[" << range.Min << ".." << range.Max << "]";
|
|
}
|
|
|
|
#endif //vtk_m_Range_h
|