Angara.Statistics


Parameters

Namespace: Angara
Parent Module: Filzbach

A container for model parameters.

Instance members

Instance memberDescription
Add(...)
Signature: (name:string * lb:float * ub:float * val:float * type:int * fixed:int * dsply:int * number:int option) -> Parameters

Add a parameter. This signature is compatible with parameter_create and parameter_create_vector functions described in Filzbach User Guide. The dsply argument is not used here.

Add(name, values, prior)
Signature: (name:string * values:float [] * prior:Distribution) -> Parameters

Add a parameter with a prior and starting values

Add(name, prior, size)
Signature: (name:string * prior:Distribution * size:int option) -> Parameters

Add a parameter with a prior

Add(name, values)
Signature: (name:string * values:float []) -> Parameters

Add a fixed vector parameter.

Add(name, value)
Signature: (name:string * value:float) -> Parameters

Add a fixed scalar parameter.

Add(...)
Signature: (name:string * values:float [] * lower:float * upper:float * delay:int option * isLog:bool option * prior:Distribution option) -> Parameters

Adds a parameter to the container.

AllValues
Signature: seq<float>

Get all values of all parameters. For a parameter "p" the parameter values are at index x.GetDefinition("p").index in the values array.

CompiledName: get_AllValues

CountValues
Signature: int

Total number of all parameter values.

CompiledName: get_CountValues

GetDefinition(name)
Signature: name:string -> ParameterDefinition

Get a parameter definition.

GetName(idx)
Signature: idx:int -> string

Get a parameter name by value index.

GetValue(name, idx)
Signature: (name:string * idx:int) -> float

Get a value of a vector parameter.

GetValue(name)
Signature: name:string -> float

Get a value of a scalar parameter.

GetValue(idx)
Signature: idx:int -> float

Fast access to parameter values. See for explanation of indices.

GetValues(name)
Signature: name:string -> float []

Get an array of all values of a parameter.

SetValues(values)
Signature: (values:float []) -> Parameters

Replaces all parameter values. For a parameter "p" the parameter values are at index x.GetDefinition("p").index in the values array.

Static members

Static memberDescription
Empty
Signature: Parameters

CompiledName: get_Empty

Fork me on GitHub