Parameter (bristlecone) | bristlecone

bristlecone

Parameter Module

Namespace: Bristlecone
Assembly: Bristlecone.dll

Types and nested modules

Type/Module	Description
Pool (Module)	Contains the `ParameterPool` type, which represents the set of parameters to be estimated within an analysis.
Constraint	Limits a `Parameter` to certain value ranges by applying mathematical transformations when requested for 'optimisation space'.
ConstraintMode	The mode in which constraints are handled by the parameter. In `Transform` mode, the parameter value is transformed when requested in 'optimisation space'. Alternatively, in `Detached` mode, the real parameter value is simply returned when requested in 'optimisation space'.
Estimation
Parameter
Pool (Type)

Functions and values

Function or value	Description
`Parameter.bounds p` Full Usage: `Parameter.bounds p` Parameters: p : `Parameter` Returns: `(float * float) option`	Bounds are always stored in a parameter in raw form. p : `Parameter` Returns: `(float * float) option`
`Parameter.create con bound1 bound2` Full Usage: `Parameter.create con bound1 bound2` Parameters: con : `Constraint` bound1 : `float` bound2 : `float` Returns: `Parameter option`	Create an estimatable `Parameter` that may be constrained or unconstrained to a certain value range. Bristlecone draws an initial value from the given bounds. To retrieve the estimated parameter value, use `Parameter.finalise`. con : `Constraint` bound1 : `float` bound2 : `float` Returns: `Parameter option`
`Parameter.detatchConstraint p` Full Usage: `Parameter.detatchConstraint p` Parameters: p : `Parameter` Returns: `Parameter * Constraint`	Detaches any constraints such that the parameter's transformed space equals normal space. p : `Parameter` Returns: `Parameter * Constraint`
`Parameter.getEstimate parameter` Full Usage: `Parameter.getEstimate parameter` Parameters: parameter : `Parameter` Returns: `Result<float, string>`	Retrieve the estimated parameter value for further analysis. Will only be `Ok` if parameter has been estimated. parameter : `Parameter` Returns: `Result<float, string>`
`Parameter.isEstimated parameter` Full Usage: `Parameter.isEstimated parameter` Parameters: parameter : `Parameter` Returns: `bool`	Determines if the parameter has been estimated or not. parameter : `Parameter` Returns: `bool`