VTK-m  1.8
Public Types | Public Member Functions | Private Attributes | List of all members
vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type > Class Template Reference

Convert an ArrayPortal to STL iterators. More...

#include <ArrayPortalToIterators.h>

Public Types

using IteratorType = vtkm::cont::internal::IteratorFromArrayPortal< PortalType >
 The type of the iterator. More...
 

Public Member Functions

VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT ArrayPortalToIterators (const PortalType &portal)
 ArrayPortaltoIterators should be constructed with an instance of the array portal. More...
 
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT ArrayPortalToIterators (const ArrayPortalToIterators &src)
 
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT ArrayPortalToIterators (ArrayPortalToIterators &&rhs)
 
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT ~ArrayPortalToIterators ()
 
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT ArrayPortalToIteratorsoperator= (const ArrayPortalToIterators &src)
 
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT ArrayPortalToIteratorsoperator= (ArrayPortalToIterators &&rhs)
 
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT IteratorType GetBegin () const
 Returns an iterator pointing to the beginning of the ArrayPortal. More...
 
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT IteratorType GetEnd () const
 Returns an iterator pointing to one past the end of the ArrayPortal. More...
 

Private Attributes

PortalType Portal
 

Detailed Description

template<typename PortalType>
class vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >

Convert an ArrayPortal to STL iterators.

ArrayPortalToIterators is a class that holds an ArrayPortal and builds iterators that access the data in the ArrayPortal. The point of this class is to use an 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 ArrayPortal itself. However, if the ArrayPortal contains its own iterators (by defining GetIteratorBegin and GetIteratorEnd), then those iterators are used.

Member Typedef Documentation

◆ IteratorType

template<typename PortalType >
using vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::IteratorType = vtkm::cont::internal::IteratorFromArrayPortal<PortalType>

The type of the iterator.

Constructor & Destructor Documentation

◆ ArrayPortalToIterators() [1/3]

template<typename PortalType >
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::ArrayPortalToIterators ( const PortalType &  portal)
inlineexplicit

ArrayPortaltoIterators should be constructed with an instance of the array portal.

◆ ArrayPortalToIterators() [2/3]

template<typename PortalType >
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::ArrayPortalToIterators ( const ArrayPortalToIterators< PortalType, std::false_type > &  src)
inline

◆ ArrayPortalToIterators() [3/3]

template<typename PortalType >
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::ArrayPortalToIterators ( ArrayPortalToIterators< PortalType, std::false_type > &&  rhs)
inline

◆ ~ArrayPortalToIterators()

template<typename PortalType >
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::~ArrayPortalToIterators ( )
inline

Member Function Documentation

◆ GetBegin()

template<typename PortalType >
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT IteratorType vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::GetBegin ( ) const
inline

Returns an iterator pointing to the beginning of the ArrayPortal.

◆ GetEnd()

template<typename PortalType >
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT IteratorType vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::GetEnd ( ) const
inline

Returns an iterator pointing to one past the end of the ArrayPortal.

◆ operator=() [1/2]

template<typename PortalType >
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT ArrayPortalToIterators& vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::operator= ( ArrayPortalToIterators< PortalType, std::false_type > &&  rhs)
inline

◆ operator=() [2/2]

template<typename PortalType >
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT ArrayPortalToIterators& vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::operator= ( const ArrayPortalToIterators< PortalType, std::false_type > &  src)
inline

Member Data Documentation

◆ Portal

template<typename PortalType >
PortalType vtkm::cont::ArrayPortalToIterators< PortalType, std::false_type >::Portal
private

The documentation for this class was generated from the following file: