BEAST v2.7.8 Documentation: starbeast3.operators.BactrianUpDownOperator

Proposes a move in state space.

Like the UpDownOperator, this element represents an operator that scales two (or more) parameters in different directions, but uses a Bactrian proposal distribution for the scale value. 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, gene, kernel, kernelDistribution, weight

 

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

 

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

 

down
type: beast.base.inference.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 achieve 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: 10.0

 

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

 

gene
type: starbeast3.evolution.speciation.GeneTreeForSpeciesTreeDistribution***
list of gene trees that constrain species tree movement
Optional input

 

kernel
type: starbeast3.genekernel.GTKPrior
the kernel of gene trees
Optional input

 

kernelDistribution
type: beast.base.inference.operator.kernel.KernelDistribution
provides sample distribution for proposals
Optional input

 

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