c3a3184d51
Sandia National Laboratories recently changed management from the Sandia Corporation to the National Technology & Engineering Solutions of Sandia, LLC (NTESS). The copyright statements need to be updated accordingly.
283 lines
8.6 KiB
C++
283 lines
8.6 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 2014 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
|
|
// Copyright 2014 UT-Battelle, LLC.
|
|
// Copyright 2014 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-NA0003525 with NTESS,
|
|
// 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_cont_internal_ArrayPortalFromIterators_h
|
|
#define vtk_m_cont_internal_ArrayPortalFromIterators_h
|
|
|
|
#include <vtkm/Assert.h>
|
|
#include <vtkm/Types.h>
|
|
#include <vtkm/cont/ArrayPortal.h>
|
|
#include <vtkm/cont/ArrayPortalToIterators.h>
|
|
#include <vtkm/cont/ErrorBadAllocation.h>
|
|
|
|
#include <iterator>
|
|
#include <limits>
|
|
|
|
#include <type_traits>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
namespace internal
|
|
{
|
|
|
|
template <typename IteratorT, typename Enable = void>
|
|
class ArrayPortalFromIterators;
|
|
|
|
/// This templated implementation of an ArrayPortal allows you to adapt a pair
|
|
/// of begin/end iterators to an ArrayPortal interface.
|
|
///
|
|
template <class IteratorT>
|
|
class ArrayPortalFromIterators<IteratorT,
|
|
typename std::enable_if<!std::is_const<
|
|
typename std::remove_pointer<IteratorT>::type>::value>::type>
|
|
{
|
|
public:
|
|
using ValueType = typename std::iterator_traits<IteratorT>::value_type;
|
|
using IteratorType = IteratorT;
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_CONT
|
|
ArrayPortalFromIterators() {}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_CONT
|
|
ArrayPortalFromIterators(IteratorT begin, IteratorT end)
|
|
: BeginIterator(begin)
|
|
{
|
|
typename std::iterator_traits<IteratorT>::difference_type numberOfValues =
|
|
std::distance(begin, end);
|
|
VTKM_ASSERT(numberOfValues >= 0);
|
|
#ifndef VTKM_USE_64BIT_IDS
|
|
if (numberOfValues > (std::numeric_limits<vtkm::Id>::max)())
|
|
{
|
|
throw vtkm::cont::ErrorBadAllocation(
|
|
"Distance of iterators larger than maximum array size. "
|
|
"To support larger arrays, try turning on VTKM_USE_64BIT_IDS.");
|
|
}
|
|
#endif // !VTKM_USE_64BIT_IDS
|
|
this->NumberOfValues = static_cast<vtkm::Id>(numberOfValues);
|
|
}
|
|
|
|
/// Copy constructor for any other ArrayPortalFromIterators with an iterator
|
|
/// type that can be copied to this iterator type. This allows us to do any
|
|
/// type casting that the iterators do (like the non-const to const cast).
|
|
///
|
|
template <class OtherIteratorT>
|
|
VTKM_CONT ArrayPortalFromIterators(const ArrayPortalFromIterators<OtherIteratorT>& src)
|
|
: BeginIterator(src.GetIteratorBegin())
|
|
, NumberOfValues(src.GetNumberOfValues())
|
|
{
|
|
}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
vtkm::Id GetNumberOfValues() const { return this->NumberOfValues; }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
ValueType Get(vtkm::Id index) const { return *this->IteratorAt(index); }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
void Set(vtkm::Id index, const ValueType& value) const { *(this->BeginIterator + index) = value; }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
IteratorT GetIteratorBegin() const { return this->BeginIterator; }
|
|
|
|
private:
|
|
IteratorT BeginIterator;
|
|
vtkm::Id NumberOfValues;
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
IteratorT IteratorAt(vtkm::Id index) const
|
|
{
|
|
VTKM_ASSERT(index >= 0);
|
|
VTKM_ASSERT(index < this->GetNumberOfValues());
|
|
|
|
return this->BeginIterator + index;
|
|
}
|
|
};
|
|
|
|
template <class IteratorT>
|
|
class ArrayPortalFromIterators<IteratorT,
|
|
typename std::enable_if<std::is_const<
|
|
typename std::remove_pointer<IteratorT>::type>::value>::type>
|
|
{
|
|
public:
|
|
using ValueType = typename std::iterator_traits<IteratorT>::value_type;
|
|
using IteratorType = IteratorT;
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_CONT
|
|
ArrayPortalFromIterators()
|
|
: BeginIterator(nullptr)
|
|
, NumberOfValues(0)
|
|
{
|
|
}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_CONT
|
|
ArrayPortalFromIterators(IteratorT begin, IteratorT end)
|
|
: BeginIterator(begin)
|
|
{
|
|
typename std::iterator_traits<IteratorT>::difference_type numberOfValues =
|
|
std::distance(begin, end);
|
|
VTKM_ASSERT(numberOfValues >= 0);
|
|
#ifndef VTKM_USE_64BIT_IDS
|
|
if (numberOfValues > (std::numeric_limits<vtkm::Id>::max)())
|
|
{
|
|
throw vtkm::cont::ErrorBadAllocation(
|
|
"Distance of iterators larger than maximum array size. "
|
|
"To support larger arrays, try turning on VTKM_USE_64BIT_IDS.");
|
|
}
|
|
#endif // !VTKM_USE_64BIT_IDS
|
|
this->NumberOfValues = static_cast<vtkm::Id>(numberOfValues);
|
|
}
|
|
|
|
/// Copy constructor for any other ArrayPortalFromIterators with an iterator
|
|
/// type that can be copied to this iterator type. This allows us to do any
|
|
/// type casting that the iterators do (like the non-const to const cast).
|
|
///
|
|
template <class OtherIteratorT>
|
|
VTKM_CONT ArrayPortalFromIterators(const ArrayPortalFromIterators<OtherIteratorT>& src)
|
|
: BeginIterator(src.GetIteratorBegin())
|
|
, NumberOfValues(src.GetNumberOfValues())
|
|
{
|
|
}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
vtkm::Id GetNumberOfValues() const { return this->NumberOfValues; }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
ValueType Get(vtkm::Id index) const { return *this->IteratorAt(index); }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
void Set(vtkm::Id vtkmNotUsed(index), const ValueType& vtkmNotUsed(value)) const
|
|
{
|
|
#if !(defined(VTKM_MSVC) && defined(VTKM_CUDA))
|
|
VTKM_ASSERT(false && "Attempted to write to constant array.");
|
|
#endif
|
|
}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
IteratorT GetIteratorBegin() const { return this->BeginIterator; }
|
|
|
|
private:
|
|
IteratorT BeginIterator;
|
|
vtkm::Id NumberOfValues;
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
IteratorT IteratorAt(vtkm::Id index) const
|
|
{
|
|
VTKM_ASSERT(index >= 0);
|
|
VTKM_ASSERT(index < this->GetNumberOfValues());
|
|
|
|
return this->BeginIterator + index;
|
|
}
|
|
};
|
|
}
|
|
}
|
|
} // namespace vtkm::cont::internal
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
/// Partial specialization of \c ArrayPortalToIterators for \c
|
|
/// ArrayPortalFromIterators. Returns the original array rather than
|
|
/// the portal wrapped in an \c IteratorFromArrayPortal.
|
|
///
|
|
template <typename _IteratorType>
|
|
class ArrayPortalToIterators<vtkm::cont::internal::ArrayPortalFromIterators<_IteratorType>>
|
|
{
|
|
using PortalType = vtkm::cont::internal::ArrayPortalFromIterators<_IteratorType>;
|
|
|
|
public:
|
|
#if !defined(VTKM_MSVC) || (defined(_ITERATOR_DEBUG_LEVEL) && _ITERATOR_DEBUG_LEVEL == 0)
|
|
using IteratorType = _IteratorType;
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
ArrayPortalToIterators(const PortalType& portal)
|
|
: Iterator(portal.GetIteratorBegin())
|
|
, NumberOfValues(portal.GetNumberOfValues())
|
|
{
|
|
}
|
|
|
|
#else // VTKM_MSVC
|
|
// The MSVC compiler issues warnings when using raw pointer math when in
|
|
// debug mode. To keep the compiler happy (and add some safety checks),
|
|
// wrap the iterator in checked_array_iterator.
|
|
using IteratorType = stdext::checked_array_iterator<_IteratorType>;
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
ArrayPortalToIterators(const PortalType& portal)
|
|
: Iterator(portal.GetIteratorBegin(), static_cast<size_t>(portal.GetNumberOfValues()))
|
|
, NumberOfValues(portal.GetNumberOfValues())
|
|
{
|
|
}
|
|
|
|
#endif // VTKM_MSVC
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
IteratorType GetBegin() const { return this->Iterator; }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
IteratorType GetEnd() const
|
|
{
|
|
IteratorType iterator = this->Iterator;
|
|
using difference_type = typename std::iterator_traits<IteratorType>::difference_type;
|
|
|
|
#if !defined(VTKM_MSVC) || (defined(_ITERATOR_DEBUG_LEVEL) && _ITERATOR_DEBUG_LEVEL == 0)
|
|
std::advance(iterator, static_cast<difference_type>(this->NumberOfValues));
|
|
#else
|
|
//Visual Studio checked iterators throw exceptions when you try to advance
|
|
//nullptr iterators even if the advancement length is zero. So instead
|
|
//don't do the advancement at all
|
|
if (this->NumberOfValues > 0)
|
|
{
|
|
std::advance(iterator, static_cast<difference_type>(this->NumberOfValues));
|
|
}
|
|
#endif
|
|
|
|
return iterator;
|
|
}
|
|
|
|
private:
|
|
IteratorType Iterator;
|
|
vtkm::Id NumberOfValues;
|
|
};
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_internal_ArrayPortalFromIterators_h
|