Header menu logo bristlecone

Hypotheses Module

Types to represent a hypothesis, given that a hypothesis
 is a model system that contains some alternate formulations of certain
 components.

Types

Type Description

ComponentName

Represents the name of a swappable component in a model
 and the name of its implementation in a specific case.

Hypothesis

A hypothesis consists of a model system and the names of the
 swappable components within it, alongside the name of their current implementation.

Functions and values

Function or value Description

Hypotheses.compile builder

Full Usage: Hypotheses.compile builder

Parameters:
Returns: Hypothesis list A list of compiled hypotheses for this model system and specified components.

Compiles a suite of competing model hypotheses based on the given components. The compilation includes only the required parameters in each model hypothesis, and combines all labels into a single model identifier.

builder : Writer<ModelBuilder, (ComponentName * CodedMap<Parameter>)> list

A builder started with `createFromComponent`

Returns: Hypothesis list

A list of compiled hypotheses for this model system and specified components.

Hypotheses.createFromComponent (arg1, arg2) builder

Full Usage: Hypotheses.createFromComponent (arg1, arg2) builder

Parameters:
Returns: Writer<'b, (ComponentName * CodedMap<Parameter>)> list A builder to add further components or compile with `Hypothesis.compile`

Implement a component where a model system requires one. A component is a part of a model that may be varied, for example between competing hypotheses.

arg0 : string
arg1 : (string * PluggableComponent<'a>) list
builder : ('a -> ModelExpression) -> 'b

A builder started with `createFromComponent`

Returns: Writer<'b, (ComponentName * CodedMap<Parameter>)> list

A builder to add further components or compile with `Hypothesis.compile`

Hypotheses.useAnother (arg1, arg2) builder

Full Usage: Hypotheses.useAnother (arg1, arg2) builder

Parameters:
Returns: Writer<'b, (ComponentName * CodedMap<Parameter>)> list A builder to add further components or compile with `Hypothesis.compile`

Add a second or further component to a model system where one is still required.

arg0 : string
arg1 : (string * PluggableComponent<'a>) list
builder : Writer<(('a -> ModelExpression) -> 'b), (ComponentName * CodedMap<Parameter>)> list

A builder started with `createFromComponent`

Returns: Writer<'b, (ComponentName * CodedMap<Parameter>)> list

A builder to add further components or compile with `Hypothesis.compile`

Hypotheses.useAnotherWithName (arg1, arg2) builder

Full Usage: Hypotheses.useAnotherWithName (arg1, arg2) builder

Parameters:
Returns: Writer<'b, (ComponentName * CodedMap<Parameter>)> list A builder to add further components or compile with `Hypothesis.compile`

Add a second or further component to a model system where one is still required.

arg0 : string
arg1 : (string * PluggableComponent<'a>) list
builder : Writer<(string * ('a -> ModelExpression) -> 'b), (ComponentName * CodedMap<Parameter>)> list

A builder started with `createFromComponent`

Returns: Writer<'b, (ComponentName * CodedMap<Parameter>)> list

A builder to add further components or compile with `Hypothesis.compile`

Type something to start searching.