Header menu logo Dicts

Dict Module

Static Functions on IDictionary Interface

Functions and values

Function or value Description

Dict.add key value dic

Full Usage: Dict.add key value dic

Parameters:
    key : 'Key
    value : 'Value
    dic : IDictionary<'Key, 'Value>

Set value at key in a IDictionary just d.[k]<-v

key : 'Key
value : 'Value
dic : IDictionary<'Key, 'Value>

Dict.addIfKeyAbsent key value dic

Full Usage: Dict.addIfKeyAbsent key value dic

Parameters:
    key : 'Key
    value : 'Value
    dic : IDictionary<'Key, 'Value>

Returns: bool

Set value only if key does not exist yet. Returns false if key already exist, does not set value in this case Same as Dict.setIfKeyAbsent key value dic

key : 'Key
value : 'Value
dic : IDictionary<'Key, 'Value>
Returns: bool

Dict.create xs

Full Usage: Dict.create xs

Parameters:
    xs : ('Key * 'Value) seq

Returns: Dict<'Key, 'Value>

Create a Dict from seq of key and value pairs

xs : ('Key * 'Value) seq
Returns: Dict<'Key, 'Value>

Dict.get key dic

Full Usage: Dict.get key dic

Parameters:
Returns: 'Value

Get value at key from IDictionary, with nicer Error messages

key : 'Key
dic : IDictionary<'Key, 'Value>
Returns: 'Value

Dict.getOrSetDefault getDefault key dic

Full Usage: Dict.getOrSetDefault getDefault key dic

Parameters:
    getDefault : 'Key -> 'Value
    key : 'Key
    dic : IDictionary<'Key, 'Value>

Returns: 'Value

If the key ist not present calls the default function, set it as value at the key and return the value. This function is an alternative to the DefaultDict type. Use it if you need to provide a custom implementation of the default function depending on the key.

getDefault : 'Key -> 'Value
key : 'Key
dic : IDictionary<'Key, 'Value>
Returns: 'Value

Dict.getOrSetDefaultValue defaultValue key dic

Full Usage: Dict.getOrSetDefaultValue defaultValue key dic

Parameters:
    defaultValue : 'Value
    key : 'Key
    dic : IDictionary<'Key, 'Value>

Returns: 'Value

If the key ist not present set it as value at the key and return the value.

defaultValue : 'Value
key : 'Key
dic : IDictionary<'Key, 'Value>
Returns: 'Value

Dict.items dic

Full Usage: Dict.items dic

Parameters:
Returns: ('Key * 'Value) seq

Returns a (lazy) sequence of key and value tuples

dic : IDictionary<'Key, 'Value>
Returns: ('Key * 'Value) seq

Dict.iter f dic

Full Usage: Dict.iter f dic

Parameters:
    f : 'Key -> 'Value -> unit
    dic : IDictionary<'Key, 'Value>

Iterate over keys and values of a Dict

f : 'Key -> 'Value -> unit
dic : IDictionary<'Key, 'Value>

Dict.keys dic

Full Usage: Dict.keys dic

Parameters:
Returns: 'Key seq

Returns a (lazy) sequence of Keys

dic : IDictionary<'Key, 'Value>
Returns: 'Key seq

Dict.map f dic

Full Usage: Dict.map f dic

Parameters:
    f : 'Key -> 'Value -> 'T
    dic : IDictionary<'Key, 'Value>

Returns: 'T seq

Map over keys and values of a Dict

f : 'Key -> 'Value -> 'T
dic : IDictionary<'Key, 'Value>
Returns: 'T seq

Dict.memoize f

Full Usage: Dict.memoize f

Parameters:
    f : 'T -> 'U

Returns: 'T -> 'U

Caches the results of a function in a Dictionary. The argument 'T is packed in a wrapper so it can be unit or null(=None) too. (A Dictionary would fail on a null as key )

f : 'T -> 'U
Returns: 'T -> 'U

Dict.pop key dic

Full Usage: Dict.pop key dic

Parameters:
Returns: 'Value

Get a value and remove key and value it from dictionary, like *.pop() in Python. Will fail if key does not exist

key : 'Key
dic : IDictionary<'Key, 'Value>
Returns: 'Value

Dict.set key value dic

Full Usage: Dict.set key value dic

Parameters:
    key : 'Key
    value : 'Value
    dic : IDictionary<'Key, 'Value>

Set value at key in a IDictionary just d.[k]<-v

key : 'Key
value : 'Value
dic : IDictionary<'Key, 'Value>

Dict.setIfKeyAbsent key value dic

Full Usage: Dict.setIfKeyAbsent key value dic

Parameters:
    key : 'Key
    value : 'Value
    dic : IDictionary<'Key, 'Value>

Returns: bool

Set value only if key does not exist yet. Returns false if key already exist, does not set value in this case Same as Dict.addIfKeyAbsent key value dic

key : 'Key
value : 'Value
dic : IDictionary<'Key, 'Value>
Returns: bool

Dict.tryGet k dic

Full Usage: Dict.tryGet k dic

Parameters:
Returns: 'Value option

Tries to get a value from a IDictionary

k : 'Key
dic : IDictionary<'Key, 'Value>
Returns: 'Value option

Dict.tryPop key dic

Full Usage: Dict.tryPop key dic

Parameters:
Returns: 'Value option

Tries to get a value and remove key and value it from dictionary, like *.pop() in Python. Will return None if key does not exist

key : 'Key
dic : IDictionary<'Key, 'Value>
Returns: 'Value option

Dict.values dic

Full Usage: Dict.values dic

Parameters:
Returns: 'Value seq

Returns a (lazy) sequence of values

dic : IDictionary<'Key, 'Value>
Returns: 'Value seq

Type something to start searching.