Language (bristlecone)

Language Module

Namespace: Bristlecone
Assembly: Bristlecone.dll

An F# Domain Specific Language (DSL) for scripting with Bristlecone.

Types and nested modules

Type/Module	Description
Bool	Operations for boolean model expressions.
Components
ExpressionCompiler	Compile model expressions into functions that take changing state as Tensors.
ExpressionDescribe
ExpressionParser
Hypotheses	Types to represent a hypothesis, given that a hypothesis is a model system that contains some alternate formulations of certain components.
Model	Terms for scaffolding a model system for use with Bristlecone.
ModelBuilder	Scaffolds a `ModelSystem` for fitting with Bristlecone.
ModelSystemDsl
Require
Test	Terms for designing tests for model systems.
Untyped
BoolExpression
IncludedParameter<'u>
MeasureId<'u>
ModelExpression<'u>
ParamId<'u>
StateId<'u>

Functions and values

Function or value	Description
`Conditional cond ifTrue ifFalse` Full Usage: `Conditional cond ifTrue ifFalse` Parameters: cond : `BoolExpression` ifTrue : `ModelExpression<'u>` ifFalse : `ModelExpression<'u>` Returns: `ModelExpression<'u>`	For conditional statements, all three branches must have the same unit. cond : `BoolExpression` ifTrue : `ModelExpression<'u>` ifFalse : `ModelExpression<'u>` Returns: `ModelExpression<'u>`
`Constant x` Full Usage: `Constant x` Parameters: x : `float<'u>` Returns: `ModelExpression<'u>`	x : `float<'u>` Returns: `ModelExpression<'u>`
`Environment sid` Full Usage: `Environment sid` Parameters: sid : `StateId<'u>` Returns: `ModelExpression<'u>`	sid : `StateId<'u>` Returns: `ModelExpression<'u>`
`Exponential expr` Full Usage: `Exponential expr` Parameters: expr : `ModelExpression<MeasureOne>` Returns: `ModelExpression<MeasureOne>`	expr : `ModelExpression<MeasureOne>` Returns: `ModelExpression<MeasureOne>`
`Invalid` Full Usage: `Invalid` Returns: `ModelExpression<'u>`	Returns: `ModelExpression<'u>`
`Inverse forwardFn target lo hi` Full Usage: `Inverse forwardFn target lo hi` Parameters: forwardFn : `ModelExpression<'v> -> ModelExpression<'u>` target : `ModelExpression<'u>` lo : `ModelExpression<'v>` hi : `ModelExpression<'v>` Returns: `ModelExpression<'v>`	forwardFn : `ModelExpression<'v> -> ModelExpression<'u>` target : `ModelExpression<'u>` lo : `ModelExpression<'v>` hi : `ModelExpression<'v>` Returns: `ModelExpression<'v>`
`Label label expr` Full Usage: `Label label expr` Parameters: label : `string` expr : `ModelExpression<'u>` Returns: `ModelExpression<'u>`	label : `string` expr : `ModelExpression<'u>` Returns: `ModelExpression<'u>`
`Logarithm expr` Full Usage: `Logarithm expr` Parameters: expr : `ModelExpression<MeasureOne>` Returns: `ModelExpression<MeasureOne>`	expr : `ModelExpression<MeasureOne>` Returns: `ModelExpression<MeasureOne>`
`Measure sId` Full Usage: `Measure sId` Parameters: sId : `MeasureId<'u>` Returns: `ModelExpression<'u>`	sId : `MeasureId<'u>` Returns: `ModelExpression<'u>`
`P name` Full Usage: `P name` Parameters: name : `IncludedParameter<'u>` Returns: `ModelExpression<'u>`	name : `IncludedParameter<'u>` Returns: `ModelExpression<'u>`
`Power baseExpr expExpr` Full Usage: `Power baseExpr expExpr` Parameters: baseExpr : `ModelExpression<'u>` expExpr : `ModelExpression<MeasureOne>` Returns: `ModelExpression<'u>`	baseExpr : `ModelExpression<'u>` expExpr : `ModelExpression<MeasureOne>` Returns: `ModelExpression<'u>`
`State sId` Full Usage: `State sId` Parameters: sId : `StateId<'u>` Returns: `ModelExpression<'u>`	sId : `StateId<'u>` Returns: `ModelExpression<'u>`
`StateAt (offset, sId)` Full Usage: `StateAt (offset, sId)` Parameters: offset : `int<MeasureProduct<time index, MeasureOne>>` sId : `StateId<'u>` Returns: `ModelExpression<'u>`	offset : `int<MeasureProduct<time index, MeasureOne>>` sId : `StateId<'u>` Returns: `ModelExpression<'u>`
`This` Full Usage: `This` Returns: `ModelExpression<'u>`	Returns: `ModelExpression<'u>`
`Time` Full Usage: `Time` Returns: `ModelExpression<'t>`	Returns: `ModelExpression<'t>`
`code` Full Usage: `code` Returns: `string -> ShortCode option`	A short code representation of an identifier for a parameter, model equation, or other model component. Returns: `string -> ShortCode option`
`compute x t pool environment ex` Full Usage: `compute x t pool environment ex` Parameters: x : `float` t : `float<MeasureProduct<time index, MeasureOne>>` pool : `ParameterPool` environment : `CodedMap<float>` ex : `ModelExpression<'u>` Returns: `float`	Computes a `ModelExpression` given the current time, value, environment, and parameter pool. x : `float` t : `float<MeasureProduct<time index, MeasureOne>>` pool : `ParameterPool` environment : `CodedMap<float>` ex : `ModelExpression<'u>` Returns: `float`
`computeT x t pool environment ex` Full Usage: `computeT x t pool environment ex` Parameters: x : `TypedTensor<Scalar, MeasureProduct<state, MeasureOne>>` t : `TypedTensor<Scalar, 'u>` pool : `ParameterPool` environment : `CodedMap<TypedTensor<Scalar, MeasureProduct<environment, MeasureOne>>>` ex : `ModelExpression<'v>` Returns: `TypedTensor<Scalar, MeasureProduct<MeasureInverse<'u>, MeasureProduct<state, MeasureOne>>>`	x : `TypedTensor<Scalar, MeasureProduct<state, MeasureOne>>` t : `TypedTensor<Scalar, 'u>` pool : `ParameterPool` environment : `CodedMap<TypedTensor<Scalar, MeasureProduct<environment, MeasureOne>>>` ex : `ModelExpression<'v>` Returns: `TypedTensor<Scalar, MeasureProduct<MeasureInverse<'u>, MeasureProduct<state, MeasureOne>>>`
`continuousModel` Full Usage: `continuousModel` Returns: `ModelSystemBuilder<'time>`	Returns: `ModelSystemBuilder<'time>`
`days n` Full Usage: `days n` Parameters: n : `int<MeasureProduct<day, MeasureOne>>` Returns: `FixedTemporalResolution<'a>`	n : `int<MeasureProduct<day, MeasureOne>>` Returns: `FixedTemporalResolution<'a>`
`discreteModel` Full Usage: `discreteModel` Returns: `ModelSystemBuilder<'time>`	Returns: `ModelSystemBuilder<'time>`
`environment name` Full Usage: `environment name` Parameters: name : `string` Returns: `StateId<'u>`	name : `string` Returns: `StateId<'u>`
`lookup name map` Full Usage: `lookup name map` Parameters: name : `string` map : `CodedMap<float>` Returns: `float`	name : `string` map : `CodedMap<float>` Returns: `float`
`measure name` Full Usage: `measure name` Parameters: name : `string` Returns: `MeasureId<'u>`	name : `string` Returns: `MeasureId<'u>`
`months n` Full Usage: `months n` Parameters: n : `int<MeasureProduct<month, MeasureOne>>` Returns: `FixedTemporalResolution<'a>`	n : `int<MeasureProduct<month, MeasureOne>>` Returns: `FixedTemporalResolution<'a>`
`noConstraints` Full Usage: `noConstraints` Returns: `Constraint`	Returns: `Constraint`
`notNegative` Full Usage: `notNegative` Returns: `Constraint`	Returns: `Constraint`
`parameter code con lower upper` Full Usage: `parameter code con lower upper` Parameters: code : `string` con : `Constraint` lower : `float<'u>` upper : `float<'u>` Returns: `IncludedParameter<'u>`	Define an estimatable parameter for a Bristlecone model. code : `string` con : `Constraint` lower : `float<'u>` upper : `float<'u>` Returns: `IncludedParameter<'u>`
`state name` Full Usage: `state name` Parameters: name : `string` Returns: `StateId<'u>`	name : `string` Returns: `StateId<'u>`
`years n` Full Usage: `years n` Parameters: n : `int<MeasureProduct<year, MeasureOne>>` Returns: `FixedTemporalResolution<'a>`	n : `int<MeasureProduct<year, MeasureOne>>` Returns: `FixedTemporalResolution<'a>`