VTK-m  1.6
Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
vtkm::cont::DeviceAdapterId Struct Reference

#include <DeviceAdapterTag.h>

Public Member Functions

constexpr bool operator== (DeviceAdapterId other) const
 
constexpr bool operator!= (DeviceAdapterId other) const
 
constexpr bool operator< (DeviceAdapterId other) const
 
constexpr bool IsValueValid () const
 
constexpr vtkm::Int8 GetValue () const
 
VTKM_CONT_EXPORT DeviceAdapterNameType GetName () const
 

Protected Member Functions

constexpr DeviceAdapterId (vtkm::Int8 id)
 

Private Attributes

vtkm::Int8 Value
 

Friends

DeviceAdapterId make_DeviceAdapterId (vtkm::Int8 id)
 Construct a device adapter id a vtkm::Int8. More...
 

Constructor & Destructor Documentation

◆ DeviceAdapterId()

constexpr vtkm::cont::DeviceAdapterId::DeviceAdapterId ( vtkm::Int8  id)
inlineexplicitconstexprprotected

Member Function Documentation

◆ GetName()

VTKM_CONT_EXPORT DeviceAdapterNameType vtkm::cont::DeviceAdapterId::GetName ( ) const

◆ GetValue()

constexpr vtkm::Int8 vtkm::cont::DeviceAdapterId::GetValue ( ) const
inlineconstexpr

◆ IsValueValid()

constexpr bool vtkm::cont::DeviceAdapterId::IsValueValid ( ) const
inlineconstexpr

◆ operator!=()

constexpr bool vtkm::cont::DeviceAdapterId::operator!= ( DeviceAdapterId  other) const
inlineconstexpr

◆ operator<()

constexpr bool vtkm::cont::DeviceAdapterId::operator< ( DeviceAdapterId  other) const
inlineconstexpr

◆ operator==()

constexpr bool vtkm::cont::DeviceAdapterId::operator== ( DeviceAdapterId  other) const
inlineconstexpr

Friends And Related Function Documentation

◆ make_DeviceAdapterId

DeviceAdapterId make_DeviceAdapterId ( vtkm::Int8  id)
friend

Construct a device adapter id a vtkm::Int8.

The mapping of integer value to devices are:

DeviceAdapterTagSerial == 1 DeviceAdapterTagCuda == 2 DeviceAdapterTagTBB == 3 DeviceAdapterTagOpenMP == 4 DeviceAdapterTagKokkos == 5

Member Data Documentation

◆ Value

vtkm::Int8 vtkm::cont::DeviceAdapterId::Value
private

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