Class Pair
Store two arbitrary objects.

Implements ComparableConcept
All Subcl's BitPackedPair, PackedPair
All Impl'd ComparableConcept, EqualityComparableConcept, LessThanComparableConcept
Defined in <seqan/basic.h>
Signature template <typename T1, typename T2, typename TSpec> class Pair;

Template Parameters

T1 The type of the first member.
T2 The type of the second member.
TSpec Tag used for the specialization.

Member Function Overview

Member Functions Inherited From ComparableConcept

Member Functions Inherited From EqualityComparableConcept

Member Functions Inherited From LessThanComparableConcept

Interface Function Overview

Interface Functions Inherited From ComparableConcept

Interface Metafunction Overview

Member Variable Overview

Interface Functions Detail

void assignValueI1(pair, val);

Set first entry of a pair.

Parameters

pair The pair to get entry from.
val Set the value of the Pair's first entry.

Data Races

Thread safety unknown!

void assignValueI2(pair, val);

Set second entry of a pair.

Parameters

pair The pair to get entry from.
val Set the value of the Pair's second entry.

Data Races

Thread safety unknown!

T1 getValueI1(pair);

The get-value of the Pair's first entry.

Parameters

pair The pair to get entry from.

Returns

T1 The first entry of the Pair.

Data Races

Thread safety unknown!

T2 getValueI2(pair);

The get-value of the Pair's second entry.

Parameters

pair The pair to get entry from.

Returns

T2 The second entry of the Pair.

Data Races

Thread safety unknown!

Pair::Pair(); Pair::Pair(other); Pair::Pair(x1, x2);

Default and copy construction and construction for two values.

Parameters

other The other Pair object to copy from.
x1 Copied to first member.
x2 Copied to second member

Data Races

Thread safety unknown!

void setValueI1(pair, val);

Set first entry of a pair.

Parameters

pair The pair to get entry from.
val Set the value of the Pair's first entry.

Data Races

Thread safety unknown!

void setValueI2(pair, val);

Set second entry of a pair.

Parameters

pair The pair to get entry from.
val Set the value of the Pair's second entry.

Data Races

Thread safety unknown!

Interface Metafunctions Detail

LENGTH<TPair>::VALUE;

Return number of members in a Pair (2).

Template Parameters

TPair The Pair specialization.

Returns

VALUE The number of element in a Pair (2).

Spec<TPair>::Type;

Return specialization tag.

Template Parameters

TPair The Pair specialization.

Returns

Type The resulting type.

Value<TTuple, I>::Type;

Return type of the i-th value.

Template Parameters

TTuple Tuple specialization to get the type of.
I The index of the member to get (1 or 2).

Returns

Type Result type.

Member Variables Detail

T1 Pair::i1

First member

T2 Pair::i2

Second member