2014-09-04 17:56:15 +00:00
|
|
|
//============================================================================
|
|
|
|
// Copyright (c) Kitware, Inc.
|
|
|
|
// All rights reserved.
|
|
|
|
// See LICENSE.txt for details.
|
2019-04-15 23:24:21 +00:00
|
|
|
//
|
2014-09-04 17:56:15 +00:00
|
|
|
// 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 vtk_m_cont_ArrayPortalToIterators_h
|
|
|
|
#define vtk_m_cont_ArrayPortalToIterators_h
|
|
|
|
|
|
|
|
#include <vtkm/cont/ArrayPortal.h>
|
|
|
|
#include <vtkm/cont/internal/IteratorFromArrayPortal.h>
|
|
|
|
|
2019-12-13 19:19:27 +00:00
|
|
|
namespace vtkmstd
|
|
|
|
{
|
|
|
|
/// Implementation of std::void_t (C++17):
|
|
|
|
/// Allows for specialization of class templates based on members of template
|
|
|
|
/// parameters.
|
2019-12-23 14:38:54 +00:00
|
|
|
#if defined(VTKM_GCC) && (__GNUC__ < 5)
|
|
|
|
// Due to a defect in the wording (CWG 1558) unused parameters in alias templates
|
|
|
|
// were not guaranteed to ensure SFINAE, and therefore would consider everything
|
|
|
|
// to match the 'true' side. For VTK-m the only known compiler that implemented
|
|
|
|
// this defect is GCC < 5.
|
|
|
|
template <class... T>
|
|
|
|
struct void_pack
|
|
|
|
{
|
|
|
|
using type = void;
|
|
|
|
};
|
|
|
|
template <class... T>
|
|
|
|
using void_t = typename void_pack<T...>::type;
|
|
|
|
#else
|
2019-12-13 19:19:27 +00:00
|
|
|
template <typename...>
|
|
|
|
using void_t = void;
|
2019-12-23 14:38:54 +00:00
|
|
|
#endif
|
|
|
|
|
2019-12-13 19:19:27 +00:00
|
|
|
|
|
|
|
} // end namespace vtkmstd
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace cont
|
|
|
|
{
|
2014-09-04 17:56:15 +00:00
|
|
|
|
|
|
|
/// \brief Convert an \c ArrayPortal to STL iterators.
|
|
|
|
///
|
|
|
|
/// \c ArrayPortalToIterators is a class that holds an \c ArrayPortal and
|
|
|
|
/// builds iterators that access the data in the \c ArrayPortal. The point of
|
|
|
|
/// this class is to use an \c ArrayPortal with generic functions that expect
|
|
|
|
/// STL iterators such as STL algorithms or Thrust operations.
|
|
|
|
///
|
|
|
|
/// The default template implementation constructs iterators that provide
|
|
|
|
/// values through the \c ArrayPortal itself. This class can be specialized to
|
|
|
|
/// provide iterators that more directly access the data. For example, \c
|
|
|
|
/// ArrayPortalFromIterator has a specialization to return the original
|
|
|
|
/// iterators.
|
|
|
|
///
|
2019-12-13 19:19:27 +00:00
|
|
|
template <typename PortalType, typename CustomIterSFINAE = void>
|
2014-09-04 17:56:15 +00:00
|
|
|
class ArrayPortalToIterators
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
/// \c ArrayPortaltoIterators should be constructed with an instance of
|
|
|
|
/// the array portal.
|
|
|
|
///
|
2016-03-31 13:13:54 +00:00
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2019-12-13 19:19:27 +00:00
|
|
|
explicit ArrayPortalToIterators(const PortalType& portal)
|
2017-05-18 14:29:41 +00:00
|
|
|
: Portal(portal)
|
|
|
|
{
|
|
|
|
}
|
2014-09-04 17:56:15 +00:00
|
|
|
|
|
|
|
/// The type of the iterator.
|
|
|
|
///
|
2017-06-23 18:50:34 +00:00
|
|
|
using IteratorType = vtkm::cont::internal::IteratorFromArrayPortal<PortalType>;
|
2014-09-04 17:56:15 +00:00
|
|
|
|
|
|
|
/// Returns an iterator pointing to the beginning of the ArrayPortal.
|
|
|
|
///
|
2016-03-31 13:13:54 +00:00
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
IteratorType GetBegin() const { return vtkm::cont::internal::make_IteratorBegin(this->Portal); }
|
2014-09-04 17:56:15 +00:00
|
|
|
|
|
|
|
/// Returns an iterator pointing to one past the end of the ArrayPortal.
|
|
|
|
///
|
2016-03-31 13:13:54 +00:00
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
IteratorType GetEnd() const { return vtkm::cont::internal::make_IteratorEnd(this->Portal); }
|
2014-09-04 17:56:15 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
PortalType Portal;
|
|
|
|
};
|
|
|
|
|
2019-12-13 19:19:27 +00:00
|
|
|
// Specialize for custom iterator types:
|
|
|
|
template <typename PortalType>
|
|
|
|
class ArrayPortalToIterators<PortalType, vtkmstd::void_t<typename PortalType::IteratorType>>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
using IteratorType = typename PortalType::IteratorType;
|
|
|
|
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
|
|
VTKM_EXEC_CONT
|
|
|
|
explicit ArrayPortalToIterators(const PortalType& portal)
|
|
|
|
: Begin(portal.GetIteratorBegin())
|
|
|
|
, End(portal.GetIteratorEnd())
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
|
|
VTKM_EXEC_CONT
|
|
|
|
IteratorType GetBegin() const { return this->Begin; }
|
|
|
|
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
|
|
VTKM_EXEC_CONT
|
|
|
|
IteratorType GetEnd() const { return this->End; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
IteratorType Begin;
|
|
|
|
IteratorType End;
|
|
|
|
};
|
|
|
|
|
2018-01-30 00:24:31 +00:00
|
|
|
/// Convenience function for converting an ArrayPortal to a begin iterator.
|
2014-09-04 17:56:15 +00:00
|
|
|
///
|
2016-03-31 13:13:54 +00:00
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename PortalType>
|
|
|
|
VTKM_EXEC_CONT typename vtkm::cont::ArrayPortalToIterators<PortalType>::IteratorType
|
|
|
|
ArrayPortalToIteratorBegin(const PortalType& portal)
|
2014-09-04 17:56:15 +00:00
|
|
|
{
|
|
|
|
vtkm::cont::ArrayPortalToIterators<PortalType> iterators(portal);
|
|
|
|
return iterators.GetBegin();
|
|
|
|
}
|
|
|
|
|
2018-01-30 00:24:31 +00:00
|
|
|
/// Convenience function for converting an ArrayPortal to an end iterator.
|
2014-09-04 17:56:15 +00:00
|
|
|
///
|
2016-03-31 13:13:54 +00:00
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename PortalType>
|
|
|
|
VTKM_EXEC_CONT typename vtkm::cont::ArrayPortalToIterators<PortalType>::IteratorType
|
|
|
|
ArrayPortalToIteratorEnd(const PortalType& portal)
|
2014-09-04 17:56:15 +00:00
|
|
|
{
|
|
|
|
vtkm::cont::ArrayPortalToIterators<PortalType> iterators(portal);
|
|
|
|
return iterators.GetEnd();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} // namespace vtkm::cont
|
|
|
|
|
|
|
|
#endif //vtk_m_cont_ArrayPortalToIterators_h
|