source: branches/lib/HELP_SOURCE/source/pa_mixtree.hlp

Last change on this file was 19532, checked in by westram, 4 months ago
  • reintegrates 'help' into 'trunk'
    • tweak arb documentation:
      • automatically link
        • ticket references to arb bug tracker (only affects html version).
        • found URLs.
      • page titles
        • warn about long titles.
        • introduce SUBTITLEs (automatically triggered by multi-line titles in source files).
        • increase allowed length (limited by subwindow width).
      • cleanup header sections in all helpfiles.
      • fix and/or update several help files.
      • document syntax of help sources.
      • build issues:
        • when xml validation fails, next build no longer uses invalid xml ⇒ keeps failing.
        • remove output files on error (including files below ARBHOME/lib).
        • pipe output through logs to ensure proper wrapping in Entering/Leaving lines.
    • moves Tree admin + NDS menu entries to top of menu
  • adds: log:branches/help@18783:19531
File size: 1.2 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6SUB     pa_optimizer.hlp
7
8# format described in ../help.readme
9
10
11TITLE           Randomize topology
12
13OCCURRENCE      ARB_PARSIMONY/Tree/Tree Optimization/Randomize/Random mix tree
14
15DESCRIPTION     Randomizes the topology of the current tree.
16
17                At each inner branch of the tree, one of the three possible topologies
18                (see LINK{nni.hlp}) is chosen randomly.
19
20                Two parameters are available for mixing:
21
22                    * Repeat count
23                    * Percentage
24
25                The 'Repeat count' defines how often each inner edge in the tree may be randomized.
26                Its default value is initialized at startup using the size of the tree. The value
27                is chosen such that each edge may possibly be moved to any other position in the tree.
28
29                The 'Percentage' defines the probability to randomize an edge.
30
31NOTES           You may already have guessed that this function
32                normally will not optimize your tree :)
33
34                Nevertheless: alternately randomizing and optimizing the tree may lead to
35                better topologies.
36
37EXAMPLES        None
38
39WARNINGS        None
40
41BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.