API / JavaScript / Belt / SortArrayString

SortArrayString

This is a specialized module for Belt.SortArray, the docs in that module also applies here, except the comparator is fixed and inlined.

type element = string;
let strictlySortedLength: array(element) => int;

The same as Belt.SortArray.strictlySortedLength except the comparator is fixed.

Returns +n means increasing order -n means negative order.

let isSorted: array(element) => bool;

sorted(xs) return true if xs is in non strict increasing order.

let stableSortInPlace: array(element) => unit;

The same as Belt.SortArray.stableSortInPlaceBy except the comparator is fixed.

let stableSort: array(element) => array(element);

The same as Belt.SortArray.stableSortBy except the comparator is fixed.

let binarySearch: (array(element), element) => int;

If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value.

If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1)

for example, if key is smaller than all elements return -1 since lnot(-1) = 0 if key is larger than all elements return - (len + 1) since lnot(-(len+1)) = len.