Pair¶

1

import "std/data/pair";

Pair<V1, V2> struct¶

A pair in Spice is a commonly used data structure, which saves two values of arbitrary type together in a correlation

Constructors¶

ctor¶

1

public inline p Pair.ctor(V1 first, V2 second)

Construct a pair from two values

Parameters

Methods¶

getFirst¶

1

public inline f<V1&> Pair.getFirst()

Retrieve the first value of the pair

Returns: V1& — Reference to the first value

getSecond¶

1

public inline f<V2&> Pair.getSecond()

Retrieve the second value of the pair

Returns: V2& — Reference to the second value

setFirst¶

1

public inline p Pair.setFirst(const V1& first)

Set the first value of the pair

Parameters

setSecond¶

1

public inline p Pair.setSecond(const V2& second)

Set the second value of the pair

Parameters

Operators¶

operator==¶

1

public f<bool> operator==<V1, V2>(const Pair<V1, V2>& lhs, const Pair<V1, V2>& rhs)

Check if two pairs are equal, i.e. both of their values are equal

Parameters

Returns: bool — Equal or not equal

operator!=¶

1

public f<bool> operator!=<V1, V2>(const Pair<V1, V2>& lhs, const Pair<V1, V2>& rhs)

Check if two pairs are not equal

Parameters

Returns: bool — Not equal or equal