vtkm::VecCConst< T > Class Template Reference

A const version of VecC. More...

#include <Types.h>

Inheritance diagram for vtkm::VecCConst< T >:

Public Types
using	ComponentType = T

Public Member Functions
VTKM_EXEC_CONT	VecCConst ()
VTKM_EXEC_CONT	VecCConst (const T *array, vtkm::IdComponent size)
template<vtkm::IdComponent Size>
VTKM_EXEC_CONT	VecCConst (const vtkm::Vec< T, Size > &src)
VTKM_EXEC_CONT	VecCConst (const T &src)
VTKM_EXEC_CONT	VecCConst (const VecCConst< T > &src)
VTKM_EXEC_CONT	VecCConst (const VecC< T > &src)
const VTKM_EXEC_CONT T &	operator[] (vtkm::IdComponent index) const
VTKM_EXEC_CONT vtkm::IdComponent	GetNumberOfComponents () const

Private Types
using	Superclass = detail::VecCBase< T, VecCConst< T > >

Private Member Functions
	VTKM_STATIC_ASSERT_MSG (std::is_const< T >::value==false, "You cannot use VecCConst with a const type as its template argument. " "Remove the const from the type.")
void	operator= (const VecCConst< T > &)=delete
void	operator+= (const VecCConst< T > &)=delete
void	operator-= (const VecCConst< T > &)=delete
void	operator*= (const VecCConst< T > &)=delete
void	operator/= (const VecCConst< T > &)=delete

Private Attributes
const T *const	Components
vtkm::IdComponent	NumberOfComponents

Detailed Description

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

A const version of VecC.

VecCConst is a non-mutable form of VecC. It can be used in place of VecC when a constant array is available.

A VecC can be automatically converted to a VecCConst, but not vice versa, so function arguments should use VecCConst when the data do not need to be changed.

Member Typedef Documentation

ComponentType

template<typename T >

using vtkm::VecCConst< T >::ComponentType = T

Superclass

template<typename T >

using vtkm::VecCConst< T >::Superclass = detail::VecCBase<T, VecCConst<T> >

private

Constructor & Destructor Documentation

VecCConst() [1/6]

template<typename T >

VTKM_EXEC_CONT vtkm::VecCConst< T >::VecCConst ( )

inline

VecCConst() [2/6]

template<typename T >

VTKM_EXEC_CONT vtkm::VecCConst< T >::VecCConst ( const T *  array, vtkm::IdComponent  size  )

inline

VecCConst() [3/6]

template<typename T >

template<vtkm::IdComponent Size>

VTKM_EXEC_CONT vtkm::VecCConst< T >::VecCConst ( const vtkm::Vec< T, Size > &  src )

inline

VecCConst() [4/6]

template<typename T >

VTKM_EXEC_CONT vtkm::VecCConst< T >::VecCConst ( const T &  src )

inlineexplicit

VecCConst() [5/6]

template<typename T >

VTKM_EXEC_CONT vtkm::VecCConst< T >::VecCConst ( const VecCConst< T > &  src )

inline

VecCConst() [6/6]

template<typename T >

VTKM_EXEC_CONT vtkm::VecCConst< T >::VecCConst ( const VecC< T > &  src )

inline

Member Function Documentation

GetNumberOfComponents()

template<typename T >

VTKM_EXEC_CONT vtkm::IdComponent vtkm::VecCConst< T >::GetNumberOfComponents ( ) const

inline

operator*=()

template<typename T >

void vtkm::VecCConst< T >::operator*= ( const VecCConst< T > &  )

privatedelete

operator+=()

template<typename T >

void vtkm::VecCConst< T >::operator+= ( const VecCConst< T > &  )

privatedelete

operator-=()

template<typename T >

void vtkm::VecCConst< T >::operator-= ( const VecCConst< T > &  )

privatedelete

operator/=()

template<typename T >

void vtkm::VecCConst< T >::operator/= ( const VecCConst< T > &  )

privatedelete

operator=()

template<typename T >

void vtkm::VecCConst< T >::operator= ( const VecCConst< T > &  )

privatedelete

operator[]()

template<typename T >

const VTKM_EXEC_CONT T& vtkm::VecCConst< T >::operator[] ( vtkm::IdComponent  index ) const

inline

VTKM_STATIC_ASSERT_MSG()

template<typename T >

vtkm::VecCConst< T >::VTKM_STATIC_ASSERT_MSG ( std::is_const< T >::value  = =false, "You cannot use VecCConst< T > with a const type as its template argument. " "Remove the const from the type."    )

private

Member Data Documentation

Components

template<typename T >

const T* const vtkm::VecCConst< T >::Components

private

NumberOfComponents

template<typename T >

vtkm::IdComponent vtkm::VecCConst< T >::NumberOfComponents

private

---

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

• Types.h