BEAST v2.5.0 Documentation: beast.evolution.operators.UpDownOperator

Proposes a move in state space.
This element represents an operator that scales two parameters in different directions. Each operation involves selecting a scale uniformly at random between scaleFactor and 1/scaleFactor. The up parameter is multiplied by this scale and the down parameter is divided by this scale.

Inputs:

scaleFactor, up, down, optimise, elementWise, upper, lower, weight

 

scaleFactor
type: java.lang.Double
magnitude factor used for scaling
Required input

 

up
type: beast.core.StateNode***
zero or more items to scale upwards
Optional input

 

down
type: beast.core.StateNode***
zero or more items to scale downwards
Optional input

 

optimise
type: java.lang.Boolean
flag to indicate that the scale factor is automatically changed in order to acheive a good acceptance rate (default true)
Optional input. Default: true

 

elementWise
type: java.lang.Boolean
flag to indicate that the scaling is applied to a random index in multivariate parameters (default false)
Optional input. Default: false

 

upper
type: java.lang.Double
Upper Limit of scale factor
Optional input. Default: 1.0

 

lower
type: java.lang.Double
Lower limit of scale factor
Optional input. Default: 0.0

 

weight
type: java.lang.Double
weight with which this operator is selected
Required input