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
ComputableFragment	Allows common F# functions to use Bristlecone model expressions.
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.
Test	Terms for designing tests for model systems.
Writer
ArbitraryRequirement
ModelExpression	A model or model fragment that can be interpreted to a mathematical expression by Bristlecone.
PluggableComponent<'a>

Functions and values

Function or value	Description
`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` pool : `Pool` environment : `CodedMap<float>` ex : `ModelExpression` Returns: `float`	Computes a `ModelExpression` given the current time, value, environment, and parameter pool. x : `float` t : `float` pool : `Pool` environment : `CodedMap<float>` ex : `ModelExpression` Returns: `float`
`days n` Full Usage: `days n` Parameters: n : `int` Returns: `FixedTemporalResolution`	n : `int` Returns: `FixedTemporalResolution`
`estimateParameter name constraintMode lower upper (arg5, arg6)` Full Usage: `estimateParameter name constraintMode lower upper (arg5, arg6)` Parameters: name : `string` constraintMode : `Constraint` lower : `float` upper : `float` arg4 : `'a` arg5 : `PluggableComponent<'b>` Returns: `'a * PluggableComponent<'b>`	name : `string` constraintMode : `Constraint` lower : `float` upper : `float` arg4 : `'a` arg5 : `PluggableComponent<'b>` Returns: `'a * PluggableComponent<'b>`
`lookup name map` Full Usage: `lookup name map` Parameters: name : `string` map : `CodedMap<float>` Returns: `float`	name : `string` map : `CodedMap<float>` Returns: `float`
`modelComponent name list` Full Usage: `modelComponent name list` Parameters: name : `'a` list : `'b` Returns: `'a * 'b`	name : `'a` list : `'b` Returns: `'a * 'b`
`months n` Full Usage: `months n` Parameters: n : `int` Returns: `FixedTemporalResolution`	n : `int` Returns: `FixedTemporalResolution`
`noConstraints` Full Usage: `noConstraints` Returns: `Constraint`	Returns: `Constraint`
`notNegative` Full Usage: `notNegative` Returns: `Constraint`	Returns: `Constraint`
`parameter` Full Usage: `parameter` Returns: `Constraint -> float -> float -> Parameter option`	Define an estimatable parameter for a Bristlecone model. Returns: `Constraint -> float -> float -> Parameter option`
`subComponent name expression` Full Usage: `subComponent name expression` Parameters: name : `'a` expression : `'b -> ModelExpression` Returns: `'a * PluggableComponent<'b>`	Creates a nested component that can be inserted into a base model. name : `'a` expression : `'b -> ModelExpression` Returns: `'a * PluggableComponent<'b>`
`years n` Full Usage: `years n` Parameters: n : `int` Returns: `FixedTemporalResolution`	n : `int` Returns: `FixedTemporalResolution`

Active patterns

Active pattern Description

Active pattern	Description
`(\|NotEmptyList\|_\|) list` Full Usage: `(\|NotEmptyList\|_\|) list` Parameters: list : `'a list` Returns: `'a list option`	list : `'a list` Returns: `'a list option`


                
                  
                    
                      (|NotEmptyList|_|) list

Full Usage: (|NotEmptyList|_|) list

Parameters:

list : 'a list

Returns: 'a list option

list : 'a list

Returns: 'a list option