Pair

Classes
struct	bolt::amp::pair< T1, T2 >
struct	tuple_element< N, T >
struct	tuple_size< Pair >

Functions
template<typename T1 , typename T2 >
bool	bolt::amp::operator== (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::amp::operator< (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::amp::operator!= (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::amp::operator> (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::amp::operator<= (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::amp::operator>= (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
pair< T1, T2 >	bolt::amp::make_pair (T1 x, T2 y)
template<typename T1 , typename T2 >
bool	bolt::cl::operator== (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::cl::operator< (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::cl::operator!= (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::cl::operator> (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::cl::operator<= (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
bool	bolt::cl::operator>= (const pair< T1, T2 > &x, const pair< T1, T2 > &y)
template<typename T1 , typename T2 >
pair< T1, T2 >	bolt::cl::make_pair (T1 x, T2 y)

Detailed Description

Function Documentation

template<typename T1 , typename T2 >

pair< T1, T2 > bolt::amp::make_pair	(	T1	x,
		T2	y
	)

This function creates a pair from two objects.

Parameters

x	The first object to copy from.
y	The second object to copy from.

Returns

A newly-constructed pair copied from a and b.

Template Parameters

T1	There are no requirements on the type of T1.
T2	There are no requirements on the type of T2.

template<typename T1 , typename T2 >

pair< T1, T2 > bolt::cl::make_pair	(	T1	x,
		T2	y
	)

This function creates a pair from two objects.

Parameters

x	The first object to copy from.
y	The second object to copy from.

Returns

A newly-constructed pair copied from a and b.

Template Parameters

T1	There are no requirements on the type of T1.
T2	There are no requirements on the type of T2.

template<typename T1 , typename T2 >

bool bolt::amp::operator!=	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for inequality.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if !(x == y).

Template Parameters

T1	is a model of Equality Comparable.
T2	is a model of Equality Comparable.

template<typename T1 , typename T2 >

bool bolt::cl::operator!=	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for inequality.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if !(x == y).

Template Parameters

T1	is a model of Equality Comparable.
T2	is a model of Equality Comparable.

template<typename T1 , typename T2 >

bool bolt::amp::operator<	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for ascending ordering.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if x.first < y.first || (!(y.first < x.first) && x.second < y.second).

Template Parameters

T1	is a model of LessThan Comparable.
T2	is a model of LessThan Comparable.

template<typename T1 , typename T2 >

bool bolt::cl::operator<	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for ascending ordering.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if x.first < y.first || (!(y.first < x.first) && x.second < y.second).

Template Parameters

T1	is a model of LessThan Comparable.
T2	is a model of LessThan Comparable.

template<typename T1 , typename T2 >

bool bolt::amp::operator<=	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for ascending ordering or equivalence.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if !(y < x).

Template Parameters

T1	is a model of LessThan Comparable.
T2	is a model of LessThan Comparable.

template<typename T1 , typename T2 >

bool bolt::cl::operator<=	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for ascending ordering or equivalence.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if !(y < x).

Template Parameters

T1	is a model of LessThan Comparable.
T2	is a model of LessThan Comparable.

template<typename T1 , typename T2 >

bool bolt::amp::operator==	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for equality.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if x.first == y.first && x.second == y.second.

Template Parameters

T1	is a model of Equality Comparable.
T2	is a model of Equality Comparable.

template<typename T1 , typename T2 >

bool bolt::cl::operator==	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for equality.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if x.first == y.first && x.second == y.second.

Template Parameters

T1	is a model of Equality Comparable.
T2	is a model of Equality Comparable.

template<typename T1 , typename T2 >

bool bolt::amp::operator>	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for descending ordering.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if y < x.

Template Parameters

T1	is a model of LessThan Comparable.
T2	is a model of LessThan Comparable.

template<typename T1 , typename T2 >

bool bolt::cl::operator>	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for descending ordering.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if y < x.

Template Parameters

T1	is a model of LessThan Comparable.
T2	is a model of LessThan Comparable.

template<typename T1 , typename T2 >

bool bolt::amp::operator>=	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for descending ordering or equivalence.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if !(x < y).

Template Parameters

T1	is a model of LessThan Comparable.
T2	is a model of LessThan Comparable.

template<typename T1 , typename T2 >

bool bolt::cl::operator>=	(	const pair< T1, T2 > &	x,
		const pair< T1, T2 > &	y
	)

This operator tests two pairs for descending ordering or equivalence.

Parameters

x	The first pair to compare.
y	The second pair to compare.

Returns

true if and only if !(x < y).

Template Parameters

T1	is a model of LessThan Comparable.
T2	is a model of LessThan Comparable.