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

Annotation of /FigKernelPackages/gjonewicklib.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3