IndexRange.getIndicesFor | /core/mod.ts | rimbu@1.1.0

Module

x/rimbu/core/mod.ts>IndexRange.getIndicesFor

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and other tools.

rimbu-org/rimbu

Go to Latest

main menu

mod.ts (default module)

ArrowValuedGraphHashed

ArrowValuedGraphSorted

EdgeValuedGraphHashed

EdgeValuedGraphSorted

HashMultiMapHashValue

HashMultiMapSortedValue

HashMultiSet

HashSet

HashTableHashColumn

HashTableSortedColumn

SortedMultiMapHashValue

SortedMultiMapSortedValue

SortedMultiSet

SortedSet

SortedTableHashColumn

SortedTableSortedColumn

function IndexRange.getIndicesFor

import { IndexRange } from "https://deno.land/x/rimbu@1.1.0/core/mod.ts";
const { getIndicesFor } = IndexRange;

getIndicesFor(range: IndexRange, length: number): [number, number] | "empty" | "all"

Returns, given the range IndexRange, and a target maximum length, the actual index range. This can be one of three options:

'empty': there are no elements within the range
'all': all elements are within the range
[start: number, end: number]: an inclusive range of element indices within the given range

Parameters

range: IndexRange

the IndexRange to use

length: number

the target maximum length

Returns

[number, number] | "empty" | "all"