VTK-m  2.1
Public Types | Static Public Member Functions | List of all members
vtkm::TypeTraits< T > Class Template Reference

The TypeTraits class provides helpful compile-time information about the basic types used in VTKm (and a few others for convenience). More...

#include <TypeTraits.h>

Inheritance diagram for vtkm::TypeTraits< T >:
vtkm::TypeTraits< const T >

Public Types

using NumericTag = vtkm::TypeTraitsUnknownTag
 A tag to determine whether the type is integer or real. More...
 
using DimensionalityTag = vtkm::TypeTraitsUnknownTag
 A tag to determine whether the type has multiple components. More...
 

Static Public Member Functions

static T ZeroInitialization ()
 A static function that returns 0 (or the closest equivalent to it) for the given type. More...
 

Detailed Description

template<typename T>
class vtkm::TypeTraits< T >

The TypeTraits class provides helpful compile-time information about the basic types used in VTKm (and a few others for convenience).

The majority of TypeTraits contents are typedefs to tags that can be used to easily override behavior of called functions.

Member Typedef Documentation

◆ DimensionalityTag

template<typename T >
using vtkm::TypeTraits< T >::DimensionalityTag = vtkm::TypeTraitsUnknownTag

A tag to determine whether the type has multiple components.

This tag is either TypeTraitsScalarTag or TypeTraitsVectorTag. Scalars can also be treated as vectors with VecTraits.

◆ NumericTag

template<typename T >
using vtkm::TypeTraits< T >::NumericTag = vtkm::TypeTraitsUnknownTag

A tag to determine whether the type is integer or real.

This tag is either TypeTraitsRealTag or TypeTraitsIntegerTag.

Member Function Documentation

◆ ZeroInitialization()

template<typename T >
static T vtkm::TypeTraits< T >::ZeroInitialization ( )
inlinestatic

A static function that returns 0 (or the closest equivalent to it) for the given type.


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