BEAST v2.6.7 Documentation: beast.core.util.Sum

BEASTObject that performs calculations based on the State.
calculates sum of a valuable

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

Inputs:

arg, tree, ignoreZeroBranchLengths

 

arg
type: beast.core.Function***
argument to be summed
Required input

 

tree
type: beast.evolution.tree.Tree
the tree corresponding to the function to be summed, indexing by node numbers assumed.
Optional input

 

ignoreZeroBranchLengths
type: java.lang.Boolean
true if quantities in the argument should only be summed for non-zero branch lengths.
Optional input. Default: false