No matching definitions.

← Home

Exported

tur/tuple

stdlib/tuple.tur

typed N-ary tuples (Tuple2..Tuple5).

Since: Phase TP1 (Tuple2); Phase TP2 (Tuple3..Tuple5)

defstruct

Tuple2

(defstruct Tuple2 [A B])

two-element tuple with element types A, B.

Since: Phase TP1

defn

tuple2

(tuple2 [A B])

construct a Tuple2[A B].

Parameters
afirst element (type A)
bsecond element (type B)
Returns

A Tuple2[A B] value.

Example
(tuple2 1 "hi")  ; => Tuple2(1, "hi")

Since: Phase TP1

defn

tuple2-1st

(tuple2-1st [A B])

first element of a Tuple2[A B].

Parameters
tTuple2[A B]
Returns

The first element of type A.

Example
(tuple2-1st (tuple2 10 20))  ; => 10

Since: Phase TP1

defn

tuple2-2nd

(tuple2-2nd [A B])

second element of a Tuple2[A B].

Parameters
tTuple2[A B]
Returns

The second element of type B.

Example
(tuple2-2nd (tuple2 10 20))  ; => 20

Since: Phase TP1

defstruct

Tuple3

(defstruct Tuple3 [A B C])

three-element tuple with element types A, B, C.

Since: Phase TP2

defn

tuple3

(tuple3 [A B C])

construct a Tuple3[A B C].

Parameters
afirst element (type A)
bsecond element (type B)
cthird element (type C)
Returns

A Tuple3[A B C] value.

Example
(tuple3 1 "hi" 3.14)  ; => Tuple3(1, "hi", 3.14)

Since: Phase TP2

defn

tuple3-1st

(tuple3-1st [A B C])

first element of a Tuple3[A B C].

Since: Phase TP2

defn

tuple3-2nd

(tuple3-2nd [A B C])

second element of a Tuple3[A B C].

Since: Phase TP2

defn

tuple3-3rd

(tuple3-3rd [A B C])

third element of a Tuple3[A B C].

Since: Phase TP2

defstruct

Tuple4

(defstruct Tuple4 [A B C D])

four-element tuple with element types A, B, C, D.

Since: Phase TP2

defn

tuple4

(tuple4 [A B C D])

construct a Tuple4[A B C D].

Parameters
afirst element (type A)
bsecond element (type B)
cthird element (type C)
dfourth element (type D)
Returns

A Tuple4[A B C D] value.

Example
(tuple4 1 "hi" 3.14 #t)  ; => Tuple4(1, "hi", 3.14, #t)

Since: Phase TP2

defn

tuple4-1st

(tuple4-1st [A B C D])

first element of a Tuple4[A B C D].

Since: Phase TP2

defn

tuple4-2nd

(tuple4-2nd [A B C D])

second element of a Tuple4[A B C D].

Since: Phase TP2

defn

tuple4-3rd

(tuple4-3rd [A B C D])

third element of a Tuple4[A B C D].

Since: Phase TP2

defn

tuple4-4th

(tuple4-4th [A B C D])

fourth element of a Tuple4[A B C D].

Since: Phase TP2

defstruct

Tuple5

(defstruct Tuple5 [A B C D E])

five-element tuple with element types A, B, C, D, E.

Since: Phase TP2

defn

tuple5

(tuple5 [A B C D E])

construct a Tuple5[A B C D E].

Parameters
afirst element (type A)
bsecond element (type B)
cthird element (type C)
dfourth element (type D)
efifth element (type E)
Returns

A Tuple5[A B C D E] value.

Example
(tuple5 1 "hi" 3.14 #t :ok)  ; => Tuple5(1, "hi", 3.14, #t, :ok)

Since: Phase TP2

defn

tuple5-1st

(tuple5-1st [A B C D E])

first element of a Tuple5[A B C D E].

Since: Phase TP2

defn

tuple5-2nd

(tuple5-2nd [A B C D E])

second element of a Tuple5[A B C D E].

Since: Phase TP2

defn

tuple5-3rd

(tuple5-3rd [A B C D E])

third element of a Tuple5[A B C D E].

Since: Phase TP2

defn

tuple5-4th

(tuple5-4th [A B C D E])

fourth element of a Tuple5[A B C D E].

Since: Phase TP2

defn

tuple5-5th

(tuple5-5th [A B C D E])

fifth element of a Tuple5[A B C D E].

Since: Phase TP2

defmacro

tuple2-eq?

(tuple2-eq? [t1 t2 e1-cmp e2-cmp])

compare two Tuple2 values element-wise using supplied

Parameters
t1first Tuple2[A B]
t2second Tuple2[A B]
e1-cmpcomparator for the first element (fn [a b] :bool)
e2-cmpcomparator for the second element (fn [a b] :bool)
Returns

true if both elements are equal under their comparators.

Example
(tuple2-eq? (tuple2 1 2) (tuple2 1 2)
              (fn [a b] (= a b)) (fn [a b] (= a b)))  ; => true

Since: Phase TP2

defn

tuple2-eq-carrier?

(tuple2-eq-carrier? [t1 :int t2 :int e1-cmp e2-cmp])

legacy carrier-ABI helper used inside Tuple2's Eq

Since: Phase TP2

definstance

Eq[Tuple2]

(definstance Eq [Tuple2])

element-wise equality. At parity with Eq [Pair]: shares

Since: Phase TP2