EndConditions (bristlecone)

EndConditions Module

Namespace: Bristlecone.Optimisation
Assembly: Bristlecone.dll

Functions and values

Function or value	Description
`afterIteration iteration arg2 currentIteration` Full Usage: `afterIteration iteration arg2 currentIteration` Parameters: iteration : `int` arg1 : `Solution<float> list` currentIteration : `int` Returns: `bool`	End the optimisation procedure when a minimum number of iterations is exceeded. iteration : `int` arg1 : `Solution<float> list` currentIteration : `int` Returns: `bool`
`convergence thin chainCount` Full Usage: `convergence thin chainCount` Parameters: thin : `int` chainCount : `int` Returns: `EndCondition<float>`	Convergence of results using the Gelman-Rubin Rhat statistic. `thin` - Only test for convergence at multiples of the following intervals (when all chains are ready). `chainCount` - The number of chains to test for convergence. This makes the agent wait until results for all chains are in. thin : `int` chainCount : `int` Returns: `EndCondition<float>`
`stationarySquaredJumpDistance` Full Usage: `stationarySquaredJumpDistance` Returns: `EndCondition<float>`	True if there is no significant slope in mean squared jumping distances (MSJD), binned per 200 iterations and a regression of five bins. Returns: `EndCondition<float>`
`stationarySquaredJumpDistance' fixedBin pointsRequired results arg4` Full Usage: `stationarySquaredJumpDistance' fixedBin pointsRequired results arg4` Parameters: fixedBin : `int` pointsRequired : `int` results : `Solution<float> list` arg3 : `int` Returns: `bool`	An `EndCondition` that calculates that segregates the most recent n results into five bins, and runs a regression to detect a temporal variation in the mean squared jumping distance (MSJD). The significance of the slope coefficient of a linear regression is assessed to determine if the MSJD is increasing through time for every parameter sequentially: if all p-values are >0.1, then the `EndCondition` is true. fixedBin : `int` pointsRequired : `int` results : `Solution<float> list` arg3 : `int` Returns: `bool`