[Bio] / FigKernelPackages / gjonewicklib.pm Repository:
ViewVC logotype

Annotation of /FigKernelPackages/gjonewicklib.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.22 - (view) (download) (as text)

1 : olson 1.17 # This is a SAS component.
2 :    
3 : olson 1.2 #
4 : golsen 1.20 # Copyright (c) 2003-2010 University of Chicago and Fellowship
5 : olson 1.2 # for Interpretations of Genomes. All Rights Reserved.
6 :     #
7 :     # This file is part of the SEED Toolkit.
8 : golsen 1.9 #
9 : olson 1.2 # The SEED Toolkit is free software. You can redistribute
10 :     # it and/or modify it under the terms of the SEED Toolkit
11 : golsen 1.9 # Public License.
12 : olson 1.2 #
13 :     # You should have received a copy of the SEED Toolkit Public License
14 :     # along with this program; if not write to the University of Chicago
15 :     # at info@ci.uchicago.edu or the Fellowship for Interpretation of
16 :     # Genomes at veronika@thefig.info or download a copy from
17 :     # http://www.theseed.org/LICENSE.TXT.
18 :     #
19 :    
20 : golsen 1.1 package gjonewicklib;
21 :    
22 :     #===============================================================================
23 :     # perl functions for dealing with trees
24 :     #
25 :     # Usage:
26 :     # use gjonewicklib
27 :     #
28 :     #
29 :     #===============================================================================
30 :     # Tree data structures:
31 :     #===============================================================================
32 :     #
33 :     # Elements in newick text file are:
34 :     #
35 :     # [c1] ( desc_1, desc_2, ... ) [c2] label [c3] : [c4] x [c5]
36 :     #
37 :     # Note that:
38 : golsen 1.9 #
39 : golsen 1.1 # Comment list 1 can exist on any subtree, but its association with
40 :     # tree components can be upset by rerooting
41 :     # Comment list 2 cannot exist without a descendant list
42 :     # Comment list 3 cannot exist without a label
43 :     # Comment lists 4 and 5 cannot exist without a branch length
44 :     #
45 :     # Elements in perl representation are:
46 :     #
47 :     # $tree = \@rootnode;
48 :     #
49 : overbeek 1.7 # $node = [ \@desc, # reference to list of descendants
50 : golsen 1.1 # $label, # node label
51 :     # $x, # branch length
52 :     # \@c1, # reference to comment list 1
53 :     # \@c2, # reference to comment list 2
54 :     # \@c3, # reference to comment list 3
55 :     # \@c4, # reference to comment list 4
56 :     # \@c5 # reference to comment list 5
57 : overbeek 1.7 # ]
58 : golsen 1.1 #
59 :     # At present, no routine tests or enforces the length of the list (a single
60 :     # element list could be a valid internal node).
61 :     #
62 :     # All empty lists can be [] or undef
63 :     #
64 :     # Putting the comments at the end allows a shorter list nearly all the
65 :     # time, but is different from the prolog representation.
66 :     #
67 :     #
68 : overbeek 1.7 # Ross Overbeek has a different tree node structure:
69 :     #
70 :     # $node = [ Label,
71 :     # DistanceToParent,
72 :     # [ ParentPointer, ChildPointer1, ... ],
73 :     # [ Name1\tVal1, Name2\tVal2, ... ]
74 :     # ]
75 :     #
76 :     # So:
77 :     #
78 :     #===============================================================================
79 :     # Tree format interconversion:
80 :     #===============================================================================
81 :     #
82 : golsen 1.9 # $bool = is_overbeek_tree( $tree )
83 :     # $bool = is_gjonewick_tree( $tree )
84 :     #
85 : overbeek 1.7 # $gjonewick = overbeek_to_gjonewick( $overbeek )
86 :     # $overbeek = gjonewick_to_overbeek( $gjonewick )
87 :     #
88 : golsen 1.1 #===============================================================================
89 :     # Tree data extraction:
90 :     #===============================================================================
91 :     #
92 :     # $listref = newick_desc_ref( $noderef )
93 :     # $label = newick_lbl( $noderef )
94 :     # $x = newick_x( $noderef )
95 :     # $listref = newick_c1( $noderef )
96 :     # $listref = newick_c2( $noderef )
97 :     # $listref = newick_c3( $noderef )
98 :     # $listref = newick_c4( $noderef )
99 :     # $listref = newick_c5( $noderef )
100 :     #
101 :     # @desclist = newick_desc_list( $noderef )
102 :     # $n = newick_n_desc( $noderef )
103 :     # $descref = newick_desc_i( $noderef, $i ) # 1-based numbering
104 :     # $bool = newick_is_tip( $noderef )
105 :     #
106 :     # set_newick_desc_ref( $noderef, $listref )
107 :     # set_newick_lbl( $noderef, $label )
108 :     # set_newick_x( $noderef, $x )
109 :     # set_newick_c1( $noderef, $listref )
110 :     # set_newick_c2( $noderef, $listref )
111 :     # set_newick_c3( $noderef, $listref )
112 :     # set_newick_c4( $noderef, $listref )
113 :     # set_newick_c5( $noderef, $listref )
114 :     # set_newick_desc_list( $noderef, @desclist )
115 : golsen 1.9 # set_newick_desc_i( $noderef1, $i, $noderef2 ) # 1-based numbering
116 : golsen 1.8 #
117 :     # $bool = newick_is_valid( $noderef ) # verify that tree is valid
118 : golsen 1.1 #
119 :     # $bool = newick_is_rooted( $noderef ) # 2 branches from root
120 :     # $bool = newick_is_unrooted( $noderef ) # 3 or more branches from root
121 :     # $bool = newick_is_tip_rooted( $noderef ) # 1 branch from root
122 :     # $bool = newick_is_bifurcating( $noderef )
123 :     #
124 :     # $n = newick_tip_count( $noderef )
125 :     # @tiprefs = newick_tip_ref_list( $noderef )
126 : golsen 1.9 # \@tiprefs = newick_tip_ref_list( $noderef )
127 : golsen 1.1 # @tips = newick_tip_list( $noderef )
128 : golsen 1.9 # \@tips = newick_tip_list( $noderef )
129 :     #
130 : golsen 1.1 # $tipref = newick_first_tip_ref( $noderef )
131 :     # $tip = newick_first_tip( $noderef )
132 : golsen 1.9 #
133 : golsen 1.1 # @tips = newick_duplicated_tips( $noderef )
134 : golsen 1.9 # \@tips = newick_duplicated_tips( $noderef )
135 :     #
136 : golsen 1.1 # $bool = newick_tip_in_tree( $noderef, $tipname )
137 : golsen 1.9 #
138 : golsen 1.1 # @tips = newick_shared_tips( $tree1, $tree2 )
139 : golsen 1.9 # \@tips = newick_shared_tips( $tree1, $tree2 )
140 : golsen 1.1 #
141 :     # $length = newick_tree_length( $noderef )
142 : golsen 1.9 #
143 :     # %tip_distances = newick_tip_distances( $noderef )
144 :     # \%tip_distances = newick_tip_distances( $noderef )
145 :     #
146 : golsen 1.1 # $xmax = newick_max_X( $noderef )
147 :     # ( $tipref, $xmax ) = newick_most_distant_tip_ref( $noderef )
148 : golsen 1.9 # ( $tipname, $xmax ) = newick_most_distant_tip_name( $noderef )
149 : golsen 1.1 #
150 : golsen 1.20 # Provide a standard name by which two trees can be compared for same topology
151 :     #
152 :     # $stdname = std_tree_name( $tree )
153 :     #
154 : golsen 1.8 # Tree tip insertion point (tip is on branch of length x that
155 :     # is inserted into branch connecting node1 and node2, a distance
156 :     # x1 from node1 and x2 from node2):
157 :     #
158 : golsen 1.9 # [ $node1, $x1, $node2, $x2, $x ] = newick_tip_insertion_point( $tree, $tip )
159 : golsen 1.8 #
160 :     # Standardized label for a node in terms of intersection of 3 lowest sorting
161 :     # tips (sort is lower case):
162 :     #
163 : golsen 1.9 # @TipOrTips = std_node_name( $tree, $node )
164 : golsen 1.8 #
165 : golsen 1.1 #-------------------------------------------------------------------------------
166 :     # Paths from root of tree:
167 :     #-------------------------------------------------------------------------------
168 :     #
169 :     # Path descriptions are of form:
170 :     # ( $node0, $i0, $node1, $i1, $node2, $i2, ..., $nodeN )
171 :     # () is returned upon failure
172 :     #
173 :     # @path = path_to_tip( $treenode, $tipname )
174 :     # @path = path_to_named_node( $treenode, $nodename )
175 :     # @path = path_to_node_ref( $treenode, $noderef )
176 :     #
177 :     # @path = path_to_node( $node, $tip1, $tip2, $tip3 ) # 3 tip names
178 :     # @path = path_to_node( $node, [ $tip1, $tip2, $tip3 ] ) # Array of tips
179 :     # @path = path_to_node( $node, $tip1 ) # Use path_to_tip
180 :     # @path = path_to_node( $node, [ $tip1 ] ) # Use path_to_tip
181 :     #
182 :     # $distance = newick_path_length( @path )
183 :     # $distance = tip_to_tip_distance( $tree, $tip1, $tip2 )
184 :     # $distance = node_to_node_distance( $tree, $node1, $node2 )
185 :     #
186 :     #
187 :     #===============================================================================
188 :     # Tree manipulations:
189 :     #===============================================================================
190 :     #
191 : overbeek 1.4 # $treecopy = copy_newick_tree( $tree )
192 : golsen 1.1 #
193 :     #-------------------------------------------------------------------------------
194 : golsen 1.8 # The following modify the existing tree, and possibly any components of that
195 : golsen 1.1 # tree that are reached by reference. If the old version is still needed, copy
196 :     # before modifying.
197 :     #-------------------------------------------------------------------------------
198 :     #
199 :     # Modify labels:
200 :     #
201 :     # $newtree = newick_relabel_nodes( $node, \%new_name )
202 :     # $newtree = newick_relabel_nodes_i( $node, \%new_name )
203 :     # $newtree = newick_relabel_tips( $node, \%new_name )
204 :     # $newtree = newick_relabel_tips_i( $node, \%new_name )
205 :     #
206 :     # Modify branches:
207 :     #
208 :     # $n_changed = newick_set_undefined_branches( $node, $x )
209 :     # $n_changed = newick_set_all_branches( $node, $x )
210 : golsen 1.5 # $n_changed = newick_fix_negative_branches( $tree )
211 : overbeek 1.7 # $node = newick_rescale_branches( $node, $factor )
212 : golsen 1.15 # $node = newick_modify_branches( $node, \&function )
213 :     # $node = newick_modify_branches( $node, \&function, \@func_parms )
214 : golsen 1.1 #
215 : golsen 1.8 # Modify comments:
216 :     #
217 :     # $node = newick_strip_comments( $node )
218 :     #
219 : golsen 1.1 # Modify rooting and/or order:
220 :     #
221 :     # $nrmtree = normalize_newick_tree( $tree )
222 :     # $revtree = reverse_newick_tree( $tree )
223 :     # $stdtree = std_unrooted_newick( $tree )
224 :     # $newtree = aesthetic_newick_tree( $tree, $direction )
225 :     # $rndtree = random_order_newick_tree( $tree )
226 :     # $newtree = reroot_newick_by_path( @path )
227 :     # $newtree = reroot_newick_to_tip( $tree, $tip )
228 :     # $newtree = reroot_newick_next_to_tip( $tree, $tip )
229 :     # $newtree = reroot_newick_to_node( $tree, @node )
230 :     # $newtree = reroot_newick_to_node_ref( $tree, $noderef )
231 : golsen 1.9 # $newtree = reroot_newick_between_nodes( $tree, $node1, $node2, $fraction )
232 : golsen 1.12 # $newtree = reroot_newick_to_midpoint( $tree ) # unweighted
233 :     # $newtree = reroot_newick_to_midpoint_w( $tree ) # weight by tips
234 : golsen 1.5 # $newtree = reroot_newick_to_approx_midpoint( $tree ) # unweighted
235 :     # $newtree = reroot_newick_to_approx_midpoint_w( $tree ) # weight by tips
236 : golsen 1.1 # $newtree = uproot_tip_rooted_newick( $tree )
237 :     # $newtree = uproot_newick( $tree )
238 :     #
239 :     # $newtree = prune_from_newick( $tree, $tip )
240 : golsen 1.12 # $newtree = rooted_newick_subtree( $tree, @tips )
241 :     # $newtree = rooted_newick_subtree( $tree, \@tips )
242 : golsen 1.1 # $newtree = newick_subtree( $tree, @tips )
243 :     # $newtree = newick_subtree( $tree, \@tips )
244 : golsen 1.12 # $newtree = newick_covering_subtree( $tree, @tips )
245 :     # $newtree = newick_covering_subtree( $tree, \@tips )
246 : golsen 1.1 #
247 : golsen 1.5 # $newtree = collapse_zero_length_branches( $tree )
248 :     #
249 : golsen 1.8 # $node = newick_insert_at_node( $node, $subtree )
250 :     # $tree = newick_insert_between_nodes( $tree, $subtree, $node1, $node2, $fraction )
251 :     #
252 : golsen 1.1 #===============================================================================
253 : golsen 1.9 # Tree neighborhood: subtree of n tips to represent a larger tree.
254 :     #===============================================================================
255 :     #
256 :     # Focus around root:
257 :     #
258 :     # $subtree = root_neighborhood_representative_tree( $tree, $n, \%tip_priority )
259 :     # $subtree = root_neighborhood_representative_tree( $tree, $n )
260 :     # @tips = root_neighborhood_representative_tips( $tree, $n, \%tip_priority )
261 :     # @tips = root_neighborhood_representative_tips( $tree, $n )
262 :     # \@tips = root_neighborhood_representative_tips( $tree, $n, \%tip_priority )
263 :     # \@tips = root_neighborhood_representative_tips( $tree, $n )
264 :     #
265 :     # Focus around a tip insertion point (the tip is not in the subtree):
266 :     #
267 :     # $subtree = tip_neighborhood_representative_tree( $tree, $tip, $n, \%tip_priority )
268 :     # $subtree = tip_neighborhood_representative_tree( $tree, $tip, $n )
269 :     # @tips = tip_neighborhood_representative_tips( $tree, $tip, $n, \%tip_priority )
270 :     # @tips = tip_neighborhood_representative_tips( $tree, $tip, $n )
271 :     # \@tips = tip_neighborhood_representative_tips( $tree, $tip, $n, \%tip_priority )
272 :     # \@tips = tip_neighborhood_representative_tips( $tree, $tip, $n )
273 :     #
274 :     #===============================================================================
275 : golsen 1.22 # Random trees
276 :     #===============================================================================
277 :     #
278 :     # $tree = random_equibranch_tree( @tips, \%options )
279 :     # $tree = random_equibranch_tree( \@tips, \%options )
280 :     # $tree = random_equibranch_tree( @tips )
281 :     # $tree = random_equibranch_tree( \@tips )
282 :     #
283 :     # $tree = random_ultrametric_tree( @tips, \%options )
284 :     # $tree = random_ultrametric_tree( \@tips, \%options )
285 :     # $tree = random_ultrametric_tree( @tips )
286 :     # $tree = random_ultrametric_tree( \@tips )
287 :     #
288 :     #===============================================================================
289 : golsen 1.1 # Tree reading and writing:
290 :     #===============================================================================
291 : golsen 1.9 # Write machine-readable trees:
292 : golsen 1.1 #
293 :     # writeNewickTree( $tree )
294 :     # writeNewickTree( $tree, $file )
295 : overbeek 1.7 # writeNewickTree( $tree, \*FH )
296 :     # fwriteNewickTree( $file, $tree ) # Matches the C arg list for f... I/O
297 : golsen 1.1 # $treestring = swriteNewickTree( $tree )
298 :     # $treestring = formatNewickTree( $tree )
299 : golsen 1.9 #
300 :     # Write human-readable trees:
301 :     #
302 : golsen 1.1 # @textlines = text_plot_newick( $node, $width, $min_dx, $dy )
303 :     # printer_plot_newick( $node, $file, $width, $min_dx, $dy )
304 :     #
305 : golsen 1.9 # Read trees:
306 :     #
307 : overbeek 1.7 # $tree = read_newick_tree( $file ) # reads to a semicolon
308 :     # @trees = read_newick_trees( $file ) # reads to end of file
309 :     # $tree = parse_newick_tree_str( $string )
310 : golsen 1.1 #
311 :     #===============================================================================
312 :    
313 :    
314 : golsen 1.8 use Carp;
315 :     use Data::Dumper;
316 : golsen 1.9 use strict;
317 : golsen 1.8
318 : golsen 1.1 require Exporter;
319 :    
320 :     our @ISA = qw(Exporter);
321 :     our @EXPORT = qw(
322 : golsen 1.9 is_overbeek_tree
323 :     is_gjonewick_tree
324 : overbeek 1.7 overbeek_to_gjonewick
325 :     gjonewick_to_overbeek
326 : golsen 1.8 newick_is_valid
327 : golsen 1.1 newick_is_rooted
328 :     newick_is_unrooted
329 :     tree_rooted_on_tip
330 :     newick_is_bifurcating
331 :     newick_tip_count
332 : golsen 1.9 newick_tip_ref_list
333 : golsen 1.1 newick_tip_list
334 : golsen 1.9
335 : golsen 1.1 newick_first_tip
336 :     newick_duplicated_tips
337 :     newick_tip_in_tree
338 :     newick_shared_tips
339 :    
340 :     newick_tree_length
341 : golsen 1.9 newick_tip_distances
342 : golsen 1.1 newick_max_X
343 :     newick_most_distant_tip_ref
344 :     newick_most_distant_tip_name
345 : golsen 1.9
346 :     newick_tip_insertion_point
347 :    
348 : golsen 1.20 std_tree_name
349 : golsen 1.1
350 :     path_to_tip
351 :     path_to_named_node
352 :     path_to_node_ref
353 :     path_to_node
354 :    
355 :     newick_path_length
356 :     tip_to_tip_distance
357 :     node_to_node_distance
358 :    
359 : overbeek 1.4 copy_newick_tree
360 : golsen 1.1
361 :     newick_relabel_nodes
362 :     newick_relabel_nodes_i
363 :     newick_relabel_tips
364 :     newick_relabel_tips_i
365 :    
366 :     newick_set_undefined_branches
367 :     newick_set_all_branches
368 : golsen 1.5 newick_fix_negative_branches
369 : overbeek 1.7 newick_rescale_branches
370 : golsen 1.15 newick_modify_branches
371 : golsen 1.1
372 : golsen 1.8 newick_strip_comments
373 :    
374 : golsen 1.1 normalize_newick_tree
375 :     reverse_newick_tree
376 :     std_unrooted_newick
377 :     aesthetic_newick_tree
378 :     unaesthetic_newick_tree
379 :     random_order_newick_tree
380 :    
381 :     reroot_newick_by_path
382 :     reroot_newick_to_tip
383 :     reroot_newick_next_to_tip
384 :     reroot_newick_to_node
385 :     reroot_newick_to_node_ref
386 : golsen 1.9 reroot_newick_between_nodes
387 : golsen 1.12 reroot_newick_to_midpoint
388 :     reroot_newick_to_midpoint_w
389 : golsen 1.1 reroot_newick_to_approx_midpoint
390 : golsen 1.5 reroot_newick_to_approx_midpoint_w
391 : golsen 1.1 uproot_tip_rooted_newick
392 :     uproot_newick
393 :    
394 :     prune_from_newick
395 : golsen 1.12 rooted_newick_subtree
396 : golsen 1.1 newick_subtree
397 : golsen 1.12 newick_covering_subtree
398 : golsen 1.5 collapse_zero_length_branches
399 : golsen 1.1
400 : golsen 1.8 newick_insert_at_node
401 :     newick_insert_between_nodes
402 :    
403 : golsen 1.9 root_neighborhood_representative_tree
404 :     root_neighborhood_representative_tips
405 :     tip_neighborhood_representative_tree
406 :     tip_neighborhood_representative_tips
407 :    
408 : golsen 1.22 random_equibranch_tree
409 :     random_ultrametric_tree
410 :    
411 : golsen 1.1 writeNewickTree
412 :     fwriteNewickTree
413 :     strNewickTree
414 :     formatNewickTree
415 : overbeek 1.7
416 :     read_newick_tree
417 :     read_newick_trees
418 : golsen 1.1 parse_newick_tree_str
419 :    
420 :     printer_plot_newick
421 :     text_plot_newick
422 :     );
423 :    
424 :     our @EXPORT_OK = qw(
425 :     newick_desc_ref
426 :     newick_lbl
427 :     newick_x
428 :     newick_c1
429 :     newick_c2
430 :     newick_c3
431 :     newick_c4
432 :     newick_c5
433 :     newick_desc_list
434 :     newick_n_desc
435 :     newick_desc_i
436 :     newick_is_tip
437 :     newick_is_valid
438 :    
439 :     set_newick_desc_ref
440 :     set_newick_lbl
441 :     set_newick_x
442 :     set_newick_c1
443 :     set_newick_c2
444 :     set_newick_c3
445 :     set_newick_c4
446 :     set_newick_c5
447 :    
448 :     set_newick_desc_list
449 :     set_newick_desc_i
450 :    
451 :     add_to_newick_branch
452 :     dump_tree
453 :     );
454 :    
455 :    
456 :     #-------------------------------------------------------------------------------
457 :     # Internally used definitions
458 :     #-------------------------------------------------------------------------------
459 :    
460 : golsen 1.21 sub array_ref { $_[0] && ref( $_[0] ) eq 'ARRAY' }
461 :     sub hash_ref { $_[0] && ref( $_[0] ) eq 'HASH' }
462 : golsen 1.1
463 :    
464 :     #===============================================================================
465 : golsen 1.9 # Interconvert overbeek and gjonewick trees:
466 : overbeek 1.7 #===============================================================================
467 :    
468 : golsen 1.9 sub is_overbeek_tree { array_ref( $_[0] ) && array_ref( $_[0]->[2] ) }
469 :    
470 :     sub is_gjonewick_tree { array_ref( $_[0] ) && array_ref( $_[0]->[0] ) }
471 :    
472 : overbeek 1.7 sub overbeek_to_gjonewick
473 :     {
474 :     return () unless ref( $_[0] ) eq 'ARRAY';
475 :     my ( $lbl, $x, $desc ) = @{ $_[0] };
476 :     my ( undef, @desc ) = ( $desc && ref( $desc ) eq 'ARRAY' ) ? @$desc : ();
477 :     [ [ map { overbeek_to_gjonewick( $_ ) } @desc ], $lbl, $x ]
478 :     }
479 :    
480 :     sub gjonewick_to_overbeek
481 :     {
482 :     return () unless ref( $_[0] ) eq 'ARRAY';
483 :     my ( $desc, $lbl, $x ) = @{ $_[0] };
484 :     my @desc = ( $desc && ref( $desc ) eq 'ARRAY' ) ? @$desc : ();
485 :     my $parent = $_[1];
486 :     my $node = [ $lbl, $x, undef, [] ];
487 :     $node->[2] = [ $parent, map { gjonewick_to_overbeek( $_, $node ) } @desc ];
488 :     return $node;
489 :     }
490 :    
491 : golsen 1.9
492 : overbeek 1.7 #===============================================================================
493 : golsen 1.1 # Extract tree structure values:
494 :     #===============================================================================
495 :     #
496 :     # $listref = newick_desc_ref( $noderef )
497 :     # $string = newick_lbl( $noderef )
498 :     # $real = newick_x( $noderef )
499 :     # $listref = newick_c1( $noderef )
500 :     # $listref = newick_c2( $noderef )
501 :     # $listref = newick_c3( $noderef )
502 :     # $listref = newick_c4( $noderef )
503 :     # $listref = newick_c5( $noderef )
504 :     # @list = newick_desc_list( $noderef )
505 :     # $int = newick_n_desc( $noderef )
506 :     # $listref = newick_desc_i( $noderef )
507 :     # $bool = node_is_tip( $noderef )
508 :     # $bool = node_is_valid( $noderef )
509 :     #
510 :     #-------------------------------------------------------------------------------
511 :    
512 : golsen 1.12 sub newick_desc_ref { ref($_[0]) ? $_[0]->[0] : Carp::confess() } # = ${$_[0]}[0]
513 : golsen 1.8 sub newick_lbl { ref($_[0]) ? $_[0]->[1] : Carp::confess() }
514 : golsen 1.12 sub newick_x { ref($_[0]) ? $_[0]->[2] : Carp::confess() }
515 : golsen 1.10 sub newick_c1 { ref($_[0]) ? $_[0]->[3] : Carp::confess() }
516 : golsen 1.12 sub newick_c2 { ref($_[0]) ? $_[0]->[4] : Carp::confess() }
517 :     sub newick_c3 { ref($_[0]) ? $_[0]->[5] : Carp::confess() }
518 :     sub newick_c4 { ref($_[0]) ? $_[0]->[6] : Carp::confess() }
519 :     sub newick_c5 { ref($_[0]) ? $_[0]->[7] : Carp::confess() }
520 : golsen 1.1
521 :     sub newick_desc_list {
522 :     my $node = $_[0];
523 : golsen 1.21 array_ref( $node ) && array_ref( $node->[0] ) ? @{ $node->[0] } : ();
524 : golsen 1.1 }
525 :    
526 :     sub newick_n_desc {
527 :     my $node = $_[0];
528 : golsen 1.21 array_ref( $node ) && array_ref( $node->[0] ) ? scalar @{ $node->[0] } : 0;
529 : golsen 1.1 }
530 :    
531 :     sub newick_desc_i {
532 :     my ( $node, $i ) = @_;
533 : golsen 1.21 array_ref( $node ) && $i && array_ref( $node->[0] ) ? $node->[0]->[$i-1] : undef;
534 : golsen 1.1 }
535 :    
536 :     sub node_is_tip {
537 :     my $node = $_[0];
538 :     ! array_ref( $node ) ? undef : # Not a node ref
539 :     array_ref( $node->[0] ) ? @{ $node->[0] } == 0 : # Empty descend list?
540 :     1 ; # No descend list
541 :     }
542 :    
543 :     sub node_is_valid { # An array ref with nonempty descend list or a label
544 :     my $node = $_[0];
545 :     array_ref( $node ) && ( array_ref( $node->[0] ) && @{ $node->[0] }
546 :     || defined( $node->[1] )
547 :     )
548 :     }
549 :    
550 :    
551 :     #-------------------------------------------------------------------------------
552 :     # Set tree structure values
553 :     #-------------------------------------------------------------------------------
554 :    
555 :     sub set_newick_desc_ref { $_[0]->[0] = $_[1] }
556 :     sub set_newick_lbl { $_[0]->[1] = $_[1] }
557 :     sub set_newick_x { $_[0]->[2] = $_[1] }
558 :     sub set_newick_c1 { $_[0]->[3] = $_[1] }
559 :     sub set_newick_c2 { $_[0]->[4] = $_[1] }
560 :     sub set_newick_c3 { $_[0]->[5] = $_[1] }
561 :     sub set_newick_c4 { $_[0]->[6] = $_[1] }
562 :     sub set_newick_c5 { $_[0]->[7] = $_[1] }
563 :    
564 :     sub set_newick_desc_list {
565 :     my $node = shift;
566 :     array_ref( $node ) || return;
567 :     if ( array_ref( $node->[0] ) ) { @{ $node->[0] } = @_ }
568 :     else { $node->[0] = [ @_ ] }
569 :     }
570 :    
571 :     sub set_newick_desc_i {
572 :     my ( $node1, $i, $node2 ) = @_;
573 :     array_ref( $node1 ) && array_ref( $node2 ) || return;
574 :     if ( array_ref( $node1->[0] ) ) { $node1->[0]->[$i-1] = $node2 }
575 :     else { $node1->[0] = [ $node2 ] }
576 :     }
577 :    
578 :    
579 :     #===============================================================================
580 :     # Some tree property tests:
581 :     #===============================================================================
582 : golsen 1.8 # Tree is valid?
583 :     #
584 :     # $bool = newick_is_valid( $node, $verbose )
585 :     #-------------------------------------------------------------------------------
586 :     sub newick_is_valid
587 :     {
588 :     my $node = shift;
589 :    
590 :     if ( ! array_ref( $node ) )
591 :     {
592 :     print STDERR "Node is not array reference\n" if $_[0];
593 :     return 0;
594 :     }
595 :    
596 :     my @node = @$node;
597 :     if ( ! @node )
598 :     {
599 :     print STDERR "Node is empty array reference\n" if $_[0];
600 :     return 0;
601 :     }
602 :    
603 :     # Must have descendant or label:
604 :    
605 :     if ( ! ( array_ref( $node[0] ) && @{ $node[0] } ) && ! $node[2] )
606 :     {
607 :     print STDERR "Node has neither descendant nor label\n" if $_[0];
608 :     return 0;
609 :     }
610 :    
611 :     # If comments are present, they must be array references
612 :    
613 :     foreach ( ( @node > 3 ) ? @node[ 3 .. $#node ] : () )
614 :     {
615 :     if ( defined( $_ ) && ! array_ref( $_ ) )
616 :     {
617 :     print STDERR "Node has neither descendant or label\n" if $_[0];
618 :     return 0;
619 :     }
620 :     }
621 :    
622 :     # Inspect the descendants:
623 :    
624 :     foreach ( array_ref( $node[0] ) ? @{ $node[0] } : () )
625 :     {
626 :     newick_is_valid( $_, @_ ) || return 0
627 :     }
628 :    
629 :     return 1;
630 :     }
631 :    
632 :    
633 :     #-------------------------------------------------------------------------------
634 : golsen 1.1 # Tree is rooted (2 branches at root node)?
635 :     #
636 :     # $bool = newick_is_rooted( $node )
637 :     #-------------------------------------------------------------------------------
638 :     sub newick_is_rooted {
639 :     my $node = $_[0];
640 :     ! array_ref( $node ) ? undef : # Not a node ref
641 :     array_ref( $node->[0] ) ? @{ $node->[0] } == 2 : # 2 branches
642 :     0 ; # No descend list
643 :     }
644 :    
645 :    
646 :     #-------------------------------------------------------------------------------
647 :     # Tree is unrooted (> 2 branches at root node)?
648 :     #
649 :     # $bool = newick_is_unrooted( $node )
650 :     #-------------------------------------------------------------------------------
651 :     sub newick_is_unrooted {
652 :     my $node = $_[0];
653 :     ! array_ref( $node ) ? undef : # Not a node ref
654 :     array_ref( $node->[0] ) ? @{ $node->[0] } >= 3 : # Over 2 branches
655 :     0 ; # No descend list
656 :     }
657 :    
658 :    
659 :     #-------------------------------------------------------------------------------
660 :     # Tree is rooted on a tip (1 branch at root node)?
661 :     #
662 :     # $bool = newick_is_tip_rooted( $node )
663 :     #-------------------------------------------------------------------------------
664 :     sub newick_is_tip_rooted {
665 :     my $node = $_[0];
666 :     ! array_ref( $node ) ? undef : # Not a node ref
667 :     array_ref( $node->[0] ) ? @{ $node->[0] } == 1 : # 1 branch
668 :     0 ; # No descend list
669 :     }
670 :    
671 :     #===============================================================================
672 :     # Everything below this point refers to parts of the tree structure using
673 :     # only the routines above.
674 :     #===============================================================================
675 :     # Tree is bifurcating? If so, return number of descendents of root node.
676 :     #
677 :     # $n_desc = newick_is_bifurcating( $node )
678 :     #-------------------------------------------------------------------------------
679 :     sub newick_is_bifurcating {
680 :     my ( $node, $not_root ) = @_;
681 :     if ( ! array_ref( $node ) ) { return undef } # Bad arg
682 :    
683 :     my $n = newick_n_desc( $node );
684 :     $n == 0 && ! $not_root ? 0 :
685 :     $n == 1 && $not_root ? 0 :
686 :     $n == 3 && $not_root ? 0 :
687 :     $n > 3 ? 0 :
688 :     $n > 2 && ! newick_is_bifurcating( newick_desc_i( $node, 3, 1 ) ) ? 0 :
689 :     $n > 1 && ! newick_is_bifurcating( newick_desc_i( $node, 2, 1 ) ) ? 0 :
690 :     $n > 0 && ! newick_is_bifurcating( newick_desc_i( $node, 1, 1 ) ) ? 0 :
691 :     $n
692 :     }
693 :    
694 :    
695 :     #-------------------------------------------------------------------------------
696 :     # Number of tips:
697 :     #
698 :     # $n = newick_tip_count( $node )
699 :     #-------------------------------------------------------------------------------
700 :     sub newick_tip_count {
701 :     my ( $node, $not_root ) = @_;
702 :    
703 :     my $imax = newick_n_desc( $node );
704 :     if ( $imax < 1 ) { return 1 }
705 :    
706 :     # Special case for tree rooted on tip
707 :    
708 :     my $n = ( $imax == 1 && ( ! $not_root ) ) ? 1 : 0;
709 :    
710 :     foreach ( newick_desc_list( $node ) ) { $n += newick_tip_count( $_, 1 ) }
711 :    
712 :     $n;
713 :     }
714 :    
715 :    
716 :     #-------------------------------------------------------------------------------
717 :     # List of tip nodes:
718 :     #
719 : golsen 1.9 # @tips = newick_tip_ref_list( $noderef )
720 :     # \@tips = newick_tip_ref_list( $noderef )
721 : golsen 1.1 #-------------------------------------------------------------------------------
722 :     sub newick_tip_ref_list {
723 :     my ( $node, $not_root ) = @_;
724 :    
725 :     my $imax = newick_n_desc( $node );
726 :     if ( $imax < 1 ) { return $node }
727 :    
728 :     my @list = ();
729 :    
730 :     # Tree rooted on tip?
731 :     if ( $imax == 1 && ! $not_root && newick_lbl( $node ) ) { push @list, $node }
732 :    
733 :     foreach ( newick_desc_list( $node ) ) {
734 :     push @list, newick_tip_ref_list( $_, 1 );
735 :     }
736 :    
737 : golsen 1.9 wantarray ? @list : \@list;
738 : golsen 1.1 }
739 :    
740 :    
741 :     #-------------------------------------------------------------------------------
742 :     # List of tips:
743 :     #
744 :     # @tips = newick_tip_list( $node )
745 : golsen 1.9 # \@tips = newick_tip_list( $node )
746 : golsen 1.1 #-------------------------------------------------------------------------------
747 :     sub newick_tip_list {
748 : golsen 1.9 my @tips = map { newick_lbl( $_ ) } newick_tip_ref_list( $_[0] );
749 :     wantarray ? @tips : \@tips;
750 : golsen 1.1 }
751 :    
752 :    
753 :     #-------------------------------------------------------------------------------
754 :     # First tip node in tree:
755 :     #
756 :     # $tipref = newick_first_tip_ref( $node )
757 :     #-------------------------------------------------------------------------------
758 :     sub newick_first_tip_ref {
759 :     my ( $node, $not_root ) = @_;
760 :     valid_node( $node ) || return undef;
761 :    
762 :     # Arrived at tip, or start of a tip-rooted tree?
763 :     my $n = newick_n_desc( $node );
764 :     if ( ( $n < 1 ) || ( $n == 1 && ! $not_root ) ) { return $node }
765 :    
766 :     newick_first_tip_ref( newick_desc_i( $node, 1 ), 1 );
767 :     }
768 :    
769 :    
770 :     #-------------------------------------------------------------------------------
771 :     # First tip name in tree:
772 :     #
773 :     # $tip = newick_first_tip( $node )
774 :     #-------------------------------------------------------------------------------
775 :     sub newick_first_tip {
776 :     my ( $noderef ) = @_;
777 :    
778 :     my $tipref;
779 :     array_ref( $tipref = newick_first_tip_ref( $noderef ) ) ? newick_lbl( $tipref )
780 : golsen 1.9 : undef;
781 : golsen 1.1 }
782 :    
783 :    
784 :     #-------------------------------------------------------------------------------
785 :     # List of duplicated tip labels.
786 :     #
787 :     # @tips = newick_duplicated_tips( $node )
788 : golsen 1.9 # \@tips = newick_duplicated_tips( $node )
789 : golsen 1.1 #-------------------------------------------------------------------------------
790 :     sub newick_duplicated_tips {
791 : golsen 1.9 my @tips = &duplicates( newick_tip_list( $_[0] ) );
792 :     wantarray ? @tips : \@tips;
793 : golsen 1.1 }
794 :    
795 :    
796 :     #-------------------------------------------------------------------------------
797 :     # Tip in tree?
798 :     #
799 :     # $bool = newick_tip_in_tree( $node, $tipname )
800 :     #-------------------------------------------------------------------------------
801 :     sub newick_tip_in_tree {
802 :     my ( $node, $tip, $not_root ) = @_;
803 :    
804 :     my $n = newick_n_desc( $node );
805 :     if ( $n < 1 ) { return ( newick_lbl( $node ) eq $tip) ? 1 : 0 }
806 :    
807 :     # Special case for tree rooted on tip
808 :    
809 :     if ( $n == 1 && ( ! $not_root ) && newick_lbl( $node ) eq $tip ) { return 1 }
810 :    
811 :     foreach ( newick_desc_list( $node ) ) {
812 :     if ( newick_tip_in_tree( $_, $tip, 1 ) ) { return 1 }
813 :     }
814 :    
815 :     0; # Fall through means not found
816 :     }
817 :    
818 :    
819 :     #-------------------------------------------------------------------------------
820 :     # Tips shared between 2 trees.
821 :     #
822 :     # @tips = newick_shared_tips( $tree1, $tree2 )
823 : golsen 1.9 # \@tips = newick_shared_tips( $tree1, $tree2 )
824 : golsen 1.1 #-------------------------------------------------------------------------------
825 :     sub newick_shared_tips {
826 : golsen 1.9 my ( $tree1, $tree2 ) = @_;
827 :     my $tips1 = newick_tip_list( $tree1 );
828 :     my $tips2 = newick_tip_list( $tree2 );
829 :     my @tips = &intersection( $tips1, $tips2 );
830 :     wantarray ? @tips : \@tips;
831 : golsen 1.1 }
832 :    
833 :    
834 :     #-------------------------------------------------------------------------------
835 :     # Tree length.
836 :     #
837 :     # $length = newick_tree_length( $node )
838 :     #-------------------------------------------------------------------------------
839 :     sub newick_tree_length {
840 :     my ( $node, $not_root ) = @_;
841 :    
842 :     my $x = $not_root ? newick_x( $node ) : 0;
843 :     defined( $x ) || ( $x = 1 ); # Convert undefined to 1
844 :    
845 :     foreach ( newick_desc_list( $node ) ) { $x += newick_tree_length( $_, 1 ) }
846 :    
847 :     $x;
848 :     }
849 :    
850 :    
851 :     #-------------------------------------------------------------------------------
852 : golsen 1.9 # Hash of tip nodes and corresponding distances from root:
853 :     #
854 :     # %tip_distances = newick_tip_distances( $node )
855 :     # \%tip_distances = newick_tip_distances( $node )
856 :     #-------------------------------------------------------------------------------
857 :     sub newick_tip_distances
858 :     {
859 :     my ( $node, $x, $hash ) = @_;
860 :     my $root = ! $hash;
861 :     ref( $hash ) eq 'HASH' or $hash = {};
862 :    
863 :     $x ||= 0;
864 :     $x += newick_x( $node ) || 0;
865 :    
866 :     # Is it a tip?
867 :    
868 :     my $n_desc = newick_n_desc( $node );
869 :     if ( ! $n_desc )
870 :     {
871 :     $hash->{ newick_lbl( $node ) } = $x;
872 :     return $hash;
873 :     }
874 :    
875 :     # Tree rooted on tip?
876 :    
877 :     if ( ( $n_desc == 1 ) && $root && ( newick_lbl( $node ) ) )
878 :     {
879 :     $hash->{ newick_lbl( $node ) } = 0; # Distance to root is zero
880 :     }
881 :    
882 :     foreach ( newick_desc_list( $node ) )
883 :     {
884 :     newick_tip_distances( $_, $x, $hash );
885 :     }
886 :    
887 :     wantarray ? %$hash : $hash;
888 :     }
889 :    
890 :    
891 :     #-------------------------------------------------------------------------------
892 : golsen 1.1 # Tree max X.
893 :     #
894 :     # $xmax = newick_max_X( $node )
895 :     #-------------------------------------------------------------------------------
896 :     sub newick_max_X {
897 :     my ( $node, $not_root ) = @_;
898 :    
899 :     my $xmax = 0;
900 :     foreach ( newick_desc_list( $node ) ) {
901 :     my $x = newick_max_X( $_, 1 );
902 :     if ( $x > $xmax ) { $xmax = $x }
903 :     }
904 :    
905 :     my $x = $not_root ? newick_x( $node ) : 0;
906 :     $xmax + ( defined( $x ) ? $x : 1 ); # Convert undefined to 1
907 :     }
908 :    
909 :    
910 :     #-------------------------------------------------------------------------------
911 :     # Most distant tip from root: distance and path.
912 :     #
913 :     # ( $xmax, @path ) = newick_most_distant_tip_path( $tree )
914 :     #-------------------------------------------------------------------------------
915 :     sub newick_most_distant_tip_path {
916 :     my ( $node, $not_root ) = @_;
917 :    
918 :     my $imax = newick_n_desc( $node );
919 :     my $xmax = ( $imax > 0 ) ? -1 : 0;
920 :     my @pmax = ();
921 :     for ( my $i = 1; $i <= $imax; $i++ ) {
922 :     my ( $x, @path ) = newick_most_distant_tip_path( newick_desc_i( $node, $i ), 1 );
923 :     if ( $x > $xmax ) { $xmax = $x; @pmax = ( $i, @path ) }
924 :     }
925 :    
926 :     my $x = $not_root ? newick_x( $node ) : 0;
927 :     $xmax += defined( $x ) ? $x : 0; # Convert undefined to 1
928 :     ( $xmax, $node, @pmax );
929 :     }
930 :    
931 :    
932 :     #-------------------------------------------------------------------------------
933 :     # Most distant tip from root, and its distance.
934 :     #
935 :     # ( $tipref, $xmax ) = newick_most_distant_tip_ref( $tree )
936 :     #-------------------------------------------------------------------------------
937 :     sub newick_most_distant_tip_ref {
938 :     my ( $node, $not_root ) = @_;
939 :    
940 :     my $imax = newick_n_desc( $node );
941 :     my $xmax = ( $imax > 0 ) ? -1 : 0;
942 :     my $tmax = $node;
943 :     foreach ( newick_desc_list( $node ) ) {
944 :     my ( $t, $x ) = newick_most_distant_tip_ref( $_, 1 );
945 :     if ( $x > $xmax ) { $xmax = $x; $tmax = $t }
946 :     }
947 :    
948 :     my $x = $not_root ? newick_x( $node ) : 0;
949 :     $xmax += defined( $x ) ? $x : 1; # Convert undefined to 1
950 :     ( $tmax, $xmax );
951 :     }
952 :    
953 :    
954 :     #-------------------------------------------------------------------------------
955 :     # Name of most distant tip from root, and its distance.
956 :     #
957 :     # ( $tipname, $xmax ) = newick_most_distant_tip_name( $tree )
958 :     #-------------------------------------------------------------------------------
959 :     sub newick_most_distant_tip_name {
960 :     my ( $tipref, $xmax ) = newick_most_distant_tip_ref( $_[0] );
961 :     ( newick_lbl( $tipref ), $xmax )
962 :     }
963 :    
964 :    
965 :     #-------------------------------------------------------------------------------
966 : golsen 1.8 # Tree tip insertion point (with standard node labels):
967 :     #
968 :     # [ $node1, $x1, $node2, $x2, $x ]
969 :     # = newick_tip_insertion_point( $tree, $tip )
970 :     #
971 :     # Which means: tip is on a branch of length x that is inserted into the branch
972 :     # connecting node1 and node2, at distance x1 from node1 and x2 from node2.
973 :     #
974 :     # x1 +------ n1a (lowest sorting tip of this subtree)
975 :     # +--------n1
976 :     # | +------n1b (lowest sorting tip of this subtree)
977 :     # tip-------n
978 :     # x | +------------- n2a (lowest sorting tip of this subtree)
979 :     # +------n2
980 :     # x2 +-------- n2b (lowest sorting tip of this subtree)
981 :     #
982 :     # The designations of 1 vs 2, and a vs b are chosen such that:
983 :     # n1a < n1b, and n2a < n2b, and n1a < n2a
984 :     #
985 :     # Then the statandard description becomes:
986 :     #
987 :     # [ [ $n1a, min(n1b,n2a), max(n1b,n2a) ], x1,
988 :     # [ $n2a, min(n2b,n1a), max(n2b,n1a) ], x2,
989 :     # x
990 :     # ]
991 :     #
992 :     #-------------------------------------------------------------------------------
993 :     sub newick_tip_insertion_point
994 :     {
995 :     my ( $tree, $tip ) = @_;
996 :     $tree && $tip && ref( $tree ) eq 'ARRAY' or return undef;
997 :     $tree = copy_newick_tree( $tree ) or return undef;
998 :     $tree = reroot_newick_to_tip( $tree, $tip ) or return undef;
999 :     my $node = $tree;
1000 :    
1001 :     my $x = 0; # Distance to node
1002 :     my $dl = newick_desc_ref( $node ); # Descendent list of tip node;
1003 :     $node = $dl->[0]; # Node adjacent to tip
1004 :     $dl = newick_desc_ref( $node );
1005 :     while ( $dl && ( @$dl == 1 ) ) # Traverse unbranched nodes
1006 :     {
1007 :     $node = $dl->[0];
1008 :     $x += newick_x( $node );
1009 :     $dl = newick_desc_ref( $node );
1010 :     }
1011 :     $x += newick_x( $node );
1012 :    
1013 :     # We are now at the node that is the insertion point.
1014 :     # Is it a tip?
1015 :    
1016 :     my @description;
1017 :    
1018 :     if ( ( ! $dl ) || @$dl == 0 )
1019 :     {
1020 :     @description = ( [ newick_lbl( $node ) ], 0, undef, 0, $x );
1021 :     }
1022 :    
1023 :     # Is it a trifurcation or greater, in which case it does not go
1024 :     # away with tip deletion?
1025 :    
1026 :     elsif ( @$dl > 2 )
1027 :     {
1028 :     @description = ( [ std_node_name( $node, $node ) ], 0, undef, 0, $x );
1029 :     }
1030 :    
1031 :     # The node is bifurcating. We need to describe it.
1032 :    
1033 :     else
1034 :     {
1035 : golsen 1.9 my ( $n1, $x1 ) = describe_descendant( $dl->[0] );
1036 :     my ( $n2, $x2 ) = describe_descendant( $dl->[1] );
1037 : golsen 1.8
1038 :     if ( @$n1 == 2 ) { push @$n1, $n2->[0] }
1039 :     if ( @$n2 == 2 )
1040 :     {
1041 :     @$n2 = sort { lc $a cmp lc $b } ( @$n2, $n1->[0] );
1042 :     }
1043 :     if ( @$n1 == 3 ) { @$n2 = sort { lc $a cmp lc $b } @$n2 }
1044 :     @description = ( $n1, $x1, $n2, $x2, $x );
1045 :     }
1046 :    
1047 :     return wantarray ? @description : \@description;
1048 :     }
1049 :    
1050 :    
1051 : golsen 1.9 sub describe_descendant
1052 : golsen 1.8 {
1053 :     my $node = shift;
1054 :    
1055 :     my $x = 0; # Distance to node
1056 :     my $dl = newick_desc_ref( $node ); # Descendent list of tip node;
1057 :     while ( $dl && ( @$dl == 1 ) ) # Traverse unbranched nodes
1058 :     {
1059 :     $node = $dl->[0];
1060 : golsen 1.9 $x += newick_x( $node );
1061 : golsen 1.8 $dl = newick_desc_ref( $node );
1062 :     }
1063 :     $x += newick_x( $node );
1064 :    
1065 :     # Is it a tip? Return list of one tip;
1066 :    
1067 :     if ( ( ! $dl ) || @$dl == 0 )
1068 :     {
1069 :     return ( [ newick_lbl( $node ) ], $x );
1070 :     }
1071 :    
1072 :     # Get tips of each descendent, keeping lowest sorting from each.
1073 :     # Return the two lowest of those (the third will come from the
1074 :     # other side of the original node).
1075 :    
1076 : golsen 1.9 my @rep_tips = sort { lc $a cmp lc $b }
1077 :     map { ( sort { lc $a cmp lc $b } newick_tip_list( $_ ) )[0] }
1078 :     @$dl;
1079 :     return ( [ @rep_tips[0,1] ], $x );
1080 : golsen 1.8 }
1081 :    
1082 :    
1083 :     #-------------------------------------------------------------------------------
1084 : golsen 1.1 # Standard node name:
1085 :     # Tip label if at a tip
1086 :     # Three sorted tip labels intersecting at node, each being smallest
1087 :     # of all the tips of their subtrees
1088 :     #
1089 : golsen 1.9 # @TipOrTips = std_node_name( $tree, $node )
1090 : golsen 1.1 #-------------------------------------------------------------------------------
1091 :     sub std_node_name {
1092 :     my $tree = $_[0];
1093 :    
1094 :     # Node reference is last element of path to node
1095 :    
1096 :     my $noderef = ( path_to_node( @_ ) )[-1];
1097 :     defined( $noderef ) || return ();
1098 :    
1099 :     if ( node_is_tip( $noderef ) || $noderef eq $tree ) { # Is it a tip?
1100 :     return newick_lbl( $noderef );
1101 :     }
1102 :    
1103 :     # Work through lists of tips in descendant subtrees, removing them from
1104 :     # @rest, and keeping the best tip for each subtree.
1105 :    
1106 : golsen 1.8 my @rest = newick_tip_list( $tree );
1107 : golsen 1.9 my @best = map
1108 :     {
1109 : golsen 1.8 my @tips = sort { lc $a cmp lc $b } newick_tip_list( $_ );
1110 : golsen 1.9 @rest = &set_difference( \@rest, \@tips );
1111 : golsen 1.1 $tips[0];
1112 : golsen 1.9 } newick_desc_list( $noderef );
1113 : golsen 1.1
1114 :     # Best of the rest of the tree
1115 :     push @best, ( sort { lc $a cmp lc $b } @rest )[0];
1116 :    
1117 :     # Take the top 3, in order:
1118 :    
1119 :     ( @best >= 3 ) ? ( sort { lc $a cmp lc $b } @best )[0 .. 2] : ();
1120 :     }
1121 :    
1122 :    
1123 :     #===============================================================================
1124 :     # Functions to find paths in trees.
1125 :     #
1126 :     # Path descriptions are of form:
1127 :     # ( $node0, $i0, $node1, $i1, $node2, $i2, ..., $nodeN ) # Always odd
1128 :     # () is returned upon failure
1129 :     #
1130 :     # Numbering of descendants is 1-based.
1131 :     #===============================================================================
1132 :     # Path to tip:
1133 :     #
1134 :     # @path = path_to_tip( $treenode, $tipname )
1135 :     #-------------------------------------------------------------------------------
1136 :     sub path_to_tip {
1137 :     my ( $node, $tip, @path0 ) = @_;
1138 :    
1139 :     push @path0, $node;
1140 :     my $imax = newick_n_desc( $node );
1141 :     if ( $imax < 1 ) { return ( newick_lbl( $node ) eq $tip ) ? @path0 : () }
1142 :    
1143 :     # Special case for tree rooted on tip
1144 :    
1145 :     if ( ( $imax == 1 ) # One descendant
1146 :     && ( @path0 == 1 ) # First step in path
1147 :     && ( newick_lbl( $node ) eq $tip ) # Label matches
1148 :     ) { return @path0 }
1149 :    
1150 :     my @path;
1151 :     for (my $i = 1; $i <= $imax; $i++ ) {
1152 :     @path = path_to_tip( newick_desc_i( $node, $i ), $tip, ( @path0, $i ) );
1153 :     if ( @path ) { return @path }
1154 :     }
1155 :    
1156 :     (); # Not found
1157 :     }
1158 :    
1159 :    
1160 :     #-------------------------------------------------------------------------------
1161 :     # Path to named node.
1162 :     # Like path to tip, but will find named internal nodes as well.
1163 :     #
1164 :     # @path = path_to_named_node( $treenode, $name )
1165 :     #-------------------------------------------------------------------------------
1166 :     sub path_to_named_node {
1167 :     my ( $node, $name, @path0 ) = @_;
1168 :    
1169 :     push @path0, $node;
1170 :     if ( newick_lbl( $node ) eq $name ) { return @path0 }
1171 :    
1172 :     my @path;
1173 :     my $imax = newick_n_desc( $node );
1174 :     for ( my $i = 1; $i <= $imax; $i++ ) {
1175 :     @path = path_to_named_node( newick_desc_i( $node, $i ), $name, ( @path0, $i ) );
1176 :     if ( @path ) { return @path }
1177 :     }
1178 :    
1179 :     (); # Not found
1180 :     }
1181 :    
1182 :    
1183 :     #-------------------------------------------------------------------------------
1184 :     # Path to node reference.
1185 :     #
1186 :     # @path = path_to_node_ref( $treenode, $noderef )
1187 :     #-------------------------------------------------------------------------------
1188 :     sub path_to_node_ref {
1189 :     my ( $node, $noderef, @path0 ) = @_;
1190 :    
1191 :     push @path0, $node;
1192 :     if ( $node eq $noderef ) { return @path0 }
1193 :    
1194 :     my @path;
1195 :     my $imax = newick_n_desc( $node );
1196 :     for ( my $i = 1; $i <= $imax; $i++ ) {
1197 : golsen 1.12 @path = path_to_node_ref( newick_desc_i( $node, $i ), $noderef, ( @path0, $i ) );
1198 :     return @path if @path;
1199 : golsen 1.1 }
1200 :    
1201 :     (); # Not found
1202 :     }
1203 :    
1204 :    
1205 :     #-------------------------------------------------------------------------------
1206 :     # Path to node, as defined by 1 or 3 tips.
1207 :     #
1208 :     # @path = path_to_node( $node, $tip1, $tip2, $tip3 ) # 3 tip names
1209 :     # @path = path_to_node( $node, [ $tip1, $tip2, $tip3 ] ) # Allow array ref
1210 :     # @path = path_to_node( $node, $tip1 ) # Use path_to_tip
1211 :     # @path = path_to_node( $node, [ $tip1 ] ) # Use path_to_tip
1212 :     #-------------------------------------------------------------------------------
1213 :     sub path_to_node {
1214 :     my ( $node, $tip1, $tip2, $tip3 ) = @_;
1215 :     array_ref( $node ) && defined( $tip1 ) || return ();
1216 :    
1217 :     # Allow arg 2 to be an array reference
1218 :     if ( array_ref( $tip1 ) ) { ( $tip1, $tip2, $tip3 ) = @$tip1 }
1219 :    
1220 :     my @p1 = path_to_tip( $node, $tip1 ); # Path to first tip
1221 :     @p1 || return (); # Was the tip found?
1222 :     defined( $tip2 ) && defined( $tip3 ) || return @p1; # Two more defined?
1223 :    
1224 :     my @p2 = path_to_tip( $node, $tip2 );
1225 :     my @p3 = path_to_tip( $node, $tip3 );
1226 :     @p2 && @p3 || return (); # Were they found?
1227 :    
1228 :     # Find the common prefix for each pair of paths
1229 : golsen 1.9 my @p12 = &common_prefix( \@p1, \@p2 );
1230 :     my @p13 = &common_prefix( \@p1, \@p3 );
1231 :     my @p23 = &common_prefix( \@p2, \@p3 );
1232 : golsen 1.1
1233 :     # Return the longest common prefix of any two paths
1234 :     ( @p12 >= @p13 && @p12 >= @p23 ) ? @p12 :
1235 :     ( @p13 >= @p23 ) ? @p13 :
1236 :     @p23 ;
1237 :     }
1238 :    
1239 :    
1240 :     #-------------------------------------------------------------------------------
1241 :     # Distance along path.
1242 :     #
1243 :     # $distance = newick_path_length( @path )
1244 :     #-------------------------------------------------------------------------------
1245 :     sub newick_path_length {
1246 :     my $node = shift; # Discard the first node
1247 :     array_ref( $node ) || return undef;
1248 :     @_ ? distance_along_path_2( @_ ) : 0;
1249 :     }
1250 :    
1251 :    
1252 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1253 :     # This expects to get path minus root node:
1254 :     #
1255 :     # $distance = distance_along_path_2( @path )
1256 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1257 :     sub distance_along_path_2 {
1258 :     shift; # Discard descendant number
1259 :     my $node = shift;
1260 :     array_ref( $node ) || return undef;
1261 :     my $d1 = newick_x( $node );
1262 : golsen 1.8 my $d2 = @_ ? distance_along_path_2( @_ ) : 0;
1263 : golsen 1.1 defined( $d1 ) && defined( $d2 ) ? $d1 + $d2 : undef;
1264 :     }
1265 :    
1266 :    
1267 :     #-------------------------------------------------------------------------------
1268 :     # Tip-to-tip distance.
1269 :     #
1270 :     # $distance = tip_to_tip_distance( $tree, $tip1, $tip2 )
1271 :     #-------------------------------------------------------------------------------
1272 :     sub tip_to_tip_distance {
1273 :     my ( $node, $tip1, $tip2 ) = @_;
1274 :    
1275 :     array_ref( $node ) && defined( $tip1 )
1276 :     && defined( $tip2 ) || return undef;
1277 :     my @p1 = path_to_tip( $node, $tip1 );
1278 :     my @p2 = path_to_tip( $node, $tip2 );
1279 :     @p1 && @p2 || return undef; # Were they found?
1280 :    
1281 :     # Find the unique suffixes of the two paths
1282 : golsen 1.9 my ( $suf1, $suf2 ) = &unique_suffixes( \@p1, \@p2 ); # Common node is lost
1283 : golsen 1.1 my $d1 = @$suf1 ? distance_along_path_2( @$suf1 ) : 0;
1284 :     my $d2 = @$suf2 ? distance_along_path_2( @$suf2 ) : 0;
1285 :    
1286 :     defined( $d1 ) && defined( $d2 ) ? $d1 + $d2 : undef;
1287 :     }
1288 :    
1289 :    
1290 :     #-------------------------------------------------------------------------------
1291 :     # Node-to-node distance.
1292 :     # Nodes can be: $tipname
1293 :     # [ $tipname ]
1294 :     # [ $tipname1, $tipname2, $tipname3 ]
1295 :     #
1296 :     # $distance = node_to_node_distance( $tree, $node1, $node2 )
1297 :     #-------------------------------------------------------------------------------
1298 :     sub node_to_node_distance {
1299 :     my ( $node, $node1, $node2 ) = @_;
1300 :    
1301 :     array_ref( $node ) && defined( $node1 )
1302 :     && defined( $node2 ) || return undef;
1303 : golsen 1.8 my @p1 = path_to_node( $node, $node1 ) or return undef;
1304 :     my @p2 = path_to_node( $node, $node2 ) or return undef;
1305 : golsen 1.1
1306 :     # Find the unique suffixes of the two paths
1307 : golsen 1.9 my ( $suf1, $suf2 ) = &unique_suffixes( \@p1, \@p2 ); # Common node is lost
1308 : golsen 1.1 my $d1 = @$suf1 ? distance_along_path_2( @$suf1 ) : 0;
1309 :     my $d2 = @$suf2 ? distance_along_path_2( @$suf2 ) : 0;
1310 :    
1311 :     defined( $d1 ) && defined( $d2 ) ? $d1 + $d2 : undef;
1312 :     }
1313 :    
1314 :    
1315 :     #===============================================================================
1316 :     # Tree manipulations:
1317 :     #===============================================================================
1318 :     # Copy tree.
1319 :     # Lists are copied, except that references to empty lists go to undef.
1320 :     # Only defined fields are added, so tree list may be shorter than 8 fields.
1321 :     #
1322 : overbeek 1.4 # $treecopy = copy_newick_tree( $tree )
1323 : golsen 1.1 #-------------------------------------------------------------------------------
1324 : overbeek 1.4 sub copy_newick_tree {
1325 : golsen 1.1 my ( $node ) = @_;
1326 :     array_ref( $node ) || return undef;
1327 :    
1328 :     my $nn = []; # Reference to a new node structure
1329 :     # Build a new descendant list, if not empty
1330 :     my @dl = newick_desc_list( $node );
1331 : overbeek 1.4 set_newick_desc_ref( $nn, @dl ? [ map { copy_newick_tree( $_ ) } @dl ]
1332 : golsen 1.1 : undef
1333 :     );
1334 :    
1335 :     # Copy label and x, if defined
1336 :     my ( $l, $x );
1337 :     if ( defined( $l = newick_lbl( $node ) ) ) { set_newick_lbl( $nn, $l ) }
1338 :     if ( defined( $x = newick_x( $node ) ) ) { set_newick_x( $nn, $x ) }
1339 :    
1340 :     # Build new comment lists, when not empty ( does not extend array unless
1341 :     # necessary)
1342 :     my $c;
1343 :     if ( $c = newick_c1( $node ) and @$c ) { set_newick_c1( $nn, [ @$c ] ) }
1344 :     if ( $c = newick_c2( $node ) and @$c ) { set_newick_c2( $nn, [ @$c ] ) }
1345 :     if ( $c = newick_c3( $node ) and @$c ) { set_newick_c3( $nn, [ @$c ] ) }
1346 :     if ( $c = newick_c4( $node ) and @$c ) { set_newick_c4( $nn, [ @$c ] ) }
1347 :     if ( $c = newick_c5( $node ) and @$c ) { set_newick_c5( $nn, [ @$c ] ) }
1348 :    
1349 :     $nn;
1350 :     }
1351 :    
1352 :    
1353 :     #-------------------------------------------------------------------------------
1354 :     # Use a hash to relabel the nodes in a newick tree.
1355 :     #
1356 :     # $newtree = newick_relabel_nodes( $node, \%new_name )
1357 :     #-------------------------------------------------------------------------------
1358 :     sub newick_relabel_nodes {
1359 :     my ( $node, $new_name ) = @_;
1360 :    
1361 :     my ( $lbl, $new );
1362 :     if ( defined( $lbl = newick_lbl( $node ) )
1363 :     && ( $lbl ne "" )
1364 :     && defined( $new = $new_name->{ $lbl } )
1365 :     ) {
1366 :     set_newick_lbl( $node, $new );
1367 :     }
1368 :    
1369 :     foreach ( newick_desc_list( $node ) ) {
1370 :     newick_relabel_nodes( $_, $new_name );
1371 :     }
1372 :    
1373 :     $node;
1374 :     }
1375 :    
1376 :    
1377 :     #-------------------------------------------------------------------------------
1378 :     # Use a hash to relabel the nodes in a newick tree (case insensitive).
1379 :     #
1380 :     # $newtree = newick_relabel_nodes_i( $node, \%new_name )
1381 :     #-------------------------------------------------------------------------------
1382 :     sub newick_relabel_nodes_i {
1383 :     my ( $node, $new_name ) = @_;
1384 :    
1385 :     # Add any necessary lowercase keys to the hash:
1386 :    
1387 :     my $lc_lbl;
1388 :     foreach ( keys %$new_name ) {
1389 :     $lc_lbl = lc $_;
1390 :     ( $lc_lbl eq $_ ) or ( $new_name->{ $lc_lbl } = $new_name->{ $_ } );
1391 :     }
1392 :    
1393 :     newick_relabel_nodes_i2( $node, $new_name );
1394 :     }
1395 :    
1396 :    
1397 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1398 :     # Do the actual relabeling
1399 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1400 :     sub newick_relabel_nodes_i2 {
1401 :     my ( $node, $new_name ) = @_;
1402 :    
1403 :     my ( $lbl, $new );
1404 :     if ( defined( $lbl = newick_lbl( $node ) )
1405 :     && ( $lbl ne "" )
1406 :     && defined( $new = $new_name->{ lc $lbl } )
1407 :     ) {
1408 :     set_newick_lbl( $node, $new );
1409 :     }
1410 :    
1411 :     foreach ( newick_desc_list( $node ) ) {
1412 :     newick_relabel_nodes_i2( $_, $new_name );
1413 :     }
1414 :    
1415 :     $node;
1416 :     }
1417 :    
1418 :    
1419 :     #-------------------------------------------------------------------------------
1420 :     # Use a hash to relabel the tips in a newick tree.
1421 :     #
1422 :     # $newtree = newick_relabel_tips( $node, \%new_name )
1423 :     #-------------------------------------------------------------------------------
1424 :     sub newick_relabel_tips {
1425 :     my ( $node, $new_name ) = @_;
1426 :    
1427 :     my @desc = newick_desc_list( $node );
1428 :    
1429 :     if ( @desc ) {
1430 :     foreach ( @desc ) { newick_relabel_tips( $_, $new_name ) }
1431 :     }
1432 :     else {
1433 :     my ( $lbl, $new );
1434 :     if ( defined( $lbl = newick_lbl( $node ) )
1435 :     && ( $lbl ne "" )
1436 :     && defined( $new = $new_name->{ $lbl } )
1437 :     ) {
1438 :     set_newick_lbl( $node, $new );
1439 :     }
1440 :     }
1441 :    
1442 :     $node;
1443 :     }
1444 :    
1445 :    
1446 :     #-------------------------------------------------------------------------------
1447 :     # Use a hash to relabel the tips in a newick tree (case insensitive).
1448 :     #
1449 :     # $newtree = newick_relabel_tips_i( $node, \%new_name )
1450 :     #-------------------------------------------------------------------------------
1451 :     sub newick_relabel_tips_i {
1452 :     my ( $node, $new_name ) = @_;
1453 :    
1454 :     # Add any necessary lowercase keys to the hash:
1455 :    
1456 :     my $lc_lbl;
1457 :     foreach ( keys %$new_name ) {
1458 :     $lc_lbl = lc $_;
1459 :     ( $lc_lbl eq $_ ) or ( $new_name->{ $lc_lbl } = $new_name->{ $_ } );
1460 :     }
1461 :    
1462 :     newick_relabel_tips_i2( $node, $new_name );
1463 :     }
1464 :    
1465 :    
1466 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1467 :     # Do the actual relabeling
1468 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1469 :     sub newick_relabel_tips_i2 {
1470 :     my ( $node, $new_name ) = @_;
1471 :    
1472 :     my @desc = newick_desc_list( $node );
1473 :    
1474 :     if ( @desc ) {
1475 :     foreach ( @desc ) { newick_relabel_tips_i2( $_, $new_name ) }
1476 :     }
1477 :     else {
1478 :     my ( $lbl, $new );
1479 :     if ( defined( $lbl = newick_lbl( $node ) )
1480 :     && ( $lbl ne "" )
1481 :     && defined( $new = $new_name->{ lc $lbl } )
1482 :     ) {
1483 :     set_newick_lbl( $node, $new );
1484 :     }
1485 :     }
1486 :    
1487 :     $node;
1488 :     }
1489 :    
1490 :    
1491 :     #-------------------------------------------------------------------------------
1492 :     # Set undefined branch lenghts (except root) to length x.
1493 :     #
1494 :     # $n_changed = newick_set_undefined_branches( $node, $x )
1495 :     #-------------------------------------------------------------------------------
1496 :     sub newick_set_undefined_branches {
1497 :     my ( $node, $x, $not_root ) = @_;
1498 :    
1499 :     my $n = 0;
1500 :     if ( $not_root && ! defined( newick_x( $node ) ) ) {
1501 :     set_newick_x( $node, $x );
1502 :     $n++;
1503 :     }
1504 :    
1505 :     foreach ( newick_desc_list( $node ) ) {
1506 :     $n += newick_set_undefined_branches( $_, $x, 1 );
1507 :     }
1508 :    
1509 :     $n;
1510 :     }
1511 :    
1512 :    
1513 :     #-------------------------------------------------------------------------------
1514 :     # Set all branch lenghts (except root) to length x.
1515 :     #
1516 :     # $n_changed = newick_set_all_branches( $node, $x )
1517 :     #-------------------------------------------------------------------------------
1518 :     sub newick_set_all_branches {
1519 :     my ( $node, $x, $not_root ) = @_;
1520 :    
1521 :     my $n = 0;
1522 : overbeek 1.7 if ( $not_root )
1523 :     {
1524 : golsen 1.1 set_newick_x( $node, $x );
1525 :     $n++;
1526 :     }
1527 :    
1528 : overbeek 1.7 foreach ( newick_desc_list( $node ) )
1529 :     {
1530 : golsen 1.1 $n += newick_set_all_branches( $_, $x, 1 );
1531 :     }
1532 :    
1533 :     $n;
1534 :     }
1535 :    
1536 :    
1537 :     #-------------------------------------------------------------------------------
1538 : overbeek 1.7 # Rescale all branch lenghts by factor.
1539 :     #
1540 :     # $node = newick_rescale_branches( $node, $factor )
1541 :     #-------------------------------------------------------------------------------
1542 :     sub newick_rescale_branches {
1543 :     my ( $node, $factor ) = @_;
1544 :    
1545 :     my $x = newick_x( $node );
1546 :     set_newick_x( $node, $factor * $x ) if $x;
1547 :    
1548 :     foreach ( newick_desc_list( $node ) )
1549 :     {
1550 :     newick_rescale_branches( $_, $factor );
1551 :     }
1552 :    
1553 :     $node;
1554 :     }
1555 :    
1556 :    
1557 :     #-------------------------------------------------------------------------------
1558 : golsen 1.15 # Modify all branch lengths by a function.
1559 :     #
1560 :     # $node = newick_modify_branches( $node, \&function )
1561 :     # $node = newick_modify_branches( $node, \&function, \@func_parms )
1562 :     #
1563 :     # Function must have form
1564 :     #
1565 :     # $x2 = &$function( $x1 )
1566 :     # $x2 = &$function( $x1, @$func_parms )
1567 :     #
1568 :     #-------------------------------------------------------------------------------
1569 :     sub newick_modify_branches {
1570 :     my ( $node, $func, $parm ) = @_;
1571 :    
1572 :     set_newick_x( $node, &$func( newick_x( $node ), ( $parm ? @$parm : () ) ) );
1573 :     foreach ( newick_desc_list( $node ) )
1574 :     {
1575 :     newick_modify_branches( $_, $func, $parm )
1576 :     }
1577 :    
1578 :     $node;
1579 :     }
1580 :    
1581 :    
1582 :     #-------------------------------------------------------------------------------
1583 : golsen 1.5 # Set negative branches to zero. The original tree is modfied.
1584 :     #
1585 :     # $n_changed = newick_fix_negative_branches( $tree )
1586 :     #-------------------------------------------------------------------------------
1587 :     sub newick_fix_negative_branches {
1588 :     my ( $tree ) = @_;
1589 :     array_ref( $tree ) or return undef;
1590 :     my $n_changed = 0;
1591 :     my $x = newick_x( $tree );
1592 :     if ( defined( $x ) and $x < 0 )
1593 :     {
1594 :     set_newick_x( $tree, 0 );
1595 :     $n_changed++;
1596 :     }
1597 :    
1598 :     foreach ( newick_desc_list( $tree ) )
1599 :     {
1600 :     $n_changed += newick_fix_negative_branches( $_ );
1601 :     }
1602 :    
1603 :     $n_changed;
1604 :     }
1605 :    
1606 :    
1607 :     #-------------------------------------------------------------------------------
1608 : golsen 1.8 # Remove comments from a newick tree (e.g., before writing for phylip).
1609 :     #
1610 :     # $node = newick_strip_comments( $node )
1611 :     #-------------------------------------------------------------------------------
1612 :     sub newick_strip_comments {
1613 :     my ( $node ) = @_;
1614 :    
1615 :     @$node = @$node[ 0 .. 2 ];
1616 :     foreach ( newick_desc_list( $node ) ) { newick_strip_comments( $_ ) }
1617 :     $node;
1618 :     }
1619 :    
1620 :    
1621 :     #-------------------------------------------------------------------------------
1622 : golsen 1.1 # Normalize tree order (in place).
1623 :     #
1624 :     # ( $tree, $label1 ) = normalize_newick_tree( $tree )
1625 :     #-------------------------------------------------------------------------------
1626 :     sub normalize_newick_tree {
1627 :     my ( $node ) = @_;
1628 :    
1629 :     my @descends = newick_desc_list( $node );
1630 :     if ( @descends == 0 ) { return ( $node, lc newick_lbl( $node ) ) }
1631 :    
1632 : golsen 1.9 my %hash = map { ( normalize_newick_tree($_) )[1] => $_ } @descends;
1633 : golsen 1.1 my @keylist = sort { $a cmp $b } keys %hash;
1634 :     set_newick_desc_list( $node, map { $hash{$_} } @keylist );
1635 :    
1636 :     ( $node, $keylist[0] );
1637 :     }
1638 :    
1639 :    
1640 :     #-------------------------------------------------------------------------------
1641 :     # Reverse tree order (in place).
1642 :     #
1643 :     # $tree = reverse_newick_tree( $tree )
1644 :     #-------------------------------------------------------------------------------
1645 :     sub reverse_newick_tree {
1646 :     my ( $node ) = @_;
1647 :    
1648 :     my @descends = newick_desc_list( $node );
1649 :     if ( @descends ) {
1650 :     set_newick_desc_list( $node, reverse @descends );
1651 :     foreach ( @descends ) { reverse_newick_tree( $_ ) }
1652 :     }
1653 :     $node;
1654 :     }
1655 :    
1656 :    
1657 :     #-------------------------------------------------------------------------------
1658 :     # Standard unrooted tree (in place).
1659 :     #
1660 :     # $stdtree = std_unrooted_newick( $tree )
1661 :     #-------------------------------------------------------------------------------
1662 :     sub std_unrooted_newick {
1663 :     my ( $tree ) = @_;
1664 :    
1665 :     my ( $mintip ) = sort { lc $a cmp lc $b } newick_tip_list( $tree );
1666 :     ( normalize_newick_tree( reroot_newick_next_to_tip( $tree, $mintip ) ) )[0];
1667 :     }
1668 :    
1669 :    
1670 :     #-------------------------------------------------------------------------------
1671 : golsen 1.20 # Standard name for a Newick tree topology
1672 :     #
1673 :     # $stdname = std_tree_name( $tree )
1674 :     #
1675 :     #-------------------------------------------------------------------------------
1676 :     sub std_tree_name
1677 :     {
1678 :     my ( $tree ) = @_;
1679 :     my ( $mintip ) = sort { lc $a cmp lc $b } newick_tip_list( $tree );
1680 :     ( std_tree_name_2( reroot_newick_next_to_tip( copy_newick_tree( $tree ), $mintip ) ) )[0];
1681 :     }
1682 :    
1683 :    
1684 :     #
1685 :     # ( $name, $mintip ) = std_tree_name_2( $node )
1686 :     #
1687 :     sub std_tree_name_2
1688 :     {
1689 :     my ( $node ) = @_;
1690 :    
1691 :     my @descends = newick_desc_list( $node );
1692 :     if ( @descends == 0 )
1693 :     {
1694 :     my $lbl = newick_lbl( $node );
1695 :     return ( $lbl, $lbl );
1696 :     }
1697 :    
1698 :     my @list = sort { lc $a->[1] cmp lc $b->[1] || $a->[1] cmp $b->[1] }
1699 :     map { [ std_tree_name_2( $_ ) ] }
1700 :     @descends;
1701 :     my $mintip = $list[0]->[1];
1702 :     my $name = '(' . join( "\t", map { $_->[0] } @list ) . ')';
1703 :    
1704 :     return ( $name, $mintip );
1705 :     }
1706 :    
1707 :    
1708 :     #-------------------------------------------------------------------------------
1709 : golsen 1.1 # Move largest groups to periphery of tree (in place).
1710 :     #
1711 :     # dir <= -2 for up-sweeping tree (big groups always first),
1712 :     # = -1 for big group first, balanced tree,
1713 :     # = 0 for balanced tree,
1714 :     # = 1 for small group first, balanced tree, and
1715 :     # >= 2 for down-sweeping tree (small groups always top)
1716 :     #
1717 :     # $tree = aesthetic_newick_tree( $treeref, $dir )
1718 :     #-------------------------------------------------------------------------------
1719 :     sub aesthetic_newick_tree {
1720 :     my ( $tree, $dir ) = @_;
1721 :     my %cnt;
1722 :    
1723 :     $dir = ! $dir ? 0 : # Undefined or zero
1724 :     $dir <= -2 ? -1000000 :
1725 :     $dir < 0 ? -1 :
1726 :     $dir >= 2 ? 1000000 :
1727 :     1 ;
1728 :     build_tip_count_hash( $tree, \%cnt );
1729 :     reorder_by_tip_count( $tree, \%cnt, $dir );
1730 :     }
1731 :    
1732 :    
1733 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1734 :     # Build a hash to look up the number of descendants of each node.
1735 :     # Access count with $cntref->{$noderef}
1736 :     #
1737 :     # $count = build_tip_count_hash( $node, $cnt_hash_ref )
1738 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1739 :     sub build_tip_count_hash {
1740 :     my ( $node, $cntref ) = @_;
1741 :     my ( $i, $cnt );
1742 :    
1743 :     if ( newick_n_desc( $node ) < 1 ) { $cnt = 1 }
1744 :     else {
1745 :     $cnt = 0;
1746 :     foreach ( newick_desc_list( $node ) ) {
1747 :     $cnt += build_tip_count_hash( $_, $cntref );
1748 :     }
1749 :     }
1750 :    
1751 :     $cntref->{$node} = $cnt;
1752 :     $cnt;
1753 :     }
1754 :    
1755 :    
1756 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1757 :     # $node = reorder_by_tip_count( $node, $cntref, $dir )
1758 :     # dir < 0 for upward branch (big group first),
1759 :     # = 0 for no change, and
1760 :     # > 0 for downward branch (small group first).
1761 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1762 :     sub reorder_by_tip_count {
1763 :     my ( $node, $cntref, $dir ) = @_;
1764 :    
1765 :     my $nd = newick_n_desc( $node );
1766 :     if ( $nd < 1 ) { return $node } # Do nothing to a tip
1767 :    
1768 : golsen 1.16 my $dl_ref = newick_desc_ref( $node );
1769 :    
1770 :     # Reorder this subtree (biggest subtrees to outside)
1771 :    
1772 :     if ( $dir )
1773 :     {
1774 :     # Big group first
1775 :     my @dl = sort { $cntref->{$b} <=> $cntref->{$a} } @$dl_ref;
1776 :    
1777 :     my ( @dl1, @dl2 );
1778 :     for ( my $i = 0; $i < $nd; $i++ ) {
1779 :     if ( $i & 1 ) { push @dl2, $dl[$i] } else { push @dl1, $dl[$i] }
1780 :     }
1781 : golsen 1.1
1782 : golsen 1.16 @$dl_ref = ( $dir < 0 ) ? ( @dl1, reverse @dl2 )
1783 :     : ( @dl2, reverse @dl1 );
1784 : golsen 1.1 }
1785 :    
1786 :     # Reorder within descendant subtrees:
1787 :    
1788 :     my $step = 0;
1789 :     if ( abs( $dir ) < 1e5 ) {
1790 :     $dir = 1 - $nd; # Midgroup => as is
1791 :     # $dir = 1 - $nd + ( $dir < 0 ? -0.5 : 0.5 ); # Midgroup => outward
1792 :     $step = 2;
1793 :     }
1794 :    
1795 :     for ( my $i = 0; $i < $nd; $i++ ) {
1796 :     reorder_by_tip_count( $dl_ref->[$i], $cntref, $dir );
1797 :     $dir += $step;
1798 :     }
1799 :    
1800 :     $node;
1801 :     }
1802 :    
1803 :    
1804 :     #-------------------------------------------------------------------------------
1805 :     # Move smallest groups to periphery of tree (in place).
1806 :     #
1807 :     # dir <= -2 for up-sweeping tree (big groups always first),
1808 :     # = -1 for big group first, balanced tree,
1809 :     # = 0 for balanced tree,
1810 :     # = 1 for small group first, balanced tree, and
1811 :     # >= 2 for down-sweeping tree (small groups always top)
1812 :     #
1813 :     # $tree = unaesthetic_newick_tree( $treeref, $dir )
1814 :     #-------------------------------------------------------------------------------
1815 : golsen 1.9 sub unaesthetic_newick_tree
1816 :     {
1817 : golsen 1.1 my ( $tree, $dir ) = @_;
1818 :     my %cnt;
1819 :    
1820 :     $dir = ! $dir ? 0 : # Undefined or zero
1821 :     $dir <= -2 ? -1000000 :
1822 :     $dir < 0 ? -1 :
1823 :     $dir >= 2 ? 1000000 :
1824 :     1 ;
1825 :     build_tip_count_hash( $tree, \%cnt );
1826 :     reorder_against_tip_count( $tree, \%cnt, $dir );
1827 :     }
1828 :    
1829 :    
1830 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1831 :     # $node = reorder_by_tip_count( $node, $cntref, $dir )
1832 :     # dir < 0 for upward branch (big group first),
1833 :     # = 0 for no change, and
1834 :     # > 0 for downward branch (small group first).
1835 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1836 : golsen 1.9 sub reorder_against_tip_count
1837 :     {
1838 : golsen 1.1 my ( $node, $cntref, $dir ) = @_;
1839 :    
1840 :     my $nd = newick_n_desc( $node );
1841 :     if ( $nd < 1 ) { return $node } # Do nothing to a tip
1842 :    
1843 :     # Reorder this subtree:
1844 :    
1845 :     my $dl_ref = newick_desc_ref( $node );
1846 :     if ( $dir > 0 ) { # Big group first
1847 :     @$dl_ref = sort { $cntref->{$b} <=> $cntref->{$a} } @$dl_ref;
1848 :     }
1849 :     elsif ( $dir < 0 ) { # Small group first
1850 :     @$dl_ref = sort { $cntref->{$a} <=> $cntref->{$b} } @$dl_ref;
1851 :     }
1852 :    
1853 :     # Reorder within descendant subtrees:
1854 :    
1855 :     my $step = 0;
1856 :     if (abs( $dir ) < 1e5) {
1857 :     $dir = 1 - $nd; # Midgroup => as is
1858 :     # $dir = 1 - $nd + ( $dir < 0 ? -0.5 : 0.5 ); # Midgroup => outward
1859 :     $step = 2;
1860 :     }
1861 :    
1862 :     for ( my $i = 0; $i < $nd; $i++ ) {
1863 :     reorder_by_tip_count( $dl_ref->[$i], $cntref, $dir );
1864 :     $dir += $step;
1865 :     }
1866 :    
1867 :     $node;
1868 :     }
1869 :    
1870 :    
1871 :     #-------------------------------------------------------------------------------
1872 :     # Randomize descendant order at each node (in place).
1873 :     #
1874 :     # $tree = random_order_newick_tree( $tree )
1875 :     #-------------------------------------------------------------------------------
1876 : golsen 1.9 sub random_order_newick_tree
1877 :     {
1878 : golsen 1.1 my ( $node ) = @_;
1879 :    
1880 :     my $nd = newick_n_desc( $node );
1881 :     if ( $nd < 1 ) { return $node } # Do nothing to a tip
1882 :    
1883 :     # Reorder this subtree:
1884 :    
1885 :     my $dl_ref = newick_desc_ref( $node );
1886 : golsen 1.9 @$dl_ref = &random_order( @$dl_ref );
1887 : golsen 1.1
1888 :     # Reorder descendants:
1889 :    
1890 :     foreach ( @$dl_ref ) { random_order_newick_tree( $_ ) }
1891 :    
1892 :     $node;
1893 :     }
1894 :    
1895 :    
1896 :     #-------------------------------------------------------------------------------
1897 :     # Reroot a tree to the node that lies at the end of a path.
1898 :     #
1899 :     # $newtree = reroot_newick_by_path( @path )
1900 :     #-------------------------------------------------------------------------------
1901 : golsen 1.9 sub reroot_newick_by_path
1902 :     {
1903 : golsen 1.1 my ( $node1, $path1, @rest ) = @_;
1904 :     array_ref( $node1 ) || return undef; # Always expect a node
1905 :    
1906 :     defined( $path1 ) && @rest || return $node1; # If no path, we're done
1907 :    
1908 :     my $node2 = $rest[0]; # Next element in path is node 2
1909 :     newick_desc_i( $node1, $path1 ) eq $node2 || return undef; # Check link
1910 :    
1911 :     # Remove node 2 from node 1 descendant list. Could use a simple splice:
1912 :     #
1913 :     # splice( @$dl1, $path1-1, 1 );
1914 :     #
1915 : golsen 1.8 # But the following maintains the cyclic order of the nodes:
1916 : golsen 1.1
1917 :     my $dl1 = newick_desc_ref( $node1 );
1918 :     my $nd1 = @$dl1;
1919 :     if ( $path1 == 1 ) { shift @$dl1 }
1920 :     elsif ( $path1 == $nd1 ) { pop @$dl1 }
1921 :     else { @$dl1 = ( @$dl1[ $path1 .. $nd1-1 ]
1922 :     , @$dl1[ 0 .. $path1-2 ]
1923 :     )
1924 : golsen 1.8 }
1925 : golsen 1.1
1926 :     # Append node 1 to node 2 descendant list (does not alter numbering):
1927 :    
1928 :     my $dl2 = newick_desc_ref( $node2 );
1929 :     if ( array_ref( $dl2 ) ) { push @$dl2, $node1 }
1930 : golsen 1.8 else { set_newick_desc_list( $node2, $node1 ) }
1931 : golsen 1.1
1932 :     # Move c1 comments from node 1 to node 2:
1933 :    
1934 :     my $C11 = newick_c1( $node1 );
1935 :     my $C12 = newick_c1( $node2 );
1936 :     ! defined( $C11 ) || set_newick_c1( $node1, undef ); # Remove them from node 1
1937 : golsen 1.8 if ( $C12 && @$C12 ) { # If node 2 comments and
1938 :     if ( $C11 && @$C11 ) { unshift @$C12, @$C11 } # Node 1, prefix 1 to 2
1939 : golsen 1.1 }
1940 : golsen 1.8 elsif ( $C11 && @$C11 ) { set_newick_c1( $node2, $C11 ) } # Otherwise move node 1 link
1941 : golsen 1.1
1942 :     # Swap branch lengths and comments for reversal of link direction:
1943 :    
1944 :     my $x1 = newick_x( $node1 );
1945 :     my $x2 = newick_x( $node2 );
1946 :     ! defined( $x1 ) && ! defined ( $x2 ) || set_newick_x( $node1, $x2 );
1947 :     ! defined( $x1 ) && ! defined ( $x2 ) || set_newick_x( $node2, $x1 );
1948 :    
1949 :     my $c41 = newick_c4( $node1 );
1950 :     my $c42 = newick_c4( $node2 );
1951 :     ! defined( $c42 ) || ! @$c42 || set_newick_c4( $node1, $c42 );
1952 :     ! defined( $c41 ) || ! @$c41 || set_newick_c4( $node2, $c41 );
1953 :    
1954 :     my $c51 = newick_c5( $node1 );
1955 :     my $c52 = newick_c5( $node2 );
1956 :     ! defined( $c52 ) || ! @$c52 || set_newick_c5( $node1, $c52 );
1957 :     ! defined( $c51 ) || ! @$c51 || set_newick_c5( $node2, $c51 );
1958 :    
1959 :     reroot_newick_by_path( @rest ); # Node 2 is first element of rest
1960 :     }
1961 :    
1962 :    
1963 :     #-------------------------------------------------------------------------------
1964 :     # Move root of tree to named tip.
1965 :     #
1966 :     # $newtree = reroot_newick_to_tip( $tree, $tip )
1967 :     #-------------------------------------------------------------------------------
1968 :     sub reroot_newick_to_tip {
1969 :     my ( $tree, $tipname ) = @_;
1970 :     reroot_newick_by_path( path_to_tip( $tree, $tipname ) );
1971 :     }
1972 :    
1973 :    
1974 :     #-------------------------------------------------------------------------------
1975 :     # Move root of tree to be node adjacent to a named tip.
1976 :     #
1977 :     # $newtree = reroot_newick_next_to_tip( $tree, $tip )
1978 :     #-------------------------------------------------------------------------------
1979 :     sub reroot_newick_next_to_tip {
1980 :     my ( $tree, $tipname ) = @_;
1981 :     my @path = path_to_tip( $tree, $tipname );
1982 :     @path || return undef;
1983 :     @path == 1 ? reroot_newick_by_path( $tree, 1, newick_desc_i( $tree, 1 ) )
1984 :     : reroot_newick_by_path( @path[0 .. @path-3] );
1985 :     }
1986 :    
1987 :    
1988 :     #-------------------------------------------------------------------------------
1989 :     # Move root of tree to a node, defined by 1 or 3 tip names.
1990 :     #
1991 :     # $newtree = reroot_newick_to_node( $tree, @node )
1992 :     #-------------------------------------------------------------------------------
1993 :     sub reroot_newick_to_node {
1994 :     reroot_newick_by_path( path_to_node( @_ ) );
1995 :     }
1996 :    
1997 :    
1998 :     #-------------------------------------------------------------------------------
1999 :     # Move root of tree to a node, defined by reference.
2000 :     #
2001 :     # $newtree = reroot_newick_to_node_ref( $tree, $noderef )
2002 :     #-------------------------------------------------------------------------------
2003 :     sub reroot_newick_to_node_ref {
2004 :     my ( $tree, $node ) = @_;
2005 :     reroot_newick_by_path( path_to_node_ref( $tree, $node ) );
2006 :     }
2007 :    
2008 :    
2009 :     #-------------------------------------------------------------------------------
2010 : golsen 1.9 # Reroot a newick tree along the path between 2 nodes:
2011 :     #
2012 :     # $tree = reroot_newick_between_nodes( $tree, $node1, $node2, $fraction )
2013 :     #-------------------------------------------------------------------------------
2014 :     sub reroot_newick_between_nodes
2015 :     {
2016 :     my ( $tree, $node1, $node2, $fraction ) = @_;
2017 :     array_ref( $tree ) or return undef;
2018 :     $fraction >= 0 && $fraction <= 1 or return undef;
2019 :    
2020 :     # Find the paths to the nodes:
2021 :    
2022 :     my @path1 = path_to_node( $tree, $node1 ) or return undef;
2023 :     my @path2 = path_to_node( $tree, $node2 ) or return undef;
2024 :    
2025 : golsen 1.12 reroot_newick_between_nodes_by_path( $tree, \@path1, \@path2, $fraction )
2026 :     }
2027 :    
2028 :    
2029 :     #-------------------------------------------------------------------------------
2030 :     # Reroot a newick tree along the path between 2 nodes:
2031 :     #
2032 :     # $tree = reroot_newick_between_node_refs( $tree, $node1, $node2, $fraction )
2033 :     #-------------------------------------------------------------------------------
2034 :     sub reroot_newick_between_node_refs
2035 :     {
2036 :     my ( $tree, $node1, $node2, $fraction ) = @_;
2037 :     array_ref( $tree ) or return undef;
2038 :    
2039 :     # Find the paths to the nodes:
2040 :    
2041 :     my @path1 = path_to_node_ref( $tree, $node1 ) or return undef;
2042 :     my @path2 = path_to_node_ref( $tree, $node2 ) or return undef;;
2043 :    
2044 :     reroot_newick_between_nodes_by_path( $tree, \@path1, \@path2, $fraction )
2045 :     }
2046 :    
2047 :    
2048 :     #-------------------------------------------------------------------------------
2049 :     # Reroot a newick tree along the path between 2 nodes defined by paths:
2050 :     #
2051 :     # $tree = reroot_newick_between_nodes_by_path( $tree, $path1, $path2, $fraction )
2052 :     #-------------------------------------------------------------------------------
2053 :     sub reroot_newick_between_nodes_by_path
2054 :     {
2055 :     my ( $tree, $path1, $path2, $fraction ) = @_;
2056 :     array_ref( $tree ) and array_ref( $path1 ) and array_ref( $path2 )
2057 :     or return undef;
2058 :     $fraction >= 0 && $fraction <= 1 or return undef;
2059 :    
2060 :     my @path1 = @$path1;
2061 :     my @path2 = @$path2;
2062 :    
2063 : golsen 1.9 # Trim the common prefix, saving it:
2064 :    
2065 :     my @prefix = ();
2066 : golsen 1.15 while ( defined( $path1[1] ) && defined( $path2[1] ) && ( $path1[1] == $path2[1] ) )
2067 : golsen 1.9 {
2068 :     push @prefix, splice( @path1, 0, 2 );
2069 :     splice( @path2, 0, 2 );
2070 :     }
2071 :    
2072 :     my ( @path, $dist );
2073 :     if ( @path1 < 3 )
2074 :     {
2075 :     @path2 >= 3 or return undef; # node1 = node2
2076 :     $dist = $fraction * newick_path_length( @path2 );
2077 :     @path = @path2;
2078 :     }
2079 :     elsif ( @path2 < 3 )
2080 :     {
2081 :     $dist = ( 1 - $fraction ) * newick_path_length( @path1 );
2082 :     @path = @path1;
2083 :     }
2084 :     else
2085 :     {
2086 :     my $dist1 = newick_path_length( @path1 );
2087 :     my $dist2 = newick_path_length( @path2 );
2088 :     $dist = $fraction * ( $dist1 + $dist2 ) - $dist1;
2089 :     @path = ( $dist <= 0 ) ? @path1 : @path2;
2090 :     $dist = abs( $dist );
2091 :     }
2092 :    
2093 :     # Descend tree until we reach the insertion branch:
2094 :    
2095 :     my $x;
2096 :     while ( ( $dist > ( $x = newick_x( $path[2] ) ) ) && ( @path > 3 ) )
2097 :     {
2098 :     $dist -= $x;
2099 :     push @prefix, splice( @path, 0, 2 );
2100 :     }
2101 :    
2102 :     # Insert the new node:
2103 :    
2104 :     my $newnode = [ [ $path[2] ], undef, $dist ];
2105 :     set_newick_desc_i( $path[0], $path[1], $newnode );
2106 :     set_newick_x( $path[2], ( ( $x > $dist ) ? ( $x - $dist ) : 0 ) );
2107 :    
2108 :     # We can now build the path from root to the new node
2109 :    
2110 :     reroot_newick_by_path( @prefix, @path[0,1], $newnode );
2111 :     }
2112 :    
2113 :    
2114 :     #-------------------------------------------------------------------------------
2115 : golsen 1.1 # Move root of tree to an approximate midpoint.
2116 :     #
2117 :     # $newtree = reroot_newick_to_approx_midpoint( $tree )
2118 :     #-------------------------------------------------------------------------------
2119 :     sub reroot_newick_to_approx_midpoint {
2120 :     my ( $tree ) = @_;
2121 : golsen 1.5
2122 : golsen 1.1 # Compile average tip to node distances assending
2123 :    
2124 :     my $dists1 = average_to_tips_1( $tree );
2125 :    
2126 : golsen 1.12 # Compile average tip to node distances descending, returning midpoint
2127 :     # cadidates as a list of [ $node1, $node2, $fraction ]
2128 :    
2129 :     my @mids = average_to_tips_2( $dists1, undef, undef );
2130 :    
2131 :     # Reroot to first midpoint candidate
2132 :    
2133 :     return $tree if ! @mids;
2134 :     my ( $node1, $node2, $fraction ) = @{ $mids[0] };
2135 :     reroot_newick_to_node_ref( $tree, $fraction >= 0.5 ? $node2 : $node1 );
2136 :     }
2137 :    
2138 :    
2139 :     #-------------------------------------------------------------------------------
2140 :     # Move root of tree to a midpoint.
2141 :     #
2142 :     # $newtree = reroot_newick_to_midpoint( $tree )
2143 :     #-------------------------------------------------------------------------------
2144 :     sub reroot_newick_to_midpoint {
2145 :     my ( $tree ) = @_;
2146 :    
2147 :     # Compile average tip to node distances assending
2148 :    
2149 :     my $dists1 = average_to_tips_1( $tree );
2150 : golsen 1.1
2151 : golsen 1.12 # Compile average tip to node distances descending, returning midpoint
2152 :     # [ $node1, $node2, $fraction ]
2153 : golsen 1.1
2154 : golsen 1.12 my @mids = average_to_tips_2( $dists1, undef, undef );
2155 : golsen 1.1
2156 : golsen 1.12 @mids ? reroot_newick_between_node_refs( $tree, @{ $mids[0] } ) : $tree;
2157 : golsen 1.1 }
2158 :    
2159 :    
2160 : golsen 1.12 #-------------------------------------------------------------------------------
2161 :     # Compile average tip to node distances assending
2162 :     #-------------------------------------------------------------------------------
2163 : golsen 1.1 sub average_to_tips_1 {
2164 :     my ( $node ) = @_;
2165 :    
2166 :     my @desc_dists = map { average_to_tips_1( $_ ) } newick_desc_list( $node );
2167 :     my $x_below = 0;
2168 :     if ( @desc_dists )
2169 :     {
2170 :     foreach ( @desc_dists ) { $x_below += $_->[0] }
2171 :     $x_below /= @desc_dists;
2172 :     }
2173 : golsen 1.12
2174 : golsen 1.1 my $x = newick_x( $node ) || 0;
2175 :     my $x_net = $x_below + $x;
2176 :    
2177 :     [ $x_net, $x, $x_below, [ @desc_dists ], $node ]
2178 :     }
2179 :    
2180 : golsen 1.9
2181 : golsen 1.12 #-------------------------------------------------------------------------------
2182 :     # Compile average tip to node distances descending, returning midpoint as
2183 :     # [ $node1, $node2, $fraction_of_dist_between ]
2184 :     #-------------------------------------------------------------------------------
2185 : golsen 1.1 sub average_to_tips_2 {
2186 :     my ( $dists1, $x_above, $anc_node ) = @_;
2187 :     my ( undef, $x, $x_below, $desc_list, $node ) = @$dists1;
2188 :    
2189 :     # Are we done? Root is in this node's branch, or "above"?
2190 :    
2191 : golsen 1.12 my @mids = ();
2192 : golsen 1.1 if ( defined( $x_above ) && ( ( $x_above + $x ) >= $x_below ) )
2193 :     {
2194 :     # At this point the root can only be in this node's branch,
2195 :     # or "above" it in the current rooting of the tree (which
2196 :     # would mean that the midpoint is actually down a different
2197 :     # path from the root of the current tree).
2198 :     #
2199 :     # Is the root in the current branch?
2200 :    
2201 :     if ( ( $x_below + $x ) >= $x_above )
2202 :     {
2203 : golsen 1.12 # We will need to make a new node for the root, $fract of
2204 :     # the way from $node to $anc_node:
2205 :     my $fract = ( $x > 0 ) ? 0.5 * ( ( $x_above - $x_below ) / $x + 1 )
2206 :     : 0.5;
2207 :     push @mids, [ $node, $anc_node, $fract ];
2208 : golsen 1.1 }
2209 :     }
2210 :    
2211 : golsen 1.12 # The root might be somewhere below this node:
2212 : golsen 1.1
2213 : golsen 1.5 my $n_1 = @$desc_list - ( $anc_node ? 0 : 1 );
2214 : golsen 1.1 my $ttl_dist = ( @$desc_list * $x_below ) + ( defined( $x_above ) ? ( $x_above + $x ) : 0 );
2215 :    
2216 :     foreach ( @$desc_list )
2217 :     {
2218 :     # If input tree is tip_rooted, $n-1 can be 0, so:
2219 :    
2220 :     my $above2 = $n_1 ? ( ( $ttl_dist - $_->[0] ) / $n_1 ) : 0;
2221 : golsen 1.12 push @mids, average_to_tips_2( $_, $above2, $node );
2222 : golsen 1.1 }
2223 :    
2224 : golsen 1.12 return @mids;
2225 : golsen 1.1 }
2226 :    
2227 : golsen 1.9
2228 : golsen 1.1 #-------------------------------------------------------------------------------
2229 : golsen 1.5 # Move root of tree to an approximate midpoint. Weight by tips.
2230 :     #
2231 :     # $newtree = reroot_newick_to_approx_midpoint_w( $tree )
2232 :     #-------------------------------------------------------------------------------
2233 :     sub reroot_newick_to_approx_midpoint_w {
2234 :     my ( $tree ) = @_;
2235 : golsen 1.21 array_ref( $tree ) or return undef;
2236 : golsen 1.5
2237 : golsen 1.12 # Compile average tip to node distances assending from tips
2238 :    
2239 :     my $dists1 = average_to_tips_1_w( $tree );
2240 :    
2241 :     # Compile average tip to node distances descending, returning midpoints
2242 :    
2243 :     my @mids = average_to_tips_2_w( $dists1, undef, undef, undef );
2244 :    
2245 :     # Reroot to first midpoint candidate
2246 :    
2247 :     return $tree if ! @mids;
2248 :     my ( $node1, $node2, $fraction ) = @{ $mids[0] };
2249 :     reroot_newick_to_node_ref( $tree, $fraction >= 0.5 ? $node2 : $node1 );
2250 :     }
2251 :    
2252 :    
2253 :     #-------------------------------------------------------------------------------
2254 :     # Move root of tree to an approximate midpoint. Weight by tips.
2255 :     #
2256 :     # $newtree = reroot_newick_to_midpoint_w( $tree )
2257 :     #-------------------------------------------------------------------------------
2258 :     sub reroot_newick_to_midpoint_w {
2259 :     my ( $tree ) = @_;
2260 : golsen 1.21 array_ref( $tree ) or return ();
2261 : golsen 1.12
2262 : golsen 1.5 # Compile average tip to node distances assending
2263 :    
2264 :     my $dists1 = average_to_tips_1_w( $tree );
2265 :    
2266 :     # Compile average tip to node distances descending, returning midpoint node
2267 :    
2268 : golsen 1.12 my @mids = average_to_tips_2_w( $dists1, undef, undef, undef );
2269 : golsen 1.5
2270 : golsen 1.12 # Reroot at first candidate midpoint
2271 : golsen 1.5
2272 : golsen 1.12 @mids ? reroot_newick_between_node_refs( $tree, @{ $mids[0] } ) : $tree;
2273 : golsen 1.5 }
2274 :    
2275 :    
2276 : golsen 1.21 #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2277 : golsen 1.5 sub average_to_tips_1_w {
2278 :     my ( $node ) = @_;
2279 :    
2280 :     my @desc_dists = map { average_to_tips_1_w( $_ ) } newick_desc_list( $node );
2281 :     my $x_below = 0;
2282 :     my $n_below = 1;
2283 :     if ( @desc_dists )
2284 :     {
2285 :     $n_below = 0;
2286 :     my $n;
2287 :     foreach ( @desc_dists )
2288 :     {
2289 :     $n_below += $n = $_->[1];
2290 :     $x_below += $n * $_->[0];
2291 :     }
2292 :     $x_below /= $n_below;
2293 :     }
2294 : golsen 1.12
2295 : golsen 1.5 my $x = newick_x( $node ) || 0;
2296 :     my $x_net = $x_below + $x;
2297 :    
2298 :     [ $x_net, $n_below, $x, $x_below, [ @desc_dists ], $node ]
2299 :     }
2300 :    
2301 :    
2302 : golsen 1.21 #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2303 : golsen 1.5 sub average_to_tips_2_w {
2304 :     my ( $dists1, $x_above, $n_above, $anc_node ) = @_;
2305 :     my ( undef, $n_below, $x, $x_below, $desc_list, $node ) = @$dists1;
2306 :    
2307 :     # Are we done? Root is in this node's branch, or "above"?
2308 :    
2309 : golsen 1.12 my @mids = ();
2310 : golsen 1.5 if ( defined( $x_above ) && ( ( $x_above + $x ) >= $x_below ) )
2311 :     {
2312 :     # At this point the root can only be in this node's branch,
2313 :     # or "above" it in the current rooting of the tree (which
2314 :     # would mean that the midpoint is actually down a different
2315 :     # path from the root of the current tree).
2316 :     #
2317 : golsen 1.12 # Is their a root in the current branch?
2318 : golsen 1.5
2319 :     if ( ( $x_below + $x ) >= $x_above )
2320 :     {
2321 : golsen 1.12 # We will need to make a new node for the root, $fract of
2322 :     # the way from $node to $anc_node:
2323 :     my $fract = ( $x > 0 ) ? 0.5 * ( ( $x_above - $x_below ) / $x + 1 )
2324 :     : 0.5;
2325 :     push @mids, [ $node, $anc_node, $fract ];
2326 : golsen 1.5 }
2327 :     }
2328 :    
2329 :     # The root must be some where below this node:
2330 :    
2331 :     $n_above ||= 0;
2332 :     my $n = $n_above + $n_below;
2333 :     my $ttl_w_dist = ( $n_below * $x_below )
2334 :     + ( defined( $x_above ) ? $n_above * ( $x_above + $x ) : 0 );
2335 :    
2336 :     foreach ( @$desc_list )
2337 :     {
2338 :     my $n_2 = $_->[1]; # n in subtree
2339 :     my $n_above2 = $n - $n_2; # tip rooted has 1 above
2340 :    
2341 :     # If input tree is tip_rooted, $n_above2 can be 0, so:
2342 :    
2343 :     my $x_above2 = $n_above2 ? ( ( $ttl_w_dist - $n_2 * $_->[0] ) / $n_above2 )
2344 :     : 0;
2345 : golsen 1.12 push @mids, average_to_tips_2_w( $_, $x_above2, $n_above2 || 1, $node );
2346 : golsen 1.5 }
2347 :    
2348 : golsen 1.12 return @mids;
2349 : golsen 1.5 }
2350 :    
2351 : golsen 1.9
2352 : golsen 1.5 #-------------------------------------------------------------------------------
2353 : golsen 1.1 # Move root of tree from tip to adjacent node.
2354 :     #
2355 :     # $newtree = uproot_tip_rooted_newick( $tree )
2356 :     #-------------------------------------------------------------------------------
2357 :     sub uproot_tip_rooted_newick {
2358 :     my ( $node ) = @_;
2359 :     newick_is_tip_rooted( $node ) || return $node;
2360 :    
2361 :     # Path to the sole descendant:
2362 :    
2363 :     reroot_newick_by_path( $node, 1, newick_desc_i( $node, 1 ) );
2364 :     }
2365 :    
2366 :    
2367 :     #-------------------------------------------------------------------------------
2368 :     # Remove root bifurcation.
2369 :     #
2370 :     # Root node label, label comment and descendant list comment are discarded.
2371 :     #
2372 :     # $newtree = uproot_newick( $tree )
2373 :     #-------------------------------------------------------------------------------
2374 :     sub uproot_newick {
2375 :     my ( $node0 ) = @_;
2376 :     newick_is_rooted( $node0 ) || return $node0;
2377 :    
2378 :     my ( $node1, $node2 ) = newick_desc_list( $node0 );
2379 :    
2380 :     # Ensure that node1 has at least 1 descendant
2381 :    
2382 :     if ( newick_n_desc( $node1 ) ) {
2383 :     push @{ newick_desc_ref( $node1 ) }, $node2; # Add node2 to descend list
2384 :     }
2385 :    
2386 :     # Or node2 has at least 1 descendant
2387 :    
2388 :     elsif ( newick_n_desc( $node2 ) ) {
2389 :     unshift @{ newick_desc_ref( $node2 ) }, $node1; # Add node1 to descend list
2390 :     ( $node1, $node2 ) = ( $node2, $node1 ); # And reverse labels
2391 :     }
2392 :    
2393 :     # We could make this into a tip rooted tree, but for now:
2394 :    
2395 :     else { return $node0 }
2396 :    
2397 :     # Prefix node1 branch to that of node2:
2398 :    
2399 :     add_to_newick_branch( $node2, $node1 );
2400 :     set_newick_x( $node1, undef );
2401 :    
2402 :     # Tree prefix comment lists (as references):
2403 :    
2404 :     my $C10 = newick_c1( $node0 );
2405 :     my $C11 = newick_c1( $node1 );
2406 : golsen 1.9 if ( $C11 && @$C11 ) {
2407 : golsen 1.1 if ( $C10 && @$C10 ) { unshift @$C11, @$C10 } # Prefix to node1 comments
2408 :     }
2409 :     elsif ( $C10 && @$C10 ) {
2410 :     set_newick_c1( $node1, $C10 ) # Or move node0 comments to node1
2411 :     }
2412 :    
2413 :     $node1;
2414 :     }
2415 :    
2416 :    
2417 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2418 :     # Prefix branch of node2 to that of node1:
2419 :     #
2420 :     # $node1 = add_to_newick_branch( $node1, $node2 )
2421 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2422 :     sub add_to_newick_branch {
2423 :     my ( $node1, $node2 ) = @_;
2424 :     array_ref( $node1 ) || die "add_to_newick_branch: arg 1 not array ref\n";
2425 :     array_ref( $node2 ) || die "add_to_newick_branch: arg 2 not array ref\n";
2426 :    
2427 :     # Node structure template:
2428 :     # my ( $DL, $L, $X, $C1, $C2, $C3, $C4, $C5 ) = @$node;
2429 :    
2430 :     # Fix branch lengths for joining of two branches:
2431 :    
2432 :     set_newick_x( $node1, newick_x( $node1 ) + newick_x( $node2 ) );
2433 :    
2434 :     # Merge branch length comments:
2435 :    
2436 :     my $C41 = newick_c4( $node1 ); # Ref to node1 C4
2437 :     my $C42 = newick_c4( $node2 ); # Ref to node2 C4
2438 :     if ( $C41 && @$C41 ) {
2439 :     if ( $C42 && @$C42 ) { unshift @$C41, @$C42 } # Add node2 comment
2440 :     }
2441 :     elsif ( $C42 && @$C42 ) { set_newick_c4( $node1, $C42 ) } # Or move node1 comment
2442 :    
2443 :     my $C51 = newick_c5( $node1 ); # Ref to node1 C5
2444 :     my $C52 = newick_c5( $node2 ); # Ref to node2 C5
2445 :     if ( $C51 && @$C51 ) {
2446 :     if ( $C52 && @$C52 ) { unshift @$C51, @$C52 } # Add node2 comment
2447 :     }
2448 :     elsif ( $C52 && @$C52 ) { set_newick_c5( $node1, $C52 ) } # Or move node1 comment
2449 :    
2450 :     $node1;
2451 :     }
2452 :    
2453 :    
2454 :     #-------------------------------------------------------------------------------
2455 : golsen 1.5 # Collapse zero-length branches to make multifurcation. The original tree
2456 :     # is modified.
2457 :     #
2458 :     # $tree = collapse_zero_length_branches( $tree )
2459 :     # $tree = collapse_zero_length_branches( $tree, $not_root )
2460 :     #-------------------------------------------------------------------------------
2461 :     sub collapse_zero_length_branches {
2462 :     my ( $tree, $not_root ) = @_;
2463 :     array_ref( $tree ) || return undef;
2464 :    
2465 :     my @desc = newick_desc_list( $tree );
2466 :     @desc or return ( $tree ); # Cannot collapse terminal branch
2467 :    
2468 :     # Analyze descendants:
2469 :    
2470 :     $not_root ||= 0;
2471 :     my @new_desc = ();
2472 :     my $changed = 0;
2473 :     foreach ( @desc )
2474 :     {
2475 :     my ( undef, @to_add ) = collapse_zero_length_branches( $_, $not_root+1 );
2476 :     if ( @to_add )
2477 :     {
2478 :     push @new_desc, @to_add;
2479 :     $changed = 1;
2480 :     }
2481 :     else
2482 :     {
2483 :     push @new_desc, $_;
2484 :     }
2485 :     }
2486 :     set_newick_desc_ref( $tree, [ @new_desc ] ) if $changed;
2487 :    
2488 :     # Collapse if not root, not tip and zero (or negative) branch:
2489 :    
2490 :     my $collapse = $not_root && @new_desc && ( newick_x( $tree ) <= 0 ) ? 1 : 0;
2491 :     ( $tree, ( $collapse ? @new_desc : () ) );
2492 :     }
2493 :    
2494 : golsen 1.8 #-------------------------------------------------------------------------------
2495 :     # Add a subtree to a newick tree node:
2496 :     #
2497 :     # $node = newick_insert_at_node( $node, $subtree )
2498 :     #-------------------------------------------------------------------------------
2499 :     sub newick_insert_at_node
2500 :     {
2501 :     my ( $node, $subtree ) = @_;
2502 :     array_ref( $node ) && array_ref( $subtree ) or return undef;
2503 :    
2504 :     # We could check validity of trees, but ....
2505 :    
2506 :     my $dl = newick_desc_ref( $node );
2507 :     if ( array_ref( $dl ) )
2508 :     {
2509 :     push @$dl, $subtree;
2510 :     }
2511 :     else
2512 :     {
2513 :     set_newick_desc_ref( $node, [ $subtree ] );
2514 :     }
2515 :     return $node;
2516 :     }
2517 :    
2518 :    
2519 :     #-------------------------------------------------------------------------------
2520 :     # Insert a subtree into a newick tree along the path between 2 nodes:
2521 :     #
2522 :     # $tree = newick_insert_between_nodes( $tree, $subtree, $node1, $node2, $fraction )
2523 :     #-------------------------------------------------------------------------------
2524 :     sub newick_insert_between_nodes
2525 :     {
2526 :     my ( $tree, $subtree, $node1, $node2, $fraction ) = @_;
2527 :     array_ref( $tree ) && array_ref( $subtree ) or return undef;
2528 :     $fraction >= 0 && $fraction <= 1 or return undef;
2529 :    
2530 :     # Find the paths to the nodes:
2531 :    
2532 :     my @path1 = path_to_node( $tree, $node1 ) or return undef;
2533 :     my @path2 = path_to_node( $tree, $node2 ) or return undef;
2534 :    
2535 :     # Trim the common prefix:
2536 :    
2537 :     while ( $path1[1] == $path2[1] )
2538 :     {
2539 :     splice( @path1, 0, 2 );
2540 :     splice( @path2, 0, 2 );
2541 :     }
2542 :    
2543 :     my ( @path, $dist );
2544 :     if ( @path1 < 3 )
2545 :     {
2546 :     @path2 >= 3 or return undef; # node1 = node2
2547 : golsen 1.9 $dist = $fraction * newick_path_length( @path2 );
2548 : golsen 1.8 @path = @path2;
2549 :     }
2550 :     elsif ( @path2 < 3 )
2551 :     {
2552 :     $dist = ( 1 - $fraction ) * newick_path_length( @path1 );
2553 :     @path = @path1;
2554 :     }
2555 :     else
2556 :     {
2557 :     my $dist1 = newick_path_length( @path1 );
2558 :     my $dist2 = newick_path_length( @path2 );
2559 :     $dist = $fraction * ( $dist1 + $dist2 ) - $dist1;
2560 :     @path = ( $dist <= 0 ) ? @path1 : @path2;
2561 :     $dist = abs( $dist );
2562 :     }
2563 :    
2564 :     # Descend tree until we reach the insertion branch:
2565 :    
2566 :     my $x;
2567 :     while ( ( $dist > ( $x = newick_x( $path[2] ) ) ) && ( @path > 3 ) )
2568 :     {
2569 :     $dist -= $x;
2570 :     splice( @path, 0, 2 );
2571 :     }
2572 :    
2573 :     # Insert the new node:
2574 :    
2575 :     set_newick_desc_i( $path[0], $path[1], [ [ $path[2], $subtree ], undef, $dist ] );
2576 :     set_newick_x( $path[2], ( ( $x > $dist ) ? ( $x - $dist ) : 0 ) );
2577 :    
2578 :     return $tree;
2579 :     }
2580 :    
2581 : golsen 1.5
2582 :     #-------------------------------------------------------------------------------
2583 : golsen 1.1 # Prune one or more tips from a tree:
2584 :     # Caveat: if one tip is listed, the original tree is modified.
2585 : golsen 1.5 # if more than one tip is listed, a copy of the tree is returned
2586 : golsen 1.1 # (even if it is just listing the same tip twice!).
2587 :     #
2588 :     # $newtree = prune_from_newick( $tree, $tip )
2589 :     # $newtree = prune_from_newick( $tree, @tips )
2590 :     # $newtree = prune_from_newick( $tree, \@tips )
2591 :     #-------------------------------------------------------------------------------
2592 :     sub prune_from_newick {
2593 :     my ( $tr, @tips ) = @_;
2594 :     if ( @tips == 1 && ref( $tips[0] ) eq "ARRAY" ) { @tips = @{ $tips[0] } }
2595 : golsen 1.9
2596 : golsen 1.1 if ( @tips == 0 ) { return $tr }
2597 :     if ( @tips == 1 ) { return prune_1_from_newick( $tr, @tips ) }
2598 :    
2599 :     my %del = map { ( $_, 1 ) } @tips;
2600 :     my @keep = grep { ! $del{ $_ } } newick_tip_list( $tr );
2601 :     newick_subtree( $tr, @keep );
2602 :     }
2603 :    
2604 :    
2605 :     #-------------------------------------------------------------------------------
2606 :     # Prune a tip from a tree:
2607 :     #
2608 :     # $newtree = prune_1_from_newick( $tree, $tip )
2609 :     #-------------------------------------------------------------------------------
2610 :     sub prune_1_from_newick {
2611 :     my ( $tr, $tip ) = @_;
2612 :     my @path = path_to_tip( $tr, $tip );
2613 :     if ( @path < 3 ) { return $tr }
2614 :    
2615 :     my $node = $path[-1]; # Node with the tip
2616 :     my $i1 = $path[-2]; # Descendant number of node in ancestor desc list
2617 :     my $anc1 = $path[-3]; # Ancestor of node
2618 :     my $nd1 = newick_n_desc( $anc1 ); # Number of descendants of ancestor
2619 :     my $anc2 = ( @path >= 5 ) ? $path[-5] : undef; # Ancestor of anc1
2620 :    
2621 :     # dump_tree( $node );
2622 :     # print STDERR "i1 = $i1\n";
2623 :     # dump_tree( $anc1 );
2624 :     # print STDERR "nd1 = $nd1\n";
2625 :     # defined( $anc2 ) && dump_tree( $anc2 );
2626 :    
2627 :     if ( $nd1 > 3 || ( $anc2 && $nd1 > 2 ) ) { # Tip joins at multifurcation
2628 :     splice( @{ $anc1->[0] }, $i1-1, 1 ); # delete the descendant
2629 :     }
2630 :    
2631 :     elsif ( $anc2 ) { # Tip joins at internal bifurcation
2632 :     my $sis = newick_desc_i( $anc1, 3-$i1 ); # find sister node
2633 :     add_to_newick_branch( $sis, $anc1 ); # combine internal branches
2634 :     set_newick_desc_i( $anc2, $path[-4], $sis ); # remove $anc1
2635 :     }
2636 :    
2637 :     elsif ( $nd1 == 2) { # Tip joins bifurcating root node
2638 :     my $sis = newick_desc_i( $anc1, 3-$i1 ); # find sister node
2639 :     $sis->[1] = $anc1->[1] if ! $sis->[1] && $anc1->[1]; # root label
2640 :     $sis->[2] = undef; # root branch len
2641 :     $sis->[3] = $anc1->[3] if ! $sis->[3] && $anc1->[3]; # tree comment
2642 :     $sis->[4] = $anc1->[4] if ! $sis->[4] && $anc1->[4]; # desc list comment
2643 : golsen 1.9 $sis->[5] = $anc1->[5] if ! $sis->[5] && $anc1->[5]; # label comment
2644 : golsen 1.1 $sis->[6] = undef if $sis->[6]; # root branch comment
2645 :     $sis->[7] = undef if $sis->[7]; # root branch comment
2646 :     $tr = $sis; # sister is new root
2647 :     }
2648 :    
2649 :     elsif ( $nd1 == 3 ) { # Tip joins trifurcating root:
2650 :     splice( @{ $anc1->[0] }, $i1-1, 1 ); # delete the descendant, and
2651 :     $tr = uproot_newick( $tr ); # fix the rooting
2652 :     }
2653 :    
2654 :     else {
2655 :     return undef;
2656 :     }
2657 :    
2658 :     return $tr;
2659 :     }
2660 :    
2661 :    
2662 :     #-------------------------------------------------------------------------------
2663 : golsen 1.12 # Produce a potentially rooted subtree with the desired tips:
2664 :     #
2665 :     # Except for (some) tip nodes, the tree produced is a copy.
2666 :     # There is no check that requested tips exist.
2667 :     #
2668 :     # $newtree = rooted_newick_subtree( $tree, @tips )
2669 :     # $newtree = rooted_newick_subtree( $tree, \@tips )
2670 :     #-------------------------------------------------------------------------------
2671 :     sub rooted_newick_subtree {
2672 :     my ( $tr, @tips ) = @_;
2673 :     if ( @tips == 1 && ref( $tips[0] ) eq "ARRAY" ) { @tips = @{ $tips[0] } }
2674 :    
2675 :     if ( @tips < 2 ) { return undef }
2676 :     my $keephash = { map { ( $_, 1 ) } @tips };
2677 :     my $tr2 = subtree1( $tr, $keephash );
2678 :     $tr2->[2] = undef if $tr2; # undef root branch length
2679 :     $tr2;
2680 :     }
2681 :    
2682 :    
2683 :     #-------------------------------------------------------------------------------
2684 : golsen 1.1 # Produce a subtree with the desired tips:
2685 :     #
2686 :     # Except for (some) tip nodes, the tree produced is a copy.
2687 :     # There is no check that requested tips exist.
2688 :     #
2689 :     # $newtree = newick_subtree( $tree, @tips )
2690 :     # $newtree = newick_subtree( $tree, \@tips )
2691 :     #-------------------------------------------------------------------------------
2692 :     sub newick_subtree {
2693 :     my ( $tr, @tips ) = @_;
2694 :     if ( @tips == 1 && ref( $tips[0] ) eq "ARRAY" ) { @tips = @{ $tips[0] } }
2695 :    
2696 :     if ( @tips < 2 ) { return undef }
2697 :     my $was_rooted = newick_is_rooted( $tr );
2698 :     my $keephash = { map { ( $_, 1 ) } @tips };
2699 :     my $tr2 = subtree1( $tr, $keephash );
2700 :     $tr2 = uproot_newick( $tr2 ) if ! $was_rooted && newick_is_rooted( $tr2 );
2701 :     $tr2->[2] = undef if $tr2; # undef root branch length
2702 :     $tr2;
2703 :     }
2704 :    
2705 :    
2706 :     sub subtree1 {
2707 :     my ( $tr, $keep ) = @_;
2708 :     my @desc1 = newick_desc_list( $tr );
2709 :    
2710 :     # Is this a tip, and is it in the keep list?
2711 :    
2712 :     if ( @desc1 < 1 ) {
2713 :     return ( $keep->{ newick_lbl( $tr ) } ) ? $tr : undef;
2714 :     }
2715 :    
2716 :     # Internal node: analyze the descendants:
2717 :    
2718 :     my @desc2 = ();
2719 :     foreach ( @desc1 ) {
2720 :     my $desc = subtree1( $_, $keep );
2721 :     if ( $desc && @$desc ) { push @desc2, $desc }
2722 :     }
2723 :    
2724 :     if ( @desc2 == 0 ) { return undef }
2725 :     if ( @desc2 > 1 ) { return [ \@desc2, @$tr[ 1 .. @$tr - 1 ] ] }
2726 :    
2727 :     # Exactly 1 descendant
2728 :    
2729 :     my $desc = $desc2[ 0 ];
2730 :     my @nn = ( $desc->[0],
2731 :     $desc->[1] ? $desc->[1] : $tr->[1],
2732 :     defined( $tr->[2] ) ? $desc->[2] + $tr->[2] : undef
2733 :     );
2734 :    
2735 :     # Merge comments (only recreating the ones that existed):
2736 :    
2737 :     if ( $tr->[3] && @{$tr->[3]} || $desc->[3] && @{$desc->[3]} ) {
2738 :     $nn[3] = [ $tr->[3] ? @{$tr->[3]} : (), $desc->[3] ? @{$desc->[3]} : () ];
2739 :     }
2740 :     if ( $tr->[4] && @{$tr->[4]} || $desc->[4] && @{$desc->[4]} ) {
2741 :     $nn[4] = [ $tr->[4] ? @{$tr->[4]} : (), $desc->[4] ? @{$desc->[4]} : () ];
2742 :     }
2743 :     if ( $tr->[5] && @{$tr->[5]} || $desc->[5] && @{$desc->[5]} ) {
2744 :     $nn[5] = [ $tr->[5] ? @{$tr->[5]} : (), $desc->[5] ? @{$desc->[5]} : () ];
2745 :     }
2746 :     if ( $tr->[6] && @{$tr->[6]} || $desc->[6] && @{$desc->[6]} ) {
2747 :     $nn[6] = [ $tr->[6] ? @{$tr->[6]} : (), $desc->[6] ? @{$desc->[6]} : () ];
2748 :     }
2749 :     if ( $tr->[7] && @{$tr->[7]} || $desc->[7] && @{$desc->[7]} ) {
2750 :     $nn[7] = [ $tr->[7] ? @{$tr->[7]} : (), $desc->[7] ? @{$desc->[7]} : () ];
2751 :     }
2752 :    
2753 :     return \@nn;
2754 :     }
2755 :    
2756 :    
2757 : golsen 1.12 #-------------------------------------------------------------------------------
2758 :     # The smallest subtree of rooted tree that includes @tips:
2759 :     #
2760 :     # $node = newick_covering_subtree( $tree, @tips )
2761 :     # $node = newick_covering_subtree( $tree, \@tips )
2762 :     #-------------------------------------------------------------------------------
2763 :    
2764 :     sub newick_covering_subtree {
2765 :     my $tree = shift;
2766 :     my %tips = map { $_ => 1 } ( ( ref( $_[0] ) eq 'ARRAY' ) ? @{ $_[0] } : @_ );
2767 :    
2768 :     # Return smallest covering node, if any:
2769 :    
2770 :     ( newick_covering_subtree( $tree, \%tips ) )[ 0 ];
2771 :     }
2772 :    
2773 :    
2774 :     sub newick_covering_subtree_1 {
2775 :     my ( $node, $tips ) = @_;
2776 :     my $n_cover = 0;
2777 :     my @desc = newick_desc_list( $node );
2778 :     if ( @desc )
2779 :     {
2780 :     foreach ( @desc )
2781 :     {
2782 :     my ( $subtree, $n ) = newick_covering_subtree_1( $_, $tips );
2783 :     return ( $subtree, $n ) if $subtree;
2784 :     $n_cover += $n;
2785 :     }
2786 :     }
2787 :     elsif ( $tips->{ newick_lbl( $node ) } )
2788 :     {
2789 :     $n_cover++;
2790 :     }
2791 :    
2792 :     # If all tips are covered, return node
2793 :    
2794 :     ( $n_cover == keys %$tips ) ? ( $node, $n_cover ) : ( undef, $n_cover );
2795 :     }
2796 :    
2797 :    
2798 : golsen 1.1 #===============================================================================
2799 :     #
2800 : golsen 1.9 # Representative subtrees
2801 :     #
2802 :     #===============================================================================
2803 :     # Find subtree of size n representating vicinity of the root:
2804 :     #
2805 :     # $subtree = root_neighborhood_representative_tree( $tree, $n, \%tip_priority )
2806 :     # $subtree = root_neighborhood_representative_tree( $tree, $n )
2807 :     #
2808 :     # Note that if $tree is rooted, then the subtree will also be. This can have
2809 :     # consequences on downstream programs.
2810 :     #-------------------------------------------------------------------------------
2811 :     sub root_neighborhood_representative_tree
2812 :     {
2813 :     my ( $tree, $n, $tip_priority ) = @_;
2814 :     array_ref( $tree ) && ( $n >= 2 ) or return undef;
2815 :     if ( newick_tip_count( $tree ) <= $n ) { return $tree }
2816 :    
2817 :     $tip_priority ||= default_tip_priority( $tree );
2818 :     my @tips = map { representative_tip_of_newick_node( $_, $tip_priority ) }
2819 :     root_proximal_newick_subtrees( $tree, $n );
2820 :    
2821 :     newick_subtree( copy_newick_tree( $tree ), \@tips );
2822 :     }
2823 :    
2824 :    
2825 :     #-------------------------------------------------------------------------------
2826 :     # Find n tips to represent tree lineages in vicinity of another tip.
2827 :     # Default tip priority is short total branch length.
2828 :     #
2829 :     # \@tips = root_neighborhood_representative_tips( $tree, $n, \%tip_priority )
2830 :     # @tips = root_neighborhood_representative_tips( $tree, $n, \%tip_priority )
2831 :     # \@tips = root_neighborhood_representative_tips( $tree, $n )
2832 :     # @tips = root_neighborhood_representative_tips( $tree, $n )
2833 :     #-------------------------------------------------------------------------------
2834 :     sub root_neighborhood_representative_tips
2835 :     {
2836 :     my ( $tree, $n, $tip_priority ) = @_;
2837 :     array_ref( $tree ) && ( $n >= 2 ) or return undef;
2838 :    
2839 :     my @tips;
2840 :     if ( newick_tip_count( $tree ) <= $n )
2841 :     {
2842 :     @tips = newick_tip_list( $tree );
2843 :     }
2844 :     else
2845 :     {
2846 :     $tip_priority ||= default_tip_priority( $tree );
2847 :     @tips = map { representative_tip_of_newick_node( $_, $tip_priority ) }
2848 :     root_proximal_newick_subtrees( $tree, $n );
2849 :     }
2850 :    
2851 :     wantarray ? @tips : \@tips;
2852 :     }
2853 :    
2854 :    
2855 :     #-------------------------------------------------------------------------------
2856 :     # Find subtree of size n representating vicinity of a tip:
2857 :     #
2858 :     # $subtree = tip_neighborhood_representative_tree( $tree, $tip, $n, \%tip_priority )
2859 :     # $subtree = tip_neighborhood_representative_tree( $tree, $tip, $n )
2860 :     #-------------------------------------------------------------------------------
2861 :     sub tip_neighborhood_representative_tree
2862 :     {
2863 :     my ( $tree, $tip, $n, $tip_priority ) = @_;
2864 :     array_ref( $tree ) && $tip && ( $n >= 2 ) or return undef;
2865 :     newick_tip_in_tree( $tree, $tip ) or return undef;
2866 :    
2867 :     my $tree1 = copy_newick_tree( $tree );
2868 :     if ( newick_tip_count( $tree1 ) - 1 <= $n )
2869 :     {
2870 :     return prune_from_newick( $tree1, $tip )
2871 :     }
2872 :    
2873 :     $tree1 = reroot_newick_to_tip( $tree1, $tip );
2874 :     $tree1 = newick_desc_i( $tree1, 1 ); # Node immediately below tip
2875 :     my @tips = root_neighborhood_representative_tips( $tree1, $n, $tip_priority );
2876 :     newick_subtree( copy_newick_tree( $tree ), \@tips );
2877 :     }
2878 :    
2879 :    
2880 :     #-------------------------------------------------------------------------------
2881 :     # Find n tips to represent tree lineages in vicinity of another tip.
2882 :     # Default tip priority is short total branch length.
2883 :     #
2884 :     # \@tips = tip_neighborhood_representative_tips( $tree, $tip, $n, \%tip_priority )
2885 :     # @tips = tip_neighborhood_representative_tips( $tree, $tip, $n, \%tip_priority )
2886 :     # \@tips = tip_neighborhood_representative_tips( $tree, $tip, $n )
2887 :     # @tips = tip_neighborhood_representative_tips( $tree, $tip, $n )
2888 :     #-------------------------------------------------------------------------------
2889 :     sub tip_neighborhood_representative_tips
2890 :     {
2891 :     my ( $tree, $tip, $n, $tip_priority ) = @_;
2892 :     array_ref( $tree ) && $tip && ( $n >= 2 ) or return undef;
2893 :     newick_tip_in_tree( $tree, $tip ) or return undef;
2894 :    
2895 :     my @tips = newick_tip_list( $tree );
2896 :     if ( newick_tip_count( $tree ) - 1 <= $n )
2897 :     {
2898 :     @tips = grep { $_ ne $tip } @tips;
2899 :     }
2900 :     else
2901 :     {
2902 :     my $tree1 = copy_newick_tree( $tree );
2903 :     $tree1 = reroot_newick_to_tip( $tree1, $tip );
2904 :     $tree1 = newick_desc_i( $tree1, 1 ); # Node immediately below tip
2905 :     @tips = root_neighborhood_representative_tips( $tree1, $n, $tip_priority );
2906 :     }
2907 :    
2908 :     wantarray ? @tips : \@tips;
2909 :     }
2910 :    
2911 :    
2912 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2913 :     # Anonymous hash of the negative distance from root to each tip:
2914 :     #
2915 :     # \%tip_priority = default_tip_priority( $tree )
2916 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2917 :     sub default_tip_priority
2918 :     {
2919 :     my ( $tree ) = @_;
2920 :     my $tip_distances = newick_tip_distances( $tree ) || {};
2921 :     return { map { $_ => -$tip_distances->{$_} } keys %$tip_distances };
2922 :     }
2923 :    
2924 :    
2925 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2926 :     # Select a tip from a subtree base on a priority value:
2927 :     #
2928 :     # $tip = representative_tip_of_newick_node( $node, \%tip_priority )
2929 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2930 :     sub representative_tip_of_newick_node
2931 :     {
2932 :     my ( $node, $tip_priority ) = @_;
2933 :     my ( $tip ) = sort { $b->[1] <=> $a->[1] } # The best
2934 :     map { [ $_, $tip_priority->{ $_ } ] }
2935 :     newick_tip_list( $node );
2936 :     $tip->[0]; # Label from label-priority pair
2937 :     }
2938 :    
2939 :    
2940 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2941 :     # Find n subtrees focused around the root of a tree. Typically each will
2942 :     # then be reduced to a single tip to make a representative tree:
2943 :     #
2944 :     # @subtrees = root_proximal_newick_subtrees( $tree, $n )
2945 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2946 :     sub root_proximal_newick_subtrees
2947 :     {
2948 :     my ( $tree, $n ) = @_;
2949 :     my $node_start_end = newick_branch_intervals( $tree );
2950 :     n_representative_branches( $n, $node_start_end );
2951 :     }
2952 :    
2953 :    
2954 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2955 :     # @node_start_end = newick_branch_intervals( $tree )
2956 :     # \@node_start_end = newick_branch_intervals( $tree )
2957 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2958 :     sub newick_branch_intervals
2959 :     {
2960 :     my ( $node, $parent_x ) = @_;
2961 :     $parent_x ||= 0;
2962 :     my ( $desc, undef, $dx ) = @$node;
2963 :     my $x = $parent_x + $dx;
2964 :     my $interval = [ $node, $parent_x, $desc && @$desc ? $x : 1e100 ];
2965 :     my @intervals = ( $interval,
2966 :     map { &newick_branch_intervals( $_, $x ) } @$desc
2967 :     );
2968 :     return wantarray ? @intervals : \@intervals;
2969 :     }
2970 :    
2971 :    
2972 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2973 :     # @ids = n_representative_branches( $n, @id_start_end )
2974 :     # @ids = n_representative_branches( $n, \@id_start_end )
2975 :     # \@ids = n_representative_branches( $n, @id_start_end )
2976 :     # \@ids = n_representative_branches( $n, \@id_start_end )
2977 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2978 :     sub n_representative_branches
2979 :     {
2980 :     my $n = shift;
2981 :     # Sort intervals by start point:
2982 :     my @unprocessed = sort { $a->[1] <=> $b->[1] }
2983 :     ( @_ == 1 ) ? @{ $_[0] } : @_;
2984 :     my @active = ();
2985 :     my ( $interval, $current_point );
2986 :     foreach $interval ( @unprocessed )
2987 :     {
2988 :     $current_point = $interval->[1];
2989 :     # Filter out intervals that have ended. This is N**2 in the number
2990 :     # of representatives. Fixing this would require maintaining a sorted
2991 :     # active list.
2992 :     @active = grep { $_->[2] > $current_point } @active;
2993 :     push @active, $interval;
2994 :     last if ( @active >= $n );
2995 :     }
2996 :    
2997 :     my @ids = map { $_->[0] } @active;
2998 :     return wantarray() ? @ids : \@ids;
2999 :     }
3000 :    
3001 :    
3002 :     #===============================================================================
3003 : golsen 1.22 # Random trees
3004 :     #===============================================================================
3005 :     #
3006 :     # $tree = random_equibranch_tree( @tips, \%options )
3007 :     # $tree = random_equibranch_tree( \@tips, \%options )
3008 :     # $tree = random_equibranch_tree( @tips )
3009 :     # $tree = random_equibranch_tree( \@tips )
3010 :     #
3011 :     # Options:
3012 :     #
3013 :     # length => $branch_length # D = 1
3014 :     #
3015 :     #-------------------------------------------------------------------------------
3016 :     sub random_equibranch_tree
3017 :     {
3018 :     my $opts = $_[ 0] && ref $_[ 0] eq 'HASH' ? shift
3019 :     : $_[-1] && ref $_[-1] eq 'HASH' ? pop
3020 :     : {};
3021 :     return undef if ! defined $_[0];
3022 :    
3023 :     my @tips = ref $_[0] ? @{ $_[0] } : @_;
3024 :     return undef if @tips < 2;
3025 :    
3026 :     my $len = $opts->{ length } ||= 1;
3027 :    
3028 :     if ( @tips == 2 )
3029 :     {
3030 :     return [ [ map { [ [], $_, $len ] } @tips ], undef, 0 ];
3031 :     }
3032 :    
3033 :     my $tree = [ [ ], undef, 0 ];
3034 :    
3035 :     my @links; # \$anc_dl[i], i.e. a reference to an element in a descendent list
3036 :    
3037 :     my $anc_dl = $tree->[0];
3038 :     foreach my $tip ( splice( @tips, 0, 3 ) )
3039 :     {
3040 :     my $node = [ [], $tip, $len ];
3041 :     push @$anc_dl, $node;
3042 :     push @links, \$anc_dl->[-1]; # Ref to the just added descendent list entry
3043 :     }
3044 :    
3045 :     foreach my $tip ( @tips )
3046 :     {
3047 :     my $link = $links[ int( rand( scalar @links ) ) ];
3048 :     my $newtip = [ [], $tip, $len ];
3049 :     my $new_dl = [ $$link, $newtip ];
3050 :     my $newnode = [ $new_dl, undef, $len ];
3051 :     $$link = $newnode;
3052 :     push @links, \$new_dl->[0], \$new_dl->[1]
3053 :     }
3054 :    
3055 :     return $tree;
3056 :     }
3057 :    
3058 :    
3059 :     #-------------------------------------------------------------------------------
3060 :     #
3061 :     # $tree = random_ultrametric_tree( @tips, \%options )
3062 :     # $tree = random_ultrametric_tree( \@tips, \%options )
3063 :     # $tree = random_ultrametric_tree( @tips )
3064 :     # $tree = random_ultrametric_tree( \@tips )
3065 :     #
3066 :     # Options:
3067 :     #
3068 :     # depth => $root_to_tip_dist # D = 1
3069 :     #
3070 :     #-------------------------------------------------------------------------------
3071 :     sub random_ultrametric_tree
3072 :     {
3073 :     my $opts = $_[ 0] && ref $_[ 0] eq 'HASH' ? shift
3074 :     : $_[-1] && ref $_[-1] eq 'HASH' ? pop
3075 :     : {};
3076 :     return undef if ! defined $_[0];
3077 :    
3078 :     my @tips = ref $_[0] ? @{ $_[0] } : @_;
3079 :     return undef if @tips < 2;
3080 :    
3081 :     my $d2tip = $opts->{ depth } ||= 1;
3082 :    
3083 :     # Random tip addition order (for rooted tree it matters):
3084 :    
3085 :     @tips = sort { rand() <=> 0.5 } @tips;
3086 :     my $tree = [ [ ], undef, 0 ];
3087 :    
3088 :     my $subtree_size = { $tree => 0 }; # total branch length of each subtree
3089 :    
3090 :     # We start with root bifurcation:
3091 :    
3092 :     foreach my $tip ( splice( @tips, 0, 2 ) )
3093 :     {
3094 :     my $node = [ [], $tip, $d2tip ];
3095 :     push @{ $tree->[0] }, $node;
3096 :     $subtree_size->{ $node } = $d2tip;
3097 :     $subtree_size->{ $tree } += $d2tip;
3098 :     }
3099 :    
3100 :     # Add each remaining tip at $pos, measured along the contour length
3101 :     # of the tree (with no retracing along branches).
3102 :    
3103 :     foreach my $tip ( @tips )
3104 :     {
3105 :     my $pos = rand( $subtree_size->{ $tree } );
3106 :     random_add_to_ultrametric_tree( $tree, $tip, $subtree_size, $pos, $d2tip );
3107 :     }
3108 :    
3109 :     return $tree;
3110 :     }
3111 :    
3112 :    
3113 :     sub random_add_to_ultrametric_tree
3114 :     {
3115 :     my ( $node, $tip, $subtree_size, $pos, $d2tip ) = @_;
3116 :     $node && $node->[0] && ref $node->[0] eq 'ARRAY' or die "Bad tree node passed to random_add_to_ultrametric_tree().\n";
3117 :    
3118 :     # Find the descendent line that it goes in:
3119 :    
3120 :     my $i;
3121 :     my $dl = $node->[0];
3122 :     my $size0 = $subtree_size->{ $dl->[0] };
3123 :     if ( $size0 > $pos ) { $i = 0 } else { $i = 1; $pos -= $size0 }
3124 :     my $desc = $dl->[$i];
3125 :    
3126 :     # Does it go within the subtree, or the branch to the subtree?
3127 :    
3128 :     my $len;
3129 :     my $added;
3130 :     if ( ( $len = $desc->[2] ) <= $pos )
3131 :     {
3132 :     $added = random_add_to_ultrametric_tree( $desc, $tip, $subtree_size, $pos - $len, $d2tip - $len );
3133 :     }
3134 :     else
3135 :     {
3136 :     # If not in subtree, then it goes in the branch to the descendent node
3137 :     #
3138 :     # ----- node ------------ node
3139 :     # ^ / \ ^ / \
3140 :     # | \ | pos \l1
3141 :     # | \ v \
3142 :     # | len\ ---------- newnode
3143 :     # | \ / \ l2
3144 :     # d2tip | \ / \
3145 :     # | desc / desc
3146 :     # | / \ l3/ / \
3147 :     # | . . / . .
3148 :     # v . . / . .
3149 :     # ----- . . newtip . .
3150 :    
3151 :     my $l1 = $pos;
3152 :     my $l2 = $len - $pos;
3153 :     my $l3 = $d2tip - $pos;
3154 :     my $newtip = [ [], $tip, $l3 ];
3155 :     my $newnode = [ [ $desc, $newtip ], undef, $l1 ];
3156 :     $dl->[$i] = $newnode;
3157 :     $subtree_size->{ $newtip } = $l3;
3158 :     $subtree_size->{ $newnode } = $subtree_size->{ $desc } + $l3;
3159 :     $desc->[2] = $l2;
3160 :     $subtree_size->{ $desc } -= $l1;
3161 :     $added = $l3;
3162 :     }
3163 :    
3164 :     # New branch was inserted below this point:
3165 :    
3166 :     $subtree_size->{ $node } += $added;
3167 :     return $added;
3168 :     }
3169 :    
3170 :    
3171 :    
3172 :     #===============================================================================
3173 : golsen 1.9 #
3174 : golsen 1.1 # Tree writing and reading
3175 :     #
3176 :     #===============================================================================
3177 : overbeek 1.7 # writeNewickTree( $tree )
3178 :     # writeNewickTree( $tree, $file )
3179 :     # writeNewickTree( $tree, \*FH )
3180 : golsen 1.1 #-------------------------------------------------------------------------------
3181 :     sub writeNewickTree {
3182 :     my ( $tree, $file ) = @_;
3183 : overbeek 1.7 my ( $fh, $close ) = open_output( $file );
3184 :     $fh or return;
3185 :     print $fh ( strNewickTree( $tree ), "\n" );
3186 :     close $fh if $close;
3187 : golsen 1.1 }
3188 :    
3189 :    
3190 :     #-------------------------------------------------------------------------------
3191 :     # fwriteNewickTree( $file, $tree ) # Args reversed to writeNewickTree
3192 :     #-------------------------------------------------------------------------------
3193 :     sub fwriteNewickTree { writeNewickTree( $_[1], $_[0] ) }
3194 :    
3195 :    
3196 :     #-------------------------------------------------------------------------------
3197 :     # $treestring = strNewickTree( $tree )
3198 :     #-------------------------------------------------------------------------------
3199 :     sub strNewickTree {
3200 :     my $node = shift @_;
3201 :     strNewickSubtree( $node, "" ) . ";";
3202 :     }
3203 :    
3204 :    
3205 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3206 :     # $string = strNewickSubtree( $node, $prefix )
3207 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3208 :     sub strNewickSubtree {
3209 :     my ( $node, $prefix ) = @_;
3210 :     my $s;
3211 :    
3212 :     $s = strNewickComments( newick_c1( $node ), $prefix );
3213 :     if ( $s ) { $prefix = " " }
3214 :    
3215 :     my $ndesc;
3216 :     if ( $ndesc = newick_n_desc( $node ) ) {
3217 :     for (my $d = 1; $d <= $ndesc; $d++) {
3218 :     $s .= ( ( $d == 1 ) ? $prefix . "(" : "," )
3219 :     . strNewickSubtree( newick_desc_i( $node, $d ), " " );
3220 :     }
3221 :    
3222 :     $s .= ")" . strNewickComments( newick_c2( $node ), " " );
3223 :     $prefix = " ";
3224 :     }
3225 :    
3226 :     if ( defined( newick_lbl( $node ) ) && newick_lbl( $node ) ) {
3227 :     $s .= $prefix
3228 :     . q_newick_lbl( $node )
3229 :     . strNewickComments( newick_c3( $node ), " " );
3230 :     }
3231 :    
3232 :     if ( defined( newick_x( $node ) ) ) {
3233 :     $s .= ":"
3234 :     . strNewickComments( newick_c4( $node ), " " )
3235 :     . sprintf( " %.6f", newick_x( $node ) )
3236 :     . strNewickComments( newick_c5( $node ), " " );
3237 :     }
3238 :    
3239 :     $s;
3240 :     }
3241 :    
3242 :    
3243 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3244 :     # $string = strNewickComments( $clist, $prefix )
3245 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3246 :     sub strNewickComments {
3247 :     my ( $clist, $prefix ) = @_;
3248 :     array_ref( $clist ) && ( @$clist > 0 ) || return "";
3249 :     $prefix . "[" . join( "] [", @$clist ) . "]";
3250 :     }
3251 :    
3252 :    
3253 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3254 :     # $quoted_label = q_newick_lbl( $label )
3255 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3256 :     sub q_newick_lbl {
3257 :     my $lbl = newick_lbl( $_[0] );
3258 :     defined( $lbl ) && ( $lbl ne "" ) || return undef;
3259 :    
3260 :     if ( $lbl =~ m/^[^][()_:;,]+$/ # Anything but []()_:;,
3261 :     && $lbl !~ m/^'/ ) { # and does not start with '
3262 :     $lbl =~ s/ /_/g; # Recode blanks as _
3263 :     return $lbl;
3264 :     }
3265 :    
3266 :     else {
3267 :     $lbl =~ s/'/''/g; # Double existing single quote marks
3268 :     return q(') . $lbl . q('); # Wrap in single quote marks
3269 :     }
3270 :     }
3271 :    
3272 :    
3273 :     #===============================================================================
3274 :     # $treestring = formatNewickTree( $tree )
3275 :     #===============================================================================
3276 :     sub formatNewickTree {
3277 :     formatNewickSubtree( $_[0], "", "" ) . ";";
3278 :     }
3279 :    
3280 :    
3281 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3282 :     # $string = formatNewickSubtree( $node, $prefix, $indent )
3283 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3284 :     sub formatNewickSubtree {
3285 :     my ( $node, $prefix, $indent ) = @_;
3286 :     my $s;
3287 :    
3288 :     $s = formatNewickComments( newick_c1( $node ), $prefix, $indent );
3289 :     if ( $s ) { $prefix = "\n$indent" }
3290 :    
3291 :     if ( my $ndesc = newick_n_desc( $node ) ) {
3292 :     for (my $d = 1; $d <= $ndesc; $d++) {
3293 :     $s .= ( ( $d == 1 ) ? $prefix . "(" : ",\n$indent " )
3294 :     . formatNewickSubtree( newick_desc_i( $node, $d ), " ", $indent . " " );
3295 :     }
3296 :    
3297 :     $s .= "\n$indent)" . formatNewickComments( newick_c2( $node ), " ", $indent );
3298 :     $prefix = " ";
3299 :     }
3300 :    
3301 :     if ( defined( newick_lbl( $node ) ) && newick_lbl( $node ) ) {
3302 :     $s .= $prefix
3303 :     . q_newick_lbl( $node )
3304 :     . formatNewickComments( newick_c3( $node ), " ", $indent );
3305 :     }
3306 :    
3307 :     if ( defined( newick_x( $node ) ) ) {
3308 :     $s .= ":"
3309 :     . formatNewickComments( newick_c4( $node ), " ", $indent )
3310 :     . sprintf(" %.6f", newick_x( $node ) )
3311 :     . formatNewickComments( newick_c5( $node ), " ", $indent );
3312 :     }
3313 :    
3314 :     $s;
3315 :     }
3316 :    
3317 :    
3318 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3319 :     # $string = formatNewickComments( $clist, $prefix, $indent )
3320 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3321 :     sub formatNewickComments {
3322 :     my ( $clist, $prefix, $indent ) = @_;
3323 :     array_ref( $clist ) && @$clist || return "";
3324 :     $prefix . "[" . join( "] [", @$clist ) . "]";
3325 :     }
3326 :    
3327 :    
3328 :     #===============================================================================
3329 : overbeek 1.7 # $tree = read_newick_tree( $file ) # reads to a semicolon
3330 :     # @trees = read_newick_trees( $file ) # reads to end of file
3331 :     #===============================================================================
3332 :    
3333 :     sub read_newick_tree
3334 :     {
3335 :     my $file = shift;
3336 :     my ( $fh, $close ) = open_input( $file );
3337 :     my $tree;
3338 :     my @lines = ();
3339 : golsen 1.9 foreach ( <$fh> )
3340 : overbeek 1.7 {
3341 :     chomp;
3342 :     push @lines, $_;
3343 :     if ( /;/ )
3344 :     {
3345 :     $tree = parse_newick_tree_str( join( ' ', @lines ) );
3346 :     last;
3347 :     }
3348 :     }
3349 :     close $fh if $close;
3350 :    
3351 :     $tree;
3352 :     }
3353 :    
3354 :    
3355 :     sub read_newick_trees
3356 :     {
3357 :     my $file = shift;
3358 :     my ( $fh, $close ) = open_input( $file );
3359 :     my @trees = ();
3360 :     my @lines = ();
3361 : golsen 1.9 foreach ( <$fh> )
3362 : overbeek 1.7 {
3363 :     chomp;
3364 :     push @lines, $_;
3365 :     if ( /;/ )
3366 :     {
3367 :     push @trees, parse_newick_tree_str( join( ' ', @lines ) );
3368 :     @lines = ()
3369 :     }
3370 :     }
3371 :     close $fh if $close;
3372 :    
3373 :     @trees;
3374 :     }
3375 :    
3376 :    
3377 :     #===============================================================================
3378 : golsen 1.1 # Tree reader adapted from the C language reader in fastDNAml
3379 :     #
3380 :     # $tree = parse_newick_tree_str( $string )
3381 :     #===============================================================================
3382 :     sub parse_newick_tree_str {
3383 :     my $s = shift @_;
3384 :    
3385 :     my ( $ind, $rootnode ) = parse_newick_subtree( $s, 0 );
3386 :     if ( substr( $s, $ind, 1 ) ne ";") { warn "warning: tree missing ';'\n" }
3387 :     $rootnode;
3388 :     }
3389 :    
3390 :    
3391 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3392 :     # Read a subtrees recursively (everything of tree but a semicolon)
3393 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3394 :     sub parse_newick_subtree {
3395 :     my ( $s, $ind ) = @_;
3396 :    
3397 :     my $newnode = [];
3398 :     my @dlist = ();
3399 :     my ( $lbl, $x, $c1, $c2, $c3, $c4, $c5 );
3400 : golsen 1.9
3401 : golsen 1.1 ( $ind, $c1 ) = getNextTreeChar( $s, $ind ); # Comment 1
3402 :     if ( ! defined( $ind ) ) { treeParseError( "missing subtree" ) }
3403 :     if ( $c1 && @$c1 ) { set_newick_c1( $newnode, $c1 ) }
3404 :    
3405 :     if ( substr( $s, $ind, 1 ) eq "(" ) { # New internal node
3406 :     while ( ! @dlist || ( substr( $s, $ind, 1 ) eq "," ) ) {
3407 :     my $desc;
3408 :     ( $ind, $desc ) = parse_newick_subtree( $s, $ind+1 );
3409 :     if (! $ind) { return () }
3410 :     push @dlist, $desc;
3411 :     }
3412 :     if ( substr( $s, $ind, 1 ) ne ")" ) { treeParseError( "missing ')'" ) }
3413 :    
3414 :     ( $ind, $c2 ) = getNextTreeChar( $s, $ind+1 ); # Comment 2
3415 :     if ( $c2 && @$c2 ) { set_newick_c2( $newnode, $c2 ) }
3416 :     ( $ind, $lbl ) = parseTreeNodeLabel( $s, $ind ); # Node label
3417 :     }
3418 :    
3419 :     elsif ( substr( $s, $ind, 1 ) =~ /[^][(,):;]/ ) { # New tip
3420 :     ( $ind, $lbl ) = parseTreeNodeLabel( $s, $ind ); # Tip label
3421 :     if (! $ind) { return () }
3422 :     }
3423 :    
3424 :     @dlist || $lbl || treeParseError( "no descendant list or label" );
3425 :    
3426 :     if ( @dlist ) { set_newick_desc_ref( $newnode, \@dlist ) }
3427 :     if ( $lbl ) { set_newick_lbl( $newnode, $lbl ) }
3428 :    
3429 :     ( $ind, $c3 ) = getNextTreeChar( $s, $ind ); # Comment 3
3430 :     if ( $c3 && @$c3 ) { set_newick_c3( $newnode, $c3 ) }
3431 :    
3432 :     if (substr( $s, $ind, 1 ) eq ":") { # Branch length
3433 :     ( $ind, $c4 ) = getNextTreeChar( $s, $ind+1 ); # Comment 4
3434 :     if ( $c4 && @$c4 ) { set_newick_c4( $newnode, $c4 ) }
3435 :     ( $ind, $x ) = parseBranchLength( $s, $ind );
3436 :     if ( defined( $x ) ) { set_newick_x( $newnode, $x ) }
3437 :     ( $ind, $c5 ) = getNextTreeChar( $s, $ind ); # Comment 5
3438 :     if ( $c5 && @$c5 ) { set_newick_c5( $newnode, $c5 ) }
3439 :     }
3440 :    
3441 :     ( $ind, $newnode );
3442 :     }
3443 :    
3444 :    
3445 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3446 :     # Read a Newick tree label
3447 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3448 :     sub parseTreeNodeLabel { # Empty string is permitted
3449 :     my ( $s, $ind ) = @_;
3450 :     my ( $lbl, $c );
3451 :    
3452 :     if ( substr( $s, $ind, 1 ) eq "'") {
3453 :     my $ind1 = ++$ind;
3454 :    
3455 :     while ( ) {
3456 :     if ( ! defined( $c = substr( $s, $ind, 1 ) ) || $c eq "" ) {
3457 :     treeParseError( "missing close quote on label '" . substr( $s, $ind1 ) . "'" )
3458 :     }
3459 :     elsif ( $c ne "'" ) { $ind++ }
3460 :     elsif ( substr( $s, $ind, 2 ) eq "''" ) { $ind += 2 }
3461 :     else { last }
3462 :     }
3463 :    
3464 :     $lbl = substr( $s, $ind1, $ind-$ind1 );
3465 :     $lbl =~ s/''/'/g;
3466 :     $ind++;
3467 :     }
3468 :    
3469 :     else {
3470 :     my $ind1 = $ind;
3471 :     while ( defined( $c = substr($s, $ind, 1) ) && $c ne "" && $c !~ /[][\s(,):;]/ ) { $ind++ }
3472 :     $lbl = substr( $s, $ind1, $ind-$ind1 );
3473 :     $lbl =~ s/_/ /g;
3474 :     }
3475 :    
3476 :     ( $ind, $lbl );
3477 :     }
3478 :    
3479 :    
3480 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3481 :     # Read a Newick tree branch length
3482 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3483 :     sub parseBranchLength {
3484 :     my ( $s, $ind ) = @_;
3485 :    
3486 :     my $c = substr( $s, $ind, 1 );
3487 :    
3488 :     my $sign = ( $c ne "-" ) ? 1 : -1; # Sign
3489 :     if ( $c =~ /[-+]/ ) { $c = substr( $s, ++$ind, 1 ) }
3490 :    
3491 :     if ( $c !~ /^[.0-9]$/ ) { # Allows starting with decimal
3492 :     treeParseError( "invalid branch length character '$c'" )
3493 :     }
3494 :    
3495 :     my $v = 0;
3496 :     while ( $c =~ /[0-9]/ ) { # Whole number
3497 :     $v = 10 * $v + $c;
3498 :     $c = substr( $s, ++$ind, 1 );
3499 :     }
3500 :    
3501 :     if ( $c eq "." ) { # Fraction
3502 :     my $f = 0.1;
3503 :     $c = substr( $s, ++$ind, 1 );
3504 :     while ( $c =~ /[0-9]/ ) {
3505 :     $v += $f * $c;
3506 :     $f *= 0.1;
3507 :     $c = substr( $s, ++$ind, 1 );
3508 :     }
3509 :     }
3510 :    
3511 :     $v *= $sign;
3512 :    
3513 :     if ( $c =~ /[dDeEgG]/ ) { # Exponent
3514 :     $c = substr( $s, ++$ind, 1 );
3515 :     my $esign = ( $c ne "-" ) ? 1 : -1;
3516 :     if ( $c =~ /^[-+]$/ ) { $c = substr( $s, ++$ind, 1 ) }
3517 :     if ( $c !~ /^[0-9]$/ ) {
3518 :     treeParseError( "missing branch length exponent '$c'" )
3519 :     }
3520 :    
3521 :     my $e = 0;
3522 :     while ( $c =~ /[0-9]/ ) {
3523 :     $e = 10 * $e + $c;
3524 :     $c = substr( $s, ++$ind, 1 );
3525 :     }
3526 :     $e *= $esign;
3527 :     $v *= 10**$e;
3528 :     }
3529 :    
3530 :     ( $ind, $v );
3531 :     }
3532 :    
3533 :    
3534 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3535 :     # ( $index, /@commentlist ) = getNextTreeChar( $string, $index )
3536 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3537 :     sub getNextTreeChar { # Move to next nonblank, noncomment character
3538 :     my ( $s, $ind ) = @_;
3539 :    
3540 :     my @clist = ();
3541 :    
3542 :     # Skip white space
3543 :     if ( substr( $s, $ind ) =~ /^(\s+)/ ) { $ind += length( $1 ) }
3544 :    
3545 :     # Loop while it is a comment:
3546 :     while ( substr( $s, $ind, 1 ) eq "[" ) {
3547 :     $ind++;
3548 : golsen 1.11 my $depth = 1;
3549 :     my $ind2 = $ind;
3550 : golsen 1.1
3551 :     # Find end
3552 : golsen 1.11 while ( $depth > 0 )
3553 :     {
3554 :     if ( substr( $s, $ind2 ) =~ /^([^][]*\[)/ ) # nested [ ... ]
3555 :     {
3556 :     $ind2 += length( $1 ); # Points at char just past [
3557 :     $depth++; # If nested comments are allowed
3558 :     }
3559 :     elsif ( substr( $s, $ind2 ) =~ /^([^][]*\])/ ) # close bracket
3560 :     {
3561 :     $ind2 += length( $1 ); # Points at char just past ]
3562 :     $depth--;
3563 :     }
3564 :     else
3565 :     {
3566 :     treeParseError( "comment missing closing bracket '["
3567 :     . substr( $s, $ind ) . "'" )
3568 :     }
3569 : golsen 1.1 }
3570 :    
3571 : golsen 1.11 my $comment = substr( $s, $ind, $ind2-$ind-1 );
3572 : golsen 1.1 if ( $comment =~ m/\S/ ) { push @clist, $comment }
3573 :    
3574 : golsen 1.11 $ind = $ind2;
3575 : golsen 1.1
3576 :     # Skip white space
3577 :     if ( substr( $s, $ind ) =~ /^(\s+)/ ) { $ind += length( $1 ) }
3578 :     }
3579 :    
3580 :     ( $ind, @clist ? \@clist : undef )
3581 :     }
3582 :    
3583 :    
3584 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3585 :     # treeParseError( $message )
3586 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3587 :     sub treeParseError { die "Error: parse_newick_subtree: " . $_[0] . "\n" }
3588 :    
3589 :    
3590 :     #===============================================================================
3591 :     # Make a printer plot of a tree:
3592 :     #
3593 : golsen 1.13 # printer_plot_newick( $node, $file, $width, $min_dx, $dy )
3594 :     # printer_plot_newick( $node, $file, \%options )
3595 :     #
3596 :     # $node # newick tree root node
3597 :     # $file # undef = \*STDOUT, \*FH, or a file name.
3598 :     # $width # the approximate characters for the tree without labels (D = 68)
3599 :     # $min_dx # the minimum horizontal branch length (D = 2)
3600 :     # $dy # the vertical space per taxon (D = 1, most compressed)
3601 :     #
3602 :     # Options:
3603 :     #
3604 :     # dy => nat_number # the vertical space per taxon
3605 :     # chars => key # line drawing character set:
3606 :     # # html_unicode
3607 :     # # text (default)
3608 :     # min_dx => whole_number # the minimum horizontal branch length
3609 :     # width => whole_number # approximate tree width without labels
3610 : golsen 1.1 #
3611 : golsen 1.19 #===============================================================================
3612 : golsen 1.13 sub printer_plot_newick
3613 :     {
3614 :     my ( $node, $file, @opts ) = @_;
3615 : golsen 1.1
3616 : overbeek 1.7 my ( $fh, $close ) = open_output( $file );
3617 :     $fh or return;
3618 : golsen 1.1
3619 : golsen 1.13 my $html = $opts[0] && ref($opts[0]) eq 'HASH'
3620 :     && $opts[0]->{ chars }
3621 :     && $opts[0]->{ chars } =~ /html/;
3622 :     print $fh '<PRE>' if $html;
3623 :     print $fh join( "\n", text_plot_newick( $node, @opts ) ), "\n";
3624 :     print $fh "</PRE>\n" if $html;
3625 :    
3626 : golsen 1.1 if ( $close ) { close $fh }
3627 :     }
3628 :    
3629 :    
3630 : golsen 1.14 #===============================================================================
3631 :     # Character sets for printer plot trees:
3632 : golsen 1.13 #-------------------------------------------------------------------------------
3633 : golsen 1.14
3634 : golsen 1.13 my %char_set =
3635 :     ( text1 => { space => ' ',
3636 :     horiz => '-',
3637 :     vert => '|',
3638 :     el_d_r => '/',
3639 :     el_u_r => '\\',
3640 :     el_d_l => '\\',
3641 :     el_u_l => '/',
3642 :     tee_l => '+',
3643 :     tee_r => '+',
3644 :     tee_u => '+',
3645 :     tee_d => '+',
3646 :     half_l => '-',
3647 :     half_r => '-',
3648 :     half_u => '|',
3649 :     half_d => '|',
3650 :     cross => '+',
3651 :     },
3652 :     text2 => { space => ' ',
3653 :     horiz => '-',
3654 :     vert => '|',
3655 :     el_d_r => '+',
3656 :     el_u_r => '+',
3657 :     el_d_l => '+',
3658 :     el_u_l => '+',
3659 :     tee_l => '+',
3660 :     tee_r => '+',
3661 :     tee_u => '+',
3662 :     tee_d => '+',
3663 :     half_l => '-',
3664 :     half_r => '-',
3665 :     half_u => '|',
3666 :     half_d => '|',
3667 :     cross => '+',
3668 :     },
3669 : golsen 1.14 html_box => { space => '&nbsp;',
3670 :     horiz => '&#9472;',
3671 :     vert => '&#9474;',
3672 :     el_d_r => '&#9484;',
3673 :     el_u_r => '&#9492;',
3674 :     el_d_l => '&#9488;',
3675 :     el_u_l => '&#9496;',
3676 :     tee_l => '&#9508;',
3677 :     tee_r => '&#9500;',
3678 :     tee_u => '&#9524;',
3679 :     tee_d => '&#9516;',
3680 :     half_l => '&#9588;',
3681 :     half_r => '&#9590;',
3682 :     half_u => '&#9589;',
3683 :     half_d => '&#9591;',
3684 :     cross => '&#9532;',
3685 : golsen 1.13 },
3686 : golsen 1.14 utf8_box => { space => ' ',
3687 : golsen 1.13 horiz => chr(226) . chr(148) . chr(128),
3688 :     vert => chr(226) . chr(148) . chr(130),
3689 :     el_d_r => chr(226) . chr(148) . chr(140),
3690 :     el_u_r => chr(226) . chr(148) . chr(148),
3691 :     el_d_l => chr(226) . chr(148) . chr(144),
3692 :     el_u_l => chr(226) . chr(148) . chr(152),
3693 :     tee_l => chr(226) . chr(148) . chr(164),
3694 :     tee_r => chr(226) . chr(148) . chr(156),
3695 :     tee_u => chr(226) . chr(148) . chr(180),
3696 :     tee_d => chr(226) . chr(148) . chr(172),
3697 :     half_l => chr(226) . chr(149) . chr(180),
3698 :     half_r => chr(226) . chr(149) . chr(182),
3699 :     half_u => chr(226) . chr(149) . chr(181),
3700 :     half_d => chr(226) . chr(149) . chr(183),
3701 :     cross => chr(226) . chr(148) . chr(188),
3702 :     },
3703 :     );
3704 :    
3705 : golsen 1.14 %{ $char_set{ html1 } } = %{ $char_set{ text1 } };
3706 :     $char_set{ html1 }->{ space } = '&nbsp;';
3707 :    
3708 :     %{ $char_set{ html2 } } = %{ $char_set{ text2 } };
3709 :     $char_set{ html2 }->{ space } = '&nbsp;';
3710 :    
3711 : golsen 1.13 # Define some synonyms
3712 : golsen 1.14
3713 :     $char_set{ html } = $char_set{ html_box };
3714 :     $char_set{ line } = $char_set{ utf8_box };
3715 :     $char_set{ symb } = $char_set{ utf8_box };
3716 : golsen 1.13 $char_set{ text } = $char_set{ text1 };
3717 : golsen 1.14 $char_set{ utf8 } = $char_set{ utf8_box };
3718 : golsen 1.13
3719 : golsen 1.14 # Define tree formats and synonyms
3720 :    
3721 :     my %tree_format =
3722 :     ( text => 'text',
3723 :     tree_tab_lbl => 'tree_tab_lbl',
3724 :     tree_lbl => 'tree_lbl',
3725 :     chrlist_lbl => 'chrlist_lbl',
3726 :     raw => 'chrlist_lbl',
3727 :     );
3728 : golsen 1.13
3729 : golsen 1.1 #===============================================================================
3730 :     # Make a text plot of a tree:
3731 :     #
3732 : golsen 1.13 # @lines = text_plot_newick( $node, $width, $min_dx, $dy )
3733 :     # @lines = text_plot_newick( $node, \%options )
3734 :     #
3735 :     # $node # newick tree root node
3736 :     # $width # the approximate characters for the tree without labels (D = 68)
3737 :     # $min_dx # the minimum horizontal branch length (D = 2)
3738 :     # $dy # the vertical space per taxon (D = 1, most compressed)
3739 :     #
3740 :     # Options:
3741 :     #
3742 : golsen 1.14 # chars => keyword # the output character set for the tree
3743 : golsen 1.13 # dy => nat_number # the vertical space per taxon
3744 : golsen 1.14 # format => keyword # output format of each line
3745 : golsen 1.13 # min_dx => whole_number # the minimum horizontal branch length
3746 :     # width => whole_number # approximate tree width without labels
3747 : golsen 1.1 #
3748 : golsen 1.14 # Character sets:
3749 :     #
3750 :     # html # synonym of html1
3751 :     # html_box # html encoding of unicode box drawing characters
3752 :     # html1 # text1 with nonbreaking spaces
3753 :     # html2 # text2 with nonbreaking spaces
3754 :     # line # synonym of utf8_box
3755 :     # raw # pass out the internal representation
3756 :     # symb # synonym of utf8_box
3757 :     # text # synonym of text1 (Default)
3758 :     # text1 # ascii characters: - + | / \ and space
3759 :     # text2 # ascii characters: - + | + + and space
3760 :     # utf8 # synonym of utf8_box
3761 :     # utf8_box # utf8 encoding of unicode box drawing characters
3762 :     #
3763 :     # Formats for row lines:
3764 :     #
3765 :     # text # $textstring # Default
3766 :     # tree_tab_lbl # $treestr \t $labelstr
3767 :     # tree_lbl # [ $treestr, $labelstr ]
3768 :     # chrlist_lbl # [ \@treechar, $labelstr ] # Forced with raw chars
3769 :     # raw # synonym of chrlist_lbl
3770 :     #
3771 : golsen 1.1 #===============================================================================
3772 : golsen 1.13 sub text_plot_newick
3773 :     {
3774 :     my $node = shift @_;
3775 : golsen 1.1 array_ref( $node ) || die "Bad node passed to text_plot_newick\n";
3776 : golsen 1.13
3777 : golsen 1.14 my ( $opts, $width, $min_dx, $dy, $chars, $fmt );
3778 : golsen 1.13 if ( $_[0] && ref $_[0] eq 'HASH' )
3779 :     {
3780 :     $opts = shift;
3781 :     }
3782 :     else
3783 :     {
3784 : golsen 1.14 ( $width, $min_dx, $dy ) = @_;
3785 : golsen 1.13 $opts = {};
3786 :     }
3787 :    
3788 : golsen 1.14 $chars = $opts->{ chars } || '';
3789 :     my $charH;
3790 :     $charH = $char_set{ $chars } || $char_set{ 'text1' } if ( $chars ne 'raw' );
3791 :     my $is_box = $charH eq $char_set{ html_box }
3792 :     || $charH eq $char_set{ utf8_box }
3793 :     || $chars eq 'raw';
3794 :    
3795 :     $fmt = ( $chars eq 'raw' ) ? 'chrlist_lbl' : $opts->{ format };
3796 :     $fmt = $tree_format{ $fmt || '' } || 'text';
3797 :    
3798 :     $dy ||= $opts->{ dy } || 1;
3799 :     $width ||= $opts->{ width } || 68;
3800 :     $min_dx = $opts->{ min_dx } if ( ! defined $min_dx || $min_dx < 0 );
3801 :     $min_dx = $is_box ? 1 : 2 if ( ! defined $min_dx || $min_dx < 0 );
3802 :    
3803 :     # Layout the tree:
3804 : golsen 1.1
3805 :     $min_dx = int( $min_dx );
3806 :     $dy = int( $dy );
3807 : golsen 1.5 my $x_scale = $width / ( newick_max_X( $node ) || 1 ); # Div by zero caught by RAE
3808 : golsen 1.1
3809 :     my $hash = {};
3810 :     layout_printer_plot( $node, $hash, 0, -0.5 * $dy, $x_scale, $min_dx, $dy );
3811 :    
3812 : golsen 1.14 # Generate the lines of the tree-one by-one:
3813 : golsen 1.1
3814 :     my ( $y1, $y2 ) = @{ $hash->{ $node } };
3815 : golsen 1.14 my @lines;
3816 :     foreach ( ( $y1 .. $y2 ) )
3817 : golsen 1.13 {
3818 : golsen 1.16 my $line = text_tree_row( $node, $hash, $_, [], 'tee_l', $dy >= 2 );
3819 : golsen 1.14 my $lbl = '';
3820 :     if ( @$line )
3821 : golsen 1.13 {
3822 : golsen 1.14 if ( $line->[-1] eq '' ) { pop @$line; $lbl = pop @$line }
3823 :     # Translate tree characters
3824 :     @$line = map { $charH->{ $_ } } @$line if $chars ne 'raw';
3825 : golsen 1.13 }
3826 :    
3827 : golsen 1.14 # Convert to requested output format:
3828 :    
3829 :     push @lines, $fmt eq 'text' ? join( '', @$line, ( $lbl ? " $lbl" : () ) )
3830 :     : $fmt eq 'text_tab_lbl' ? join( '', @$line, "\t", $lbl )
3831 :     : $fmt eq 'tree_lbl' ? [ join( '', @$line ), $lbl ]
3832 :     : $fmt eq 'chrlist_lbl' ? [ $line, $lbl ]
3833 :     : ();
3834 :     }
3835 :    
3836 :     # if ( $cells )
3837 :     # {
3838 :     # my $nmax = 0;
3839 :     # foreach ( @lines ) { $nmax = @$_ if @$_ > $nmax }
3840 :     # foreach ( @lines )
3841 :     # {
3842 :     # @$_ = map { "<TD>$_</TD>" } @$_;
3843 :     # my $span = $nmax - @$_ + 1;
3844 :     # $_->[-1] =~ s/^<TD>/<TD NoWrap ColSpan=$span>/;
3845 :     # }
3846 :     # }
3847 :     # elsif ( $tables )
3848 :     # {
3849 :     # my $nmax = 0;
3850 :     # foreach ( @lines ) { $nmax = @$_ if @$_ > $nmax }
3851 :     # foreach ( @lines )
3852 :     # {
3853 :     # @$_ = map { "<TD>$_</TD>" } @$_;
3854 :     # my $span = $nmax - @$_ + 1;
3855 :     # $_->[-1] =~ s/^<TD>/<TD NoWrap ColSpan=$span>/;
3856 :     # }
3857 :     # }
3858 :    
3859 :     wantarray ? @lines : \@lines;
3860 : golsen 1.1 }
3861 :    
3862 : golsen 1.14
3863 : golsen 1.1 #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3864 : golsen 1.14 # ( $xmax, $ymax, $root_y ) = layout_printer_plot( $node, $hash, $x0, $y0, $x_scale, $min_dx, $dy, $yrnd )
3865 : golsen 1.1 #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3866 : golsen 1.13 sub layout_printer_plot
3867 :     {
3868 : golsen 1.14 my ( $node, $hash, $x0, $y0, $x_scale, $min_dx, $dy, $yrnd ) = @_;
3869 : golsen 1.1 array_ref( $node ) || die "Bad node ref passed to layout_printer_plot\n";
3870 :     hash_ref( $hash ) || die "Bad hash ref passed to layout_printer_plot\n";
3871 :    
3872 :     my $dx = newick_x( $node );
3873 :     if ( defined( $dx ) ) {
3874 :     $dx *= $x_scale;
3875 : golsen 1.14 $dx = $min_dx if $dx < $min_dx;
3876 : golsen 1.1 }
3877 :     else {
3878 :     $dx = ( $x0 > 0 ) ? $min_dx : 0;
3879 :     }
3880 :     $dx = int( $dx + 0.4999 );
3881 :    
3882 :     my ( $x, $xmax, $y, $ymax, $y1, $y2, $yn1, $yn2 );
3883 :    
3884 :     $x = $x0 + $dx;
3885 :     $y1 = int( $y0 + 0.5 * $dy + 0.4999 );
3886 :     my @dl = newick_desc_list( $node );
3887 :    
3888 :     if ( ! @dl ) { # A tip
3889 :     $xmax = $x;
3890 :     $y = $yn1 = $yn2 = $y2 = $y1;
3891 :     $ymax = $y + 0.5 * $dy;
3892 :     }
3893 :    
3894 :     else { # A subtree
3895 :     $xmax = -1;
3896 :     my $xmaxi;
3897 :     my $yi;
3898 :     my @ylist = ();
3899 :     $ymax = $y0;
3900 :    
3901 :     foreach ( @dl ) {
3902 : golsen 1.14 ( $xmaxi, $ymax, $yi ) = layout_printer_plot( $_, $hash, $x, $ymax, $x_scale, $min_dx, $dy,
3903 :     ( 2*@ylist < @dl ? 0.5001 : 0.4999 )
3904 :     );
3905 : golsen 1.1 push @ylist, $yi;
3906 :     if ( $xmaxi > $xmax ) { $xmax = $xmaxi }
3907 :     }
3908 :    
3909 :     # Use of y-list is overkill for saving first and last values,
3910 :     # but eases implimentation of alternative y-value calculations.
3911 :    
3912 :     $yn1 = $ylist[ 0];
3913 :     $yn2 = $ylist[-1];
3914 : golsen 1.16 $y = int( 0.5 * ( $yn1 + $yn2 ) + ( $yrnd || 0.4999 ) );
3915 :    
3916 :     # Handle special case of internal node label. Put it between subtrees.
3917 :    
3918 :     if ( ( $dy >= 2 ) && newick_lbl( $node ) && ( @dl > 1 ) ) {
3919 :     # Find the descendents $i1 and $i2 to put the branch between
3920 :     my $i2 = 1;
3921 :     while ( ( $i2+1 < @ylist ) && ( $ylist[$i2] < $y ) ) { $i2++ }
3922 :     my $i1 = $i2 - 1;
3923 :     # Get bottom of subtree1 and top of subtree2:
3924 :     my $ymax1 = $hash->{ $dl[ $i1 ] }->[ 1 ];
3925 :     my $ymin2 = $hash->{ $dl[ $i2 ] }->[ 0 ];
3926 :     # Midway between bottom of subtree1 and top of subtree2, with
3927 :     # preferred rounding direction
3928 :     $y = int( 0.5 * ( $ymax1 + $ymin2 ) + ( $yrnd || 0.4999 ) );
3929 :     }
3930 : golsen 1.1 }
3931 :    
3932 :     $y2 = int( $ymax - 0.5 * $dy + 0.4999 );
3933 :    
3934 :     $hash->{ $node } = [ $y1, $y2, $x0, $x, $y, $yn1, $yn2 ];
3935 :     ( $xmax, $ymax, $y );
3936 :     }
3937 :    
3938 :    
3939 : golsen 1.14 # What symbol do we get if we add a leftward line to some other symbol?
3940 :    
3941 :     my %with_left_line = ( space => 'half_l',
3942 :     horiz => 'horiz',
3943 :     vert => 'tee_l',
3944 :     el_d_r => 'tee_d',
3945 :     el_u_r => 'tee_u',
3946 :     el_d_l => 'el_d_l',
3947 :     el_u_l => 'el_u_l',
3948 :     tee_l => 'tee_l',
3949 :     tee_r => 'cross',
3950 :     tee_u => 'tee_u',
3951 :     tee_d => 'tee_d',
3952 :     half_l => 'half_l',
3953 :     half_r => 'horiz',
3954 :     half_u => 'el_u_l',
3955 :     half_d => 'el_d_l',
3956 :     cross => 'cross',
3957 :     );
3958 :    
3959 : golsen 1.1 #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3960 : golsen 1.14 # Produce a description of one line of a printer plot tree.
3961 :     #
3962 : golsen 1.16 # \@line = text_tree_row( $node, $hash, $row, \@line, $symb, $ilbl )
3963 : golsen 1.14 #
3964 :     # \@line is the character descriptions accumulated so far, one per array
3965 :     # element, except for a label, which can be any number of characters.
3966 :     # Labels are followed by an empty string, so if $line->[-1] eq '',
3967 :     # then $line->[-2] is a label. The calling program translates the
3968 :     # symbol names to output characters.
3969 :     #
3970 :     # \@node is a newick tree node
3971 :     # \%hash contains tree layout information
3972 :     # $row is the row number (y value) that we are building
3973 :     # $symb is the plot symbol proposed for the current x and y position
3974 : golsen 1.16 # $ilbl is true if internal node labels are allowed
3975 : golsen 1.14 #
3976 : golsen 1.1 #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3977 : golsen 1.13 sub text_tree_row
3978 :     {
3979 : golsen 1.16 my ( $node, $hash, $row, $line, $symb, $ilbl ) = @_;
3980 : golsen 1.1
3981 :     my ( $y1, $y2, $x0, $x, $y, $yn1, $yn2 ) = @{ $hash->{ $node } };
3982 :     if ( $row < $y1 || $row > $y2 ) { return $line }
3983 :    
3984 : golsen 1.14 if ( @$line < $x0 ) { push @$line, ('space') x ( $x0 - @$line ) }
3985 : golsen 1.1
3986 :     if ( $row == $y ) {
3987 : golsen 1.14 while ( @$line > $x0 ) { pop @$line } # Actually 0-1 times
3988 :     push @$line, $symb,
3989 :     ( ( $x > $x0 ) ? ('horiz') x ($x - $x0) : () );
3990 : golsen 1.1 }
3991 :    
3992 :     elsif ( $row > $yn1 && $row < $yn2 ) {
3993 : golsen 1.14 if ( @$line < $x ) { push @$line, ('space') x ( $x - @$line ), 'vert' }
3994 :     else { $line->[$x] = 'vert' }
3995 : golsen 1.1 }
3996 :    
3997 :     my @dl = newick_desc_list( $node );
3998 :    
3999 : golsen 1.14 if ( @dl < 1 ) { push @$line, ( newick_lbl( $node ) || '' ), '' }
4000 : golsen 1.1
4001 :     else {
4002 : golsen 1.14 my @list = map { [ $_, 'tee_r' ] } @dl; # Line to the right
4003 :     if ( @list > 1 ) { # Fix top and bottom sympbols
4004 :     $list[ 0]->[1] = 'el_d_r';
4005 :     $list[-1]->[1] = 'el_u_r';
4006 :     }
4007 :     elsif ( @list ) { # Only one descendent
4008 :     $list[ 0]->[1] = 'half_r';
4009 :     }
4010 : golsen 1.1 foreach ( @list ) {
4011 :     my ( $n, $s ) = @$_;
4012 :     if ( $row >= $hash->{ $n }->[0] && $row <= $hash->{ $n }->[1] ) {
4013 : golsen 1.16 $line = text_tree_row( $n, $hash, $row, $line, $s, $ilbl );
4014 : golsen 1.1 }
4015 : golsen 1.16 }
4016 : golsen 1.1
4017 : golsen 1.14 if ( $row == $y ) {
4018 :     $line->[$x] = ( $line->[$x] eq 'horiz' ) ? 'tee_l'
4019 :     : $with_left_line{ $line->[$x] };
4020 : golsen 1.16 push( @$line, newick_lbl( $node ), '' ) if $ilbl && newick_lbl( $node );
4021 : golsen 1.13 }
4022 : golsen 1.1 }
4023 :    
4024 :     return $line;
4025 :     }
4026 :    
4027 :    
4028 : golsen 1.13 #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4029 :     # Debug routine
4030 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4031 :     sub dump_tree {
4032 :     my ( $node, $prefix ) = @_;
4033 :     defined( $prefix ) or $prefix = "";
4034 :     print STDERR $prefix, join(", ", @$node), "\n";
4035 :     my @dl = $node->[0] ? @{$node->[0]} : ();
4036 :     foreach ( @dl ) { dump_tree( $_, $prefix . " " ) }
4037 :     $prefix or print STDERR "\n";
4038 :     }
4039 :    
4040 :    
4041 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4042 :     # Debug routine
4043 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
4044 :     sub dump_tree_hash {
4045 :     my ( $node, $hash, $prefix ) = @_;
4046 :     defined( $prefix ) or print STDERR "node; [ y1, y2, x0, x, y, yn1, yn2 ]\n" and $prefix = "";
4047 :     print STDERR $prefix, join(", ", @$node), "; ", join(", ", @{ $hash->{ $node } } ), "\n";
4048 :     my @dl = $node->[0] ? @{$node->[0]} : ();
4049 :     foreach (@dl) { dump_tree_hash( $_, $hash, $prefix . " " ) }
4050 :     }
4051 :    
4052 :    
4053 : overbeek 1.7 #===============================================================================
4054 :     # Open an input file stream:
4055 :     #
4056 :     # ( $handle, undef ) = open_input( ); # \*STDIN
4057 :     # ( $handle, undef ) = open_input( \*FH );
4058 :     # ( $handle, 1 ) = open_input( $file ); # need to close $handle
4059 :     #
4060 :     #===============================================================================
4061 :     sub open_input
4062 :     {
4063 :     my $file = shift;
4064 :     my $fh;
4065 : golsen 1.21 if ( ! defined $file || $file eq '' ) { return ( \*STDIN ) }
4066 :     elsif ( ref( $file ) eq 'GLOB' ) { return ( $file ) }
4067 :     elsif ( open( $fh, "<$file" ) ) { return ( $fh, 1 ) } # Need to close
4068 : overbeek 1.7
4069 :     print STDERR "gjonewick::open_input could not open '$file' for reading\n";
4070 :     return undef;
4071 :     }
4072 :    
4073 :    
4074 :     #===============================================================================
4075 :     # Open an output file stream:
4076 :     #
4077 :     # ( $handle, undef ) = open_output( ); # \*STDOUT
4078 :     # ( $handle, undef ) = open_output( \*FH );
4079 :     # ( $handle, 1 ) = open_output( $file ); # need to close $handle
4080 :     #
4081 :     #===============================================================================
4082 :     sub open_output
4083 :     {
4084 :     my $file = shift;
4085 :     my $fh;
4086 : golsen 1.21 if ( ! defined $file || $file eq '' ) { return ( \*STDOUT ) }
4087 :     elsif ( ref( $file ) eq 'GLOB' ) { return ( $file ) }
4088 :     elsif ( ( open $fh, ">$file" ) ) { return ( $fh, 1 ) } # Need to close
4089 : overbeek 1.7
4090 :     print STDERR "gjonewick::open_output could not open '$file' for writing\n";
4091 :     return undef;
4092 :     }
4093 :    
4094 : golsen 1.9
4095 :     #===============================================================================
4096 :     # Some subroutines copied from gjolists
4097 :     #===============================================================================
4098 :     # Return the common prefix of two lists:
4099 :     #
4100 :     # @common = common_prefix( \@list1, \@list2 )
4101 :     #-----------------------------------------------------------------------------
4102 :     sub common_prefix
4103 :     {
4104 :     my ($l1, $l2) = @_;
4105 :     ref($l1) eq "ARRAY" || die "common_prefix: arg 1 is not an array ref\n";
4106 :     ref($l2) eq "ARRAY" || die "common_prefix: arg 2 is not an array ref\n";
4107 :    
4108 :     my $i = 0;
4109 :     my $l1_i;
4110 :     while ( defined( $l1_i = $l1->[$i] ) && $l1_i eq $l2->[$i] ) { $i++ }
4111 :    
4112 :     return @$l1[ 0 .. ($i-1) ]; # perl handles negative range
4113 :     }
4114 :    
4115 :    
4116 :     #-----------------------------------------------------------------------------
4117 :     # Return the unique suffixes of each of two lists:
4118 :     #
4119 :     # ( \@suffix1, \@suffix2 ) = unique_suffixes( \@list1, \@list2 )
4120 :     #-----------------------------------------------------------------------------
4121 :     sub unique_suffixes
4122 :     {
4123 :     my ($l1, $l2) = @_;
4124 :     ref($l1) eq "ARRAY" || die "common_prefix: arg 1 is not an array ref\n";
4125 :     ref($l2) eq "ARRAY" || die "common_prefix: arg 2 is not an array ref\n";
4126 :    
4127 :     my $i = 0;
4128 :     my @l1 = @$l1;
4129 :     my @l2 = @$l2;
4130 :     my $l1_i;
4131 :     while ( defined( $l1_i = $l1[$i] ) && $l1_i eq $l2[$i] ) { $i++ }
4132 :    
4133 :     splice @l1, 0, $i;
4134 :     splice @l2, 0, $i;
4135 :     return ( \@l1, \@l2 );
4136 :     }
4137 :    
4138 :    
4139 :     #-------------------------------------------------------------------------------
4140 :     # List of values duplicated in a list (stable in order by second occurance):
4141 :     #
4142 :     # @dups = duplicates( @list )
4143 :     #-------------------------------------------------------------------------------
4144 :     sub duplicates
4145 :     {
4146 :     my %cnt = ();
4147 :     grep { ++$cnt{$_} == 2 } @_;
4148 :     }
4149 :    
4150 :    
4151 :     #-------------------------------------------------------------------------------
4152 :     # Randomize the order of a list:
4153 :     #
4154 :     # @random = random_order( @list )
4155 :     #-------------------------------------------------------------------------------
4156 :     sub random_order
4157 :     {
4158 :     my ( $i, $j );
4159 :     for ( $i = @_ - 1; $i > 0; $i-- )
4160 :     {
4161 :     $j = int( ($i+1) * rand() );
4162 :     ( $_[$i], $_[$j] ) = ( $_[$j], $_[$i] ); # Interchange i and j
4163 :     }
4164 :    
4165 :     @_;
4166 :     }
4167 :    
4168 :    
4169 :     #-----------------------------------------------------------------------------
4170 :     # Intersection of two or more sets:
4171 :     #
4172 :     # @intersection = intersection( \@set1, \@set2, ... )
4173 :     #-----------------------------------------------------------------------------
4174 :     sub intersection
4175 :     {
4176 :     my $set = shift;
4177 :     my @intersection = @$set;
4178 :    
4179 :     foreach $set ( @_ )
4180 :     {
4181 :     my %set = map { $_ => 1 } @$set;
4182 :     @intersection = grep { exists $set{ $_ } } @intersection;
4183 :     }
4184 :    
4185 :     @intersection;
4186 :     }
4187 :    
4188 :    
4189 :     #-----------------------------------------------------------------------------
4190 :     # Elements in set 1, but not set 2:
4191 :     #
4192 :     # @difference = set_difference( \@set1, \@set2 )
4193 :     #-----------------------------------------------------------------------------
4194 :     sub set_difference
4195 :     {
4196 :     my ($set1, $set2) = @_;
4197 :     my %set2 = map { $_ => 1 } @$set2;
4198 :     grep { ! ( exists $set2{$_} ) } @$set1;
4199 :     }
4200 :    
4201 :    
4202 : golsen 1.1 1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3