Rodin

Pair

Forward declaration of the Pair template class.

Defined in Rodin/Pair.h

template <
  class L,
  class R>
class Pair;
Template parameters
L Type of the first element.
R Type of the second element.

A Pair class representing a tuple with two elements.

The Pair class extends the Tuple class for exactly two elements, providing convenient accessors for the first and second elements.

Direct inheritance by class family
↓
Pair

Inherits from

Base classResponsibility
Tuple<L, R>public
Full type
Tuple< L, R >
Forward declaration of the Tuple template class.

Public types

using Parent = Tuple<L, R>
Parent class type.

Constructors, destructors, conversion operators

Pair(const Pair& other)
Copy constructor.
Pair(Pair&& other)
Move constructor.

Public functions

auto operator=(const Pair& other) -> Pair& constexpr
Copy assignment operator.
auto operator=(Pair&& other) -> Pair& constexpr
Move assignment operator.
auto first() -> auto&
Retrieves the first element of the Pair.
auto second() -> auto&
Retrieves the second element of the Pair.
auto first() const -> const auto&
Retrieves the first element of the Pair (const version).
auto second() const -> const auto&
Retrieves the second element of the Pair (const version).

Function documentation

Pair(const Pair& other)

Copy constructor.

Parameters
other The Pair object to copy from.

Pair(Pair&& other)

Move constructor.

Parameters
other The Pair object to move from.

Pair& operator=(const Pair& other) constexpr

Copy assignment operator.

Parameters
other The Pair object to copy from.
Returns Reference to this Pair.

Pair& operator=(Pair&& other) constexpr

Move assignment operator.

Parameters
other The Pair object to move from.
Returns Reference to this Pair.

auto& first()

Retrieves the first element of the Pair.

Returns Reference to the first element.

auto& second()

Retrieves the second element of the Pair.

Returns Reference to the second element.

const auto& first() const

Retrieves the first element of the Pair (const version).

Returns Const reference to the first element.

const auto& second() const

Retrieves the second element of the Pair (const version).

Returns Const reference to the second element.