Description
Flag an enabled contraction only for an exactly zero-length branch.
Evolutionary summaries depend on sampled sequences/populations, reference states, ploidy, time units and stochastic assumptions. A mixture expectation differs from a drift simulation, and a callable-allele denominator differs from an individual count. Labels and local tree conditions do not reconstruct ancestry or establish a biological mechanism.
Flag an enabled contraction only for an exactly zero-length branch.
When to use this tool
Use Phylogeny Zero Branch Contraction Flag when checking the stated evolutionary record, reference, expectation or scale convention.
How to use the tool and how it works
- Enter branchLength, contractionEnabled. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read contractBranch. Inspect contractBranch before interpreting the associated values.
Require branchLength>=0. contractBranch is true only when contractionEnabled and branchLength==0 exactly.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| branchLength | Branch Length | Required. Finite number; minimum 0. |
| contractionEnabled | Contraction Enabled | Required. Boolean. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| contractBranch | Exact zero branch length plus enabled flag; no tolerance or actual tree edit. | Required. Boolean. |
{
"input": {
"branchLength": 0,
"contractionEnabled": true
},
"output": {
"contractBranch": true
}
} Limitations and assumptions
- No tolerance or tree topology is inspected and no branch is actually contracted; zero length need not settle biological resolution.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
- Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.
Alternative or Complementary methods
Use verified samples/references and appropriate complete phylogenetic, population-genetic or statistical models for actual biological inference and uncertainty.
References
Similar or alternative tools
- Out Group Root Side Flag
Check which disjoint candidate root side contains all supplied outgroup tips.
- Phylogeny Path Branch Sum Tool
Sum an explicitly supplied tree path’s branch lengths without inferring topology.