Pool (bristlecone) | bristlecone

bristlecone

Parameter.Pool Module

Namespace: Bristlecone
Assembly: Bristlecone.dll
Parent Module: Parameter

Contains the `ParameterPool` type, which represents the set of parameters to be estimated within an analysis.

Types

Type	Description
ParameterPool

Functions and values

Function or value	Description
`Pool.count pool` Full Usage: `Pool.count pool` Parameters: pool : `ParameterPool` Returns: `int`	The number of parameters in the Pool. pool : `ParameterPool` Returns: `int`
`Pool.detatchConstraints pool` Full Usage: `Pool.detatchConstraints pool` Parameters: pool : `ParameterPool` Returns: `ParameterPool * Constraint list`	Flips all parameters in the pool to work in `Detached` mode rather than `Transformed` mode. pool : `ParameterPool` Returns: `ParameterPool * Constraint list`
`Pool.fromEstimated pool` Full Usage: `Pool.fromEstimated pool` Parameters: pool : `ParameterPool` Returns: `ParameterPool`	Create a Pool where all parameters are not estimated. The upper and lower bounds are set as the estimate from `pool`. pool : `ParameterPool` Returns: `ParameterPool`
`Pool.fromList list` Full Usage: `Pool.fromList list` Parameters: list : `(ShortCode * Parameter) list` Returns: `ParameterPool`	list : `(ShortCode * Parameter) list` Returns: `ParameterPool`
`Pool.hasParameter name pool` Full Usage: `Pool.hasParameter name pool` Parameters: name : `string` pool : `ParameterPool` Returns: `Parameter option`	name : `string` pool : `ParameterPool` Returns: `Parameter option`
`Pool.map f pool` Full Usage: `Pool.map f pool` Parameters: f : `ShortCode -> Parameter -> Parameter` pool : `ParameterPool` Returns: `ParameterPool`	f : `ShortCode -> Parameter -> Parameter` pool : `ParameterPool` Returns: `ParameterPool`
`Pool.toList pool` Full Usage: `Pool.toList pool` Parameters: pool : `ParameterPool` Returns: `(ShortCode * Parameter) list`	pool : `ParameterPool` Returns: `(ShortCode * Parameter) list`
`Pool.tryGetBoundsForEstimation pool key` Full Usage: `Pool.tryGetBoundsForEstimation pool key` Parameters: pool : `ParameterPool` key : `string` Returns: `(float * float) option`	Returns the starting bounds in transformed parameter space if the parameter has not been estimated. If the parameter has already been estimated, returns None. pool : `ParameterPool` key : `string` Returns: `(float * float) option`