Pool (bristlecone) | bristlecone

bristlecone

Parameter.Pool Module

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

Types

Type	Description
AnyOptimiserConfig
AnyParameter
CompiledTransforms<'space>
OptimiserConfig<'space>
ParameterPool

Functions and values

Function or value	Description
`Pool.boxParam name p` Full Usage: `Pool.boxParam name p` Parameters: name : `string` p : `Parameter<'u>` Returns: `AnyParameter`	name : `string` p : `Parameter<'u>` Returns: `AnyParameter`
`Pool.count arg1` Full Usage: `Pool.count arg1` Parameters: arg0 : `ParameterPool` Returns: `int`	arg0 : `ParameterPool` Returns: `int`
`Pool.drawRandom rnd arg2` Full Usage: `Pool.drawRandom rnd arg2` Parameters: rnd : `Random` arg1 : `ParameterPool` Returns: `ParameterPool`	Draw a random set of parameters in real space within their bounds. Assumes a uniform distribution for each draw across all parameters. rnd : `Random` arg1 : `ParameterPool` Returns: `ParameterPool`
`Pool.fromEstimated arg1` Full Usage: `Pool.fromEstimated arg1` Parameters: arg0 : `ParameterPool` Returns: `ParameterPool`	Create a Pool where all parameters are fixed at their current estimate. Lower and upper bounds are both set to the estimate. arg0 : `ParameterPool` Returns: `ParameterPool`
`Pool.fromList xs` Full Usage: `Pool.fromList xs` Parameters: xs : `(ShortCode * AnyParameter) list` Returns: `ParameterPool`	xs : `(ShortCode * AnyParameter) list` Returns: `ParameterPool`
`Pool.fromRealVector realVec arg2` Full Usage: `Pool.fromRealVector realVec arg2` Parameters: realVec : `TypedTensor<Vector, MeasureProduct<parameter, MeasureOne>>` arg1 : `ParameterPool` Returns: `ParameterPool`	Given a real-space parameter vector and an existing pool, return a new pool with each parameter's estimate set to the corresponding value. realVec : `TypedTensor<Vector, MeasureProduct<parameter, MeasureOne>>` arg1 : `ParameterPool` Returns: `ParameterPool`
`Pool.keys arg1` Full Usage: `Pool.keys arg1` Parameters: arg0 : `ParameterPool` Returns: `ShortCode list`	arg0 : `ParameterPool` Returns: `ShortCode list`
`Pool.toList arg1` Full Usage: `Pool.toList arg1` Parameters: arg0 : `ParameterPool` Returns: `(ShortCode * AnyParameter) list`	arg0 : `ParameterPool` Returns: `(ShortCode * AnyParameter) list`
`Pool.toOptimiserConfigBounded pool` Full Usage: `Pool.toOptimiserConfigBounded pool` Parameters: pool : `ParameterPool` Returns: `OptimiserConfig<MeasureProduct<optim-space, MeasureOne>>`	Make a configuration for an optimiser that handles unit transforms to bounded optimisation space. pool : `ParameterPool` Returns: `OptimiserConfig<MeasureProduct<optim-space, MeasureOne>>`
`Pool.toOptimiserConfigTransformed pool` Full Usage: `Pool.toOptimiserConfigTransformed pool` Parameters: pool : `ParameterPool` Returns: `OptimiserConfig<MeasureProduct<optim-space-transformed, MeasureOne>>`	Make a configuration for an optimiser that handles unit transforms to unbounded optimisation space. Transforms are applied where applicable. pool : `ParameterPool` Returns: `OptimiserConfig<MeasureProduct<optim-space-transformed, MeasureOne>>`
`Pool.toTensorWithKeysReal arg1` Full Usage: `Pool.toTensorWithKeysReal arg1` Parameters: arg0 : `ParameterPool` Returns: `ShortCode[] * TypedTensor<Vector, MeasureProduct<parameter, MeasureOne>>`	arg0 : `ParameterPool` Returns: `ShortCode[] * TypedTensor<Vector, MeasureProduct<parameter, MeasureOne>>`
`Pool.tryGetRealValue name arg2` Full Usage: `Pool.tryGetRealValue name arg2` Parameters: name : `string` arg1 : `ParameterPool` Returns: `float<'u> option`	Try to get the real value of a parameter by its ShortCode key. name : `string` arg1 : `ParameterPool` Returns: `float<'u> option`