Logo Deedle

MultiKeyExtensions Module

F#-friendly functions for creating multi-level keys and lookups

Functions and values

Function or value Description

Lookup1Of2 k

Full Usage: Lookup1Of2 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the first element of a two-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

Lookup1Of3 k

Full Usage: Lookup1Of3 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the first element of a three-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

Lookup1Of4 k

Full Usage: Lookup1Of4 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the first element of a four-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

Lookup2Of2 k

Full Usage: Lookup2Of2 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the second element of a two-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

Lookup2Of3 k

Full Usage: Lookup2Of3 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the second element of a three-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

Lookup2Of4 k

Full Usage: Lookup2Of4 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the second element of a four-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

Lookup3Of3 k

Full Usage: Lookup3Of3 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the third element of a three-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

Lookup3Of4 k

Full Usage: Lookup3Of4 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the third element of a four-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

Lookup4Of4 k

Full Usage: Lookup4Of4 k

Parameters:
    k : 'a

Returns: ICustomLookup<'b>
Type parameters: 'a, 'b

Creates a hierarchical key lookup that allows matching on the fourth element of a four-level hierarchical key.

k : 'a
Returns: ICustomLookup<'b>

LookupAnyOf2 k1 k2

Full Usage: LookupAnyOf2 k1 k2

Parameters:
    k1 : 'a option
    k2 : 'b option

Returns: ICustomLookup<'c>
Type parameters: 'a, 'b, 'c

Creates an arbitrary lookup key that allows matching on elements of a two-level hierarchical index. Specify `None` to ignore a level or `Some k` to require match on a given level.

k1 : 'a option
k2 : 'b option
Returns: ICustomLookup<'c>

LookupAnyOf3 k1 k2 k3

Full Usage: LookupAnyOf3 k1 k2 k3

Parameters:
    k1 : 'a option
    k2 : 'b option
    k3 : 'c option

Returns: ICustomLookup<'d>
Type parameters: 'a, 'b, 'c, 'd

Creates an arbitrary lookup key that allows matching on elements of a three-level hierarchical index. Specify `None` to ignore a level or `Some k` to require match on a given level.

k1 : 'a option
k2 : 'b option
k3 : 'c option
Returns: ICustomLookup<'d>

LookupAnyOf4 k1 k2 k3 k4

Full Usage: LookupAnyOf4 k1 k2 k3 k4

Parameters:
    k1 : 'a option
    k2 : 'b option
    k3 : 'c option
    k4 : 'd option

Returns: ICustomLookup<'e>
Type parameters: 'a, 'b, 'c, 'd, 'e

Creates an arbitrary lookup key that allows matching on elements of a four-level hierarchical index. Specify `None` to ignore a level or `Some k` to require match on a given level.

k1 : 'a option
k2 : 'b option
k3 : 'c option
k4 : 'd option
Returns: ICustomLookup<'e>

Type something to start searching.