Header menu logo Nu

Gen.Gen Type

Generates engine-specific values on-demand.

Static members

Static member Description

Gen.id

Full Usage: Gen.id

Returns: Guid

Generate a unique id. Thread-safe.

Returns: Guid

Gen.id32

Full Usage: Gen.id32

Returns: uint32

Generate a unique non-zero 32-bit id. Thread-safe.

Returns: uint32

Gen.id64

Full Usage: Gen.id64

Returns: uint64

Generate a unique non-zero 64-bit id. Thread-safe.

Returns: uint64

Gen.id64AndNameIf nameOpt

Full Usage: Gen.id64AndNameIf nameOpt

Parameters:
    nameOpt : string option

Returns: uint64 * string

Derive a unique id and name if given none. Thread-safe.

nameOpt : string option
Returns: uint64 * string

Gen.id64AndSurnamesIf surnamesOpt

Full Usage: Gen.id64AndSurnamesIf surnamesOpt

Parameters:
    surnamesOpt : string array option

Returns: uint64 * string array

Derive a unique id and surnames if given none. Thread-safe.

surnamesOpt : string array option
Returns: uint64 * string array

Gen.idFromInts m n

Full Usage: Gen.idFromInts m n

Parameters:
    m : int
    n : int

Returns: Guid

Generate an id from a couple of ints. It is the user's responsibility to ensure uniqueness when using the resulting ids. Thread-safe.

m : int
n : int
Returns: Guid

Gen.isNameGenerated name

Full Usage: Gen.isNameGenerated name

Parameters:
    name : string

Returns: bool

Check that a name is generated from a 64-bit id. Thread-safe.

name : string
Returns: bool

Gen.name

Full Usage: Gen.name

Returns: string

Generate a unique name based on a 64-bit id. Thread-safe.

Returns: string

Gen.nameForEditor dispatcherName

Full Usage: Gen.nameForEditor dispatcherName

Parameters:
    dispatcherName : string

Returns: string

Generate a unique name for use in an editor. Thread-safe.

dispatcherName : string
Returns: string

Gen.random

Full Usage: Gen.random

Returns: int

Get the next random number integer. Thread-safe.

Returns: int

Gen.random1 ceiling

Full Usage: Gen.random1 ceiling

Parameters:
    ceiling : int

Returns: int

Get the next random number integer below ceiling. Thread-safe.

ceiling : int
Returns: int

Gen.random2 minValue ceiling

Full Usage: Gen.random2 minValue ceiling

Parameters:
    minValue : int
    ceiling : int

Returns: int

Get the next random number integer GTE minValue and LT ceiling. Thread-safe.

minValue : int
ceiling : int
Returns: int

Gen.randomItem seq

Full Usage: Gen.randomItem seq

Parameters:
    seq : 'a seq

Returns: 'a

Get a random element from a sequence, throwing if the sequence is empty. Thread-safe.

seq : 'a seq
Returns: 'a

Gen.randomItemOpt seq

Full Usage: Gen.randomItemOpt seq

Parameters:
    seq : 'a seq

Returns: 'a option

Get a random element from a sequence if there are any elements or None. If seq is large, this may allocate to the LOH. Thread-safe.

seq : 'a seq
Returns: 'a option

Gen.randomItemOrDefault default_ seq

Full Usage: Gen.randomItemOrDefault default_ seq

Parameters:
    default_ : 'a
    seq : 'a seq

Returns: 'a

Get a random element from a sequence or a default if sequence is empty. Thread-safe.

default_ : 'a
seq : 'a seq
Returns: 'a

Gen.randomKeyOpt dict

Full Usage: Gen.randomKeyOpt dict

Parameters:
Returns: 'k option

Get a random key if there are any or None. Thread-safe.

dict : IDictionary<'k, 'v>
Returns: 'k option

Gen.randomValueOpt dict

Full Usage: Gen.randomValueOpt dict

Parameters:
Returns: 'v option

Get a random value if there are any or None. Thread-safe.

dict : IDictionary<'k, 'v>
Returns: 'v option

Gen.randomb

Full Usage: Gen.randomb

Returns: bool

Get the next random boolean. Thread-safe.

Returns: bool

Gen.randomd

Full Usage: Gen.randomd

Returns: float

Get the next random double >= 0.0 and < 1.0. Thread-safe.

Returns: float

Gen.randomd1 ceiling

Full Usage: Gen.randomd1 ceiling

Parameters:
    ceiling : float

Returns: float

Get the next random number single below ceiling. Thread-safe.

ceiling : float
Returns: float

Gen.randomf

Full Usage: Gen.randomf

Returns: single

Get the next random single >= 0.0f and < 1.0f. Thread-safe.

Returns: single

Gen.randomf1 ceiling

Full Usage: Gen.randomf1 ceiling

Parameters:
    ceiling : single

Returns: single

Get the next random number single below ceiling. Thread-safe.

ceiling : single
Returns: single

Gen.randomize seq

Full Usage: Gen.randomize seq

Parameters:
    seq : 'a seq

Returns: 'a seq

Randomly shuffle a sequence. If seq is large, this may allocate to the LOH and block other threads. Thread-safe.

seq : 'a seq
Returns: 'a seq

Gen.randoml

Full Usage: Gen.randoml

Returns: int64

Get the next random long. Thread-safe.

Returns: int64

Gen.randomu

Full Usage: Gen.randomu

Returns: uint

Get the next random unsigned. Thread-safe.

Returns: uint

Gen.randomul

Full Usage: Gen.randomul

Returns: uint64

Get the next random unsigned long. Thread-safe.

Returns: uint64

Gen.randomy

Full Usage: Gen.randomy

Returns: byte

Get the next random byte. Thread-safe.

Returns: byte

Gen.randomy1 ceiling

Full Usage: Gen.randomy1 ceiling

Parameters:
    ceiling : byte

Returns: byte

Get the next random number single below ceiling. Thread-safe.

ceiling : byte
Returns: byte

Type something to start searching.