A vtkm::Pair is essentially the same as an STL pair object except that the methods (constructors and operators) are defined to work in both the control and execution environments (whereas std::pair is likely to work only in the control environment). More...

#include <Pair.h>

Public Types
using	FirstType = T1
	The type of the first object. More...

using	SecondType = T2
	The type of the second object. More...

using	first_type = FirstType
	The same as FirstType, but follows the naming convention of std::pair. More...

using	second_type = SecondType
	The same as SecondType, but follows the naming convention of std::pair. More...

Public Member Functions
	Pair ()=default

VTKM_EXEC_CONT	Pair (const FirstType &firstSrc, const SecondType &secondSrc)

VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT	Pair (FirstType &&firstSrc, SecondType &&secondSrc) noexcept(noexcept(FirstType{ std::declval< FirstType && >() }, SecondType{ std::declval< SecondType && >() }))

	Pair (const Pair &)=default

	Pair (Pair &&)=default

template<typename U1 , typename U2 >
VTKM_EXEC_CONT	Pair (const vtkm::Pair< U1, U2 > &src)

template<typename U1 , typename U2 >
VTKM_EXEC_CONT	Pair (vtkm::Pair< U1, U2 > &&src) noexcept(noexcept(U1{ std::declval< U1 && >() }, U2{ std::declval< U2 && >() }))

template<typename U1 , typename U2 >
VTKM_EXEC_CONT	Pair (const std::pair< U1, U2 > &src)

template<typename U1 , typename U2 >
VTKM_EXEC_CONT	Pair (std::pair< U1, U2 > &&src) noexcept(noexcept(U1{ std::declval< U1 && >() }, U2{ std::declval< U2 && >() }))

vtkm::Pair< FirstType, SecondType > &	operator= (const vtkm::Pair< FirstType, SecondType > &src)=default

vtkm::Pair< FirstType, SecondType > &	operator= (vtkm::Pair< FirstType, SecondType > &&src)=default

VTKM_EXEC_CONT bool	operator== (const vtkm::Pair< FirstType, SecondType > &other) const

VTKM_EXEC_CONT bool	operator!= (const vtkm::Pair< FirstType, SecondType > &other) const

VTKM_EXEC_CONT bool	operator< (const vtkm::Pair< FirstType, SecondType > &other) const
	Tests ordering on the first object, and then on the second object if the first are equal. More...

VTKM_EXEC_CONT bool	operator> (const vtkm::Pair< FirstType, SecondType > &other) const
	Tests ordering on the first object, and then on the second object if the first are equal. More...

VTKM_EXEC_CONT bool	operator<= (const vtkm::Pair< FirstType, SecondType > &other) const
	Tests ordering on the first object, and then on the second object if the first are equal. More...

VTKM_EXEC_CONT bool	operator>= (const vtkm::Pair< FirstType, SecondType > &other) const
	Tests ordering on the first object, and then on the second object if the first are equal. More...

Public Attributes
FirstType	first
	The pair's first object. More...

SecondType	second
	The pair's second object. More...

Detailed Description

template<typename T1, typename T2>
struct vtkm::Pair< T1, T2 >

A vtkm::Pair is essentially the same as an STL pair object except that the methods (constructors and operators) are defined to work in both the control and execution environments (whereas std::pair is likely to work only in the control environment).