Header menu logo Deedle

Ranges<'T> Type

Represents a sub-range of an ordinal index. The range can consist of multiple blocks, i.e. [ 0..9; 20..29 ]. The pairs represent indices of first and last element (inclusively) and we also keep size so that we do not have to recalculate it. For more information, see also the documentation for the `Ranges` module.

Constructors

Constructor Description

Ranges(ranges, ops)

Full Usage: Ranges(ranges, ops)

Parameters:
Returns: Ranges<'T>
ranges : ('T * 'T) seq
ops : IRangeKeyOperations<'T>
Returns: Ranges<'T>

Instance members

Instance member Description

this.FirstKey

Full Usage: this.FirstKey

Returns: 'T

Returns the first key in the range

Returns: 'T

this.KeyAtOffset

Full Usage: this.KeyAtOffset

Parameters:
    offset : int64

Returns: 'T

Returns the key at the specified offset

offset : int64
Returns: 'T

this.Keys

Full Usage: this.Keys

Returns: 'T seq

Returns a lazy sequence containing all keys

Returns: 'T seq

this.LastKey

Full Usage: this.LastKey

Returns: 'T

Returns the last key in the range

Returns: 'T

this.Length

Full Usage: this.Length

Returns: int64

Returns the length of the ranges

Returns: int64

this.Lookup

Full Usage: this.Lookup

Parameters:
    key : 'T
    semantics : Lookup
    check : Func<'T, int64, bool>

Returns: OptionalValue<'T * int64>

Searches for a key in the range (see `Ranges.lookup` for more info)

key : 'T
semantics : Lookup
check : Func<'T, int64, bool>
Returns: OptionalValue<'T * int64>

this.MergeWith

Full Usage: this.MergeWith

Parameters:
Returns: Ranges<'T>

Merge the current range with other specified ranges

ranges : Ranges<'T> seq
Returns: Ranges<'T>

this.OffsetOfKey

Full Usage: this.OffsetOfKey

Parameters:
    key : 'T

Returns: int64

Returns the absolute offset of the key in the ranges

key : 'T
Returns: int64

this.Operations

Full Usage: this.Operations

Returns: IRangeKeyOperations<'T>
Returns: IRangeKeyOperations<'T>

this.Ranges

Full Usage: this.Ranges

Returns: ('T * 'T) array
Returns: ('T * 'T) array

this.Restrict

Full Usage: this.Restrict

Parameters:
Returns: Ranges<'T>

Restricts the ranges according to the specified range restriction

restriction : RangeRestriction<'T>
Returns: Ranges<'T>

Type something to start searching.