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

Annotation of /FigKernelPackages/gjonewicklib.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3