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

Annotation of /FigKernelPackages/gjonewicklib.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3