Module tql_compare

Data Types
Function Index
Function Details

Data Types

comparator()

comparator(T) = fun((T, T) -> boolean())

order()

order() = ascending | descending

Function Index

by/1	Equivalent to `by(F, ascending)`.
by/2	Creates a comparison function (`comparator(A)`) compatible with `lists:sort/2`, using the extracted term to sort in the given direction.
by_prop/1	Equivalent to `by_prop(Key, ascending)`.
by_prop/2	Creates a comparator for maps, sorting by a given property, in the given direction.
by_prop/3	Creates a comparator for maps, sorting by the given property and using the `Default` as fallback value, to sort in the provided direction.
concat/1	Composes multiple comparators together.
reverse/1	Reverses the order in which elements are sorted by a comparator.

Function Details

by/1

by(F::fun((A) -> B)) -> comparator(A)

A = term()
B = term()

Equivalent to by(F, ascending).

by/2

by(Extractor::fun((A) -> B), X2::order()) -> comparator(A)

A = term()
B = term()

Creates a comparison function (comparator(A)) compatible with lists:sort/2, using the extracted term to sort in the given direction.

by_prop/1

by_prop(Key::term()) -> comparator(map())

Equivalent to by_prop(Key, ascending).

by_prop/2

by_prop(Key::term(), Order::order()) -> comparator(map())

Creates a comparator for maps, sorting by a given property, in the given direction.

by_prop/3

by_prop(Key, Default, Order::order()) -> comparator(map())

Key = term()
Default = term()

Creates a comparator for maps, sorting by the given property and using the Default as fallback value, to sort in the provided direction.

concat/1

concat(Comparators::[Comp, ...]) -> Comp

Comp = comparator(T::term())

Composes multiple comparators together.

Fallthrough happens when 2 items are considered equivalent _according to the comparators_. Specifically, this means when

Compare(A, B) ==
  Compare(B, A)

.

reverse/1

reverse(Comparator::comparator(T)) -> comparator(T)

T = term()

Reverses the order in which elements are sorted by a comparator.

Generated by EDoc