BEAST v2.7.8 Documentation: beastlabs.core.parameter.NormalisedRealParameter

BEASTObject that performs calculations based on the State.
A node that can be part of the state.
A parameter represents a value in the state space that can be changed by operators.
A real-valued parameter represents a value (or array of values if the dimension is larger than one) in the state space that can be changed by operators.
Constant value that acts as immutable RealParameter where values are normalised

Logable: yes, this can be used in a log.

Inputs:

x, logtransform, meanZeroVarOne, lower, upper, value, dimension, minordimension, keys, estimate

 

x
type: beast.base.core.Function***
values makeng up the parameter
Required input

 

logtransform
type: java.lang.Boolean
log-transform values before normalising
Optional input. Default: false

 

meanZeroVarOne
type: java.lang.Boolean
transform values so that the mean=0 and variance=1. If false, normalise so that sum=1
Optional input. Default: false

 

lower
type: java.lang.Double
lower value for this parameter (default -infinity)
Forbidden: must not be specified

 

upper
type: java.lang.Double
upper value for this parameter (default +infinity)
Forbidden: must not be specified

 

value
type: java.lang.Double***
start value(s) for this parameter. If multiple values are specified, they should be separated by whitespace.
Forbidden: must not be specified

 

dimension
type: java.lang.Integer
dimension of the parameter (default 1, i.e scalar)
Optional input. Default: 1

 

minordimension
type: java.lang.Integer
minor-dimension when the parameter is interpreted as a matrix (default 1)
Optional input. Default: 1

 

keys
type: java.lang.String
the keys (unique dimension names) for the dimensions of this parameter
Optional input

 

estimate
type: java.lang.Boolean
whether to estimate this item or keep constant to its initial value
Optional input. Default: true