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

Annotation of /FigKernelPackages/gjonewicklib.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.8 - (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 :     #
7 :     # The SEED Toolkit is free software. You can redistribute
8 :     # it and/or modify it under the terms of the SEED Toolkit
9 :     # Public License.
10 :     #
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 :     #
37 :     # 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 :     # $gjonewick = overbeek_to_gjonewick( $overbeek )
81 :     # $overbeek = gjonewick_to_overbeek( $gjonewick )
82 :     #
83 : golsen 1.1 #===============================================================================
84 :     # Tree data extraction:
85 :     #===============================================================================
86 :     #
87 :     # $listref = newick_desc_ref( $noderef )
88 :     # $label = newick_lbl( $noderef )
89 :     # $x = newick_x( $noderef )
90 :     # $listref = newick_c1( $noderef )
91 :     # $listref = newick_c2( $noderef )
92 :     # $listref = newick_c3( $noderef )
93 :     # $listref = newick_c4( $noderef )
94 :     # $listref = newick_c5( $noderef )
95 :     #
96 :     # @desclist = newick_desc_list( $noderef )
97 :     # $n = newick_n_desc( $noderef )
98 :     # $descref = newick_desc_i( $noderef, $i ) # 1-based numbering
99 :     # $bool = newick_is_tip( $noderef )
100 :     #
101 :     # set_newick_desc_ref( $noderef, $listref )
102 :     # set_newick_lbl( $noderef, $label )
103 :     # set_newick_x( $noderef, $x )
104 :     # set_newick_c1( $noderef, $listref )
105 :     # set_newick_c2( $noderef, $listref )
106 :     # set_newick_c3( $noderef, $listref )
107 :     # set_newick_c4( $noderef, $listref )
108 :     # set_newick_c5( $noderef, $listref )
109 :     # set_newick_desc_list( $noderef, @desclist )
110 : golsen 1.8 # set_newick_desc_i( $noderef1, $i, $noderef2 )
111 :     #
112 :     # $bool = newick_is_valid( $noderef ) # verify that tree is valid
113 : golsen 1.1 #
114 :     # $bool = newick_is_rooted( $noderef ) # 2 branches from root
115 :     # $bool = newick_is_unrooted( $noderef ) # 3 or more branches from root
116 :     # $bool = newick_is_tip_rooted( $noderef ) # 1 branch from root
117 :     # $bool = newick_is_bifurcating( $noderef )
118 :     #
119 :     # $n = newick_tip_count( $noderef )
120 :     # @tiprefs = newick_tip_ref_list( $noderef )
121 :     # @tips = newick_tip_list( $noderef )
122 :     # $tipref = newick_first_tip_ref( $noderef )
123 :     # $tip = newick_first_tip( $noderef )
124 :     # @tips = newick_duplicated_tips( $noderef )
125 :     # $bool = newick_tip_in_tree( $noderef, $tipname )
126 :     # @tips = newick_shared_tips( $tree1, $tree2 )
127 :     #
128 :     # $length = newick_tree_length( $noderef )
129 :     # $xmax = newick_max_X( $noderef )
130 :     # ( $tipref, $xmax ) = newick_most_distant_tip_ref( $noderef )
131 :     # ( $tipname, $xmax ) = newick_most_distant_tip( $noderef )
132 :     #
133 : golsen 1.8 # Tree tip insertion point (tip is on branch of length x that
134 :     # is inserted into branch connecting node1 and node2, a distance
135 :     # x1 from node1 and x2 from node2):
136 :     #
137 :     # [ $node1, $x1, $node2, $x2, $x ]
138 :     # = newick_tip_insertion_point( $tree, $tip )
139 :     #
140 :     # Standardized label for a node in terms of intersection of 3 lowest sorting
141 :     # tips (sort is lower case):
142 :     #
143 :     # @TipOrTips = std_node_name( $Tree, $Node )
144 :     #
145 : golsen 1.1 #-------------------------------------------------------------------------------
146 :     # Paths from root of tree:
147 :     #-------------------------------------------------------------------------------
148 :     #
149 :     # Path descriptions are of form:
150 :     # ( $node0, $i0, $node1, $i1, $node2, $i2, ..., $nodeN )
151 :     # () is returned upon failure
152 :     #
153 :     # @path = path_to_tip( $treenode, $tipname )
154 :     # @path = path_to_named_node( $treenode, $nodename )
155 :     # @path = path_to_node_ref( $treenode, $noderef )
156 :     #
157 :     # @path = path_to_node( $node, $tip1, $tip2, $tip3 ) # 3 tip names
158 :     # @path = path_to_node( $node, [ $tip1, $tip2, $tip3 ] ) # Array of tips
159 :     # @path = path_to_node( $node, $tip1 ) # Use path_to_tip
160 :     # @path = path_to_node( $node, [ $tip1 ] ) # Use path_to_tip
161 :     #
162 :     # $distance = newick_path_length( @path )
163 :     # $distance = tip_to_tip_distance( $tree, $tip1, $tip2 )
164 :     # $distance = node_to_node_distance( $tree, $node1, $node2 )
165 :     #
166 :     #
167 :     #===============================================================================
168 :     # Tree manipulations:
169 :     #===============================================================================
170 :     #
171 : overbeek 1.4 # $treecopy = copy_newick_tree( $tree )
172 : golsen 1.1 #
173 :     #-------------------------------------------------------------------------------
174 : golsen 1.8 # The following modify the existing tree, and possibly any components of that
175 : golsen 1.1 # tree that are reached by reference. If the old version is still needed, copy
176 :     # before modifying.
177 :     #-------------------------------------------------------------------------------
178 :     #
179 :     # Modify labels:
180 :     #
181 :     # $newtree = newick_relabel_nodes( $node, \%new_name )
182 :     # $newtree = newick_relabel_nodes_i( $node, \%new_name )
183 :     # $newtree = newick_relabel_tips( $node, \%new_name )
184 :     # $newtree = newick_relabel_tips_i( $node, \%new_name )
185 :     #
186 :     # Modify branches:
187 :     #
188 :     # $n_changed = newick_set_undefined_branches( $node, $x )
189 :     # $n_changed = newick_set_all_branches( $node, $x )
190 : golsen 1.5 # $n_changed = newick_fix_negative_branches( $tree )
191 : overbeek 1.7 # $node = newick_rescale_branches( $node, $factor )
192 : golsen 1.1 #
193 : golsen 1.8 # Modify comments:
194 :     #
195 :     # $node = newick_strip_comments( $node )
196 :     #
197 : golsen 1.1 # Modify rooting and/or order:
198 :     #
199 :     # $nrmtree = normalize_newick_tree( $tree )
200 :     # $revtree = reverse_newick_tree( $tree )
201 :     # $stdtree = std_unrooted_newick( $tree )
202 :     # $newtree = aesthetic_newick_tree( $tree, $direction )
203 :     # $rndtree = random_order_newick_tree( $tree )
204 :     # $newtree = reroot_newick_by_path( @path )
205 :     # $newtree = reroot_newick_to_tip( $tree, $tip )
206 :     # $newtree = reroot_newick_next_to_tip( $tree, $tip )
207 :     # $newtree = reroot_newick_to_node( $tree, @node )
208 :     # $newtree = reroot_newick_to_node_ref( $tree, $noderef )
209 :     # $newtree = reroot_newick_to_node_ref( $tree, $noderef )
210 : golsen 1.5 # $newtree = reroot_newick_to_approx_midpoint( $tree ) # unweighted
211 :     # $newtree = reroot_newick_to_approx_midpoint_w( $tree ) # weight by tips
212 : golsen 1.1 # $newtree = uproot_tip_rooted_newick( $tree )
213 :     # $newtree = uproot_newick( $tree )
214 :     #
215 :     # $newtree = prune_from_newick( $tree, $tip )
216 :     # $newtree = newick_subtree( $tree, @tips )
217 :     # $newtree = newick_subtree( $tree, \@tips )
218 :     #
219 : golsen 1.5 # $newtree = collapse_zero_length_branches( $tree )
220 :     #
221 : golsen 1.8 # $node = newick_insert_at_node( $node, $subtree )
222 :     # $tree = newick_insert_between_nodes( $tree, $subtree, $node1, $node2, $fraction )
223 :     #
224 : golsen 1.1 #===============================================================================
225 :     # Tree reading and writing:
226 :     #===============================================================================
227 :     #
228 :     # writeNewickTree( $tree )
229 :     # writeNewickTree( $tree, $file )
230 : overbeek 1.7 # writeNewickTree( $tree, \*FH )
231 :     # fwriteNewickTree( $file, $tree ) # Matches the C arg list for f... I/O
232 : golsen 1.1 # $treestring = swriteNewickTree( $tree )
233 :     # $treestring = formatNewickTree( $tree )
234 :     # @textlines = text_plot_newick( $node, $width, $min_dx, $dy )
235 :     # printer_plot_newick( $node, $file, $width, $min_dx, $dy )
236 :     #
237 : overbeek 1.7 # $tree = read_newick_tree( $file ) # reads to a semicolon
238 :     # @trees = read_newick_trees( $file ) # reads to end of file
239 :     # $tree = parse_newick_tree_str( $string )
240 : golsen 1.1 #
241 :     #===============================================================================
242 :    
243 :    
244 : golsen 1.8 use Carp;
245 :     use Data::Dumper;
246 :    
247 : golsen 1.1 require Exporter;
248 :    
249 :     our @ISA = qw(Exporter);
250 :     our @EXPORT = qw(
251 : overbeek 1.7 overbeek_to_gjonewick
252 :     gjonewick_to_overbeek
253 :    
254 : golsen 1.8 newick_is_valid
255 : golsen 1.1 newick_is_rooted
256 :     newick_is_unrooted
257 :     tree_rooted_on_tip
258 :     newick_is_bifurcating
259 :     newick_tip_count
260 :     newick_tip_list
261 :     newick_first_tip
262 :     newick_duplicated_tips
263 :     newick_tip_in_tree
264 :     newick_shared_tips
265 :    
266 :     newick_tree_length
267 :     newick_max_X
268 :     newick_most_distant_tip_ref
269 :     newick_most_distant_tip_name
270 :    
271 :     std_newick_name
272 :    
273 :     path_to_tip
274 :     path_to_named_node
275 :     path_to_node_ref
276 :     path_to_node
277 :    
278 :     newick_path_length
279 :     tip_to_tip_distance
280 :     node_to_node_distance
281 :    
282 : overbeek 1.4 copy_newick_tree
283 : golsen 1.1
284 :     newick_relabel_nodes
285 :     newick_relabel_nodes_i
286 :     newick_relabel_tips
287 :     newick_relabel_tips_i
288 :    
289 :     newick_set_undefined_branches
290 :     newick_set_all_branches
291 : golsen 1.5 newick_fix_negative_branches
292 : overbeek 1.7 newick_rescale_branches
293 : golsen 1.1
294 : golsen 1.8 newick_strip_comments
295 :    
296 : golsen 1.1 normalize_newick_tree
297 :     reverse_newick_tree
298 :     std_unrooted_newick
299 :     aesthetic_newick_tree
300 :     unaesthetic_newick_tree
301 :     random_order_newick_tree
302 :    
303 :     reroot_newick_by_path
304 :     reroot_newick_to_tip
305 :     reroot_newick_next_to_tip
306 :     reroot_newick_to_node
307 :     reroot_newick_to_node_ref
308 :     reroot_newick_to_approx_midpoint
309 : golsen 1.5 reroot_newick_to_approx_midpoint_w
310 : golsen 1.1 uproot_tip_rooted_newick
311 :     uproot_newick
312 :    
313 :     prune_from_newick
314 :     newick_subtree
315 : golsen 1.5 collapse_zero_length_branches
316 : golsen 1.1
317 : golsen 1.8 newick_insert_at_node
318 :     newick_insert_between_nodes
319 :    
320 : golsen 1.1 writeNewickTree
321 :     fwriteNewickTree
322 :     strNewickTree
323 :     formatNewickTree
324 : overbeek 1.7
325 :     read_newick_tree
326 :     read_newick_trees
327 : golsen 1.1 parse_newick_tree_str
328 :    
329 :     printer_plot_newick
330 :     text_plot_newick
331 :     );
332 :    
333 :     our @EXPORT_OK = qw(
334 :     newick_desc_ref
335 :     newick_lbl
336 :     newick_x
337 :     newick_c1
338 :     newick_c2
339 :     newick_c3
340 :     newick_c4
341 :     newick_c5
342 :     newick_desc_list
343 :     newick_n_desc
344 :     newick_desc_i
345 :     newick_is_tip
346 :     newick_is_valid
347 :    
348 :     set_newick_desc_ref
349 :     set_newick_lbl
350 :     set_newick_x
351 :     set_newick_c1
352 :     set_newick_c2
353 :     set_newick_c3
354 :     set_newick_c4
355 :     set_newick_c5
356 :    
357 :     set_newick_desc_list
358 :     set_newick_desc_i
359 :    
360 :     add_to_newick_branch
361 :     dump_tree
362 :     );
363 :    
364 :    
365 :     use gjolists qw(
366 :     common_prefix
367 :     unique_suffixes
368 : overbeek 1.7
369 : golsen 1.1 duplicates
370 :     random_order
371 :    
372 :     intersection
373 :     set_difference
374 :     );
375 :    
376 :    
377 :     use strict;
378 :    
379 :    
380 :     #-------------------------------------------------------------------------------
381 :     # Internally used definitions
382 :     #-------------------------------------------------------------------------------
383 :    
384 :     sub array_ref { ref( $_[0] ) eq "ARRAY" }
385 :     sub hash_ref { ref( $_[0] ) eq "HASH" }
386 :    
387 :    
388 :     #===============================================================================
389 : overbeek 1.7 # Interconvert Overbeek and gjonewick trees:
390 :     #===============================================================================
391 :    
392 :     sub overbeek_to_gjonewick
393 :     {
394 :     return () unless ref( $_[0] ) eq 'ARRAY';
395 :     my ( $lbl, $x, $desc ) = @{ $_[0] };
396 :     my ( undef, @desc ) = ( $desc && ref( $desc ) eq 'ARRAY' ) ? @$desc : ();
397 :     [ [ map { overbeek_to_gjonewick( $_ ) } @desc ], $lbl, $x ]
398 :     }
399 :    
400 :     sub gjonewick_to_overbeek
401 :     {
402 :     return () unless ref( $_[0] ) eq 'ARRAY';
403 :     my ( $desc, $lbl, $x ) = @{ $_[0] };
404 :     my @desc = ( $desc && ref( $desc ) eq 'ARRAY' ) ? @$desc : ();
405 :     my $parent = $_[1];
406 :     my $node = [ $lbl, $x, undef, [] ];
407 :     $node->[2] = [ $parent, map { gjonewick_to_overbeek( $_, $node ) } @desc ];
408 :     return $node;
409 :     }
410 :    
411 :     #===============================================================================
412 : golsen 1.1 # Extract tree structure values:
413 :     #===============================================================================
414 :     #
415 :     # $listref = newick_desc_ref( $noderef )
416 :     # $string = newick_lbl( $noderef )
417 :     # $real = newick_x( $noderef )
418 :     # $listref = newick_c1( $noderef )
419 :     # $listref = newick_c2( $noderef )
420 :     # $listref = newick_c3( $noderef )
421 :     # $listref = newick_c4( $noderef )
422 :     # $listref = newick_c5( $noderef )
423 :     # @list = newick_desc_list( $noderef )
424 :     # $int = newick_n_desc( $noderef )
425 :     # $listref = newick_desc_i( $noderef )
426 :     # $bool = node_is_tip( $noderef )
427 :     # $bool = node_is_valid( $noderef )
428 :     #
429 :     #-------------------------------------------------------------------------------
430 :    
431 :     sub newick_desc_ref { $_[0]->[0] } # = ${$_[0]}[0]
432 : golsen 1.8 sub newick_lbl { ref($_[0]) ? $_[0]->[1] : Carp::confess() }
433 : golsen 1.1 sub newick_x { $_[0]->[2] }
434 :     sub newick_c1 { $_[0]->[3] }
435 :     sub newick_c2 { $_[0]->[4] }
436 :     sub newick_c3 { $_[0]->[5] }
437 :     sub newick_c4 { $_[0]->[6] }
438 :     sub newick_c5 { $_[0]->[7] }
439 :    
440 :     sub newick_desc_list {
441 :     my $node = $_[0];
442 :     ! array_ref( $node ) ? undef :
443 :     array_ref( $node->[0] ) ? @{ $node->[0] } :
444 :     () ;
445 :     }
446 :    
447 :     sub newick_n_desc {
448 :     my $node = $_[0];
449 :     ! array_ref( $node ) ? undef :
450 :     array_ref( $node->[0] ) ? scalar @{ $node->[0] } :
451 :     0 ;
452 :     }
453 :    
454 :     sub newick_desc_i {
455 :     my ( $node, $i ) = @_;
456 :     ! array_ref( $node ) ? undef :
457 :     array_ref( $node->[0] ) ? $node->[0]->[$i-1] :
458 :     undef ;
459 :     }
460 :    
461 :     sub node_is_tip {
462 :     my $node = $_[0];
463 :     ! array_ref( $node ) ? undef : # Not a node ref
464 :     array_ref( $node->[0] ) ? @{ $node->[0] } == 0 : # Empty descend list?
465 :     1 ; # No descend list
466 :     }
467 :    
468 :     sub node_is_valid { # An array ref with nonempty descend list or a label
469 :     my $node = $_[0];
470 :     array_ref( $node ) && ( array_ref( $node->[0] ) && @{ $node->[0] }
471 :     || defined( $node->[1] )
472 :     )
473 :     }
474 :    
475 :    
476 :     #-------------------------------------------------------------------------------
477 :     # Set tree structure values
478 :     #-------------------------------------------------------------------------------
479 :    
480 :     sub set_newick_desc_ref { $_[0]->[0] = $_[1] }
481 :     sub set_newick_lbl { $_[0]->[1] = $_[1] }
482 :     sub set_newick_x { $_[0]->[2] = $_[1] }
483 :     sub set_newick_c1 { $_[0]->[3] = $_[1] }
484 :     sub set_newick_c2 { $_[0]->[4] = $_[1] }
485 :     sub set_newick_c3 { $_[0]->[5] = $_[1] }
486 :     sub set_newick_c4 { $_[0]->[6] = $_[1] }
487 :     sub set_newick_c5 { $_[0]->[7] = $_[1] }
488 :    
489 :     sub set_newick_desc_list {
490 :     my $node = shift;
491 :     array_ref( $node ) || return;
492 :     if ( array_ref( $node->[0] ) ) { @{ $node->[0] } = @_ }
493 :     else { $node->[0] = [ @_ ] }
494 :     }
495 :    
496 :     sub set_newick_desc_i {
497 :     my ( $node1, $i, $node2 ) = @_;
498 :     array_ref( $node1 ) && array_ref( $node2 ) || return;
499 :     if ( array_ref( $node1->[0] ) ) { $node1->[0]->[$i-1] = $node2 }
500 :     else { $node1->[0] = [ $node2 ] }
501 :     }
502 :    
503 :    
504 :     #===============================================================================
505 :     # Some tree property tests:
506 :     #===============================================================================
507 : golsen 1.8 # Tree is valid?
508 :     #
509 :     # $bool = newick_is_valid( $node, $verbose )
510 :     #-------------------------------------------------------------------------------
511 :     sub newick_is_valid
512 :     {
513 :     my $node = shift;
514 :    
515 :     if ( ! array_ref( $node ) )
516 :     {
517 :     print STDERR "Node is not array reference\n" if $_[0];
518 :     return 0;
519 :     }
520 :    
521 :     my @node = @$node;
522 :     if ( ! @node )
523 :     {
524 :     print STDERR "Node is empty array reference\n" if $_[0];
525 :     return 0;
526 :     }
527 :    
528 :     # Must have descendant or label:
529 :    
530 :     if ( ! ( array_ref( $node[0] ) && @{ $node[0] } ) && ! $node[2] )
531 :     {
532 :     print STDERR "Node has neither descendant nor label\n" if $_[0];
533 :     return 0;
534 :     }
535 :    
536 :     # If comments are present, they must be array references
537 :    
538 :     foreach ( ( @node > 3 ) ? @node[ 3 .. $#node ] : () )
539 :     {
540 :     if ( defined( $_ ) && ! array_ref( $_ ) )
541 :     {
542 :     print STDERR "Node has neither descendant or label\n" if $_[0];
543 :     return 0;
544 :     }
545 :     }
546 :    
547 :     # Inspect the descendants:
548 :    
549 :     foreach ( array_ref( $node[0] ) ? @{ $node[0] } : () )
550 :     {
551 :     newick_is_valid( $_, @_ ) || return 0
552 :     }
553 :    
554 :     return 1;
555 :     }
556 :    
557 :    
558 :     #-------------------------------------------------------------------------------
559 : golsen 1.1 # Tree is rooted (2 branches at root node)?
560 :     #
561 :     # $bool = newick_is_rooted( $node )
562 :     #-------------------------------------------------------------------------------
563 :     sub newick_is_rooted {
564 :     my $node = $_[0];
565 :     ! array_ref( $node ) ? undef : # Not a node ref
566 :     array_ref( $node->[0] ) ? @{ $node->[0] } == 2 : # 2 branches
567 :     0 ; # No descend list
568 :     }
569 :    
570 :    
571 :     #-------------------------------------------------------------------------------
572 :     # Tree is unrooted (> 2 branches at root node)?
573 :     #
574 :     # $bool = newick_is_unrooted( $node )
575 :     #-------------------------------------------------------------------------------
576 :     sub newick_is_unrooted {
577 :     my $node = $_[0];
578 :     ! array_ref( $node ) ? undef : # Not a node ref
579 :     array_ref( $node->[0] ) ? @{ $node->[0] } >= 3 : # Over 2 branches
580 :     0 ; # No descend list
581 :     }
582 :    
583 :    
584 :     #-------------------------------------------------------------------------------
585 :     # Tree is rooted on a tip (1 branch at root node)?
586 :     #
587 :     # $bool = newick_is_tip_rooted( $node )
588 :     #-------------------------------------------------------------------------------
589 :     sub newick_is_tip_rooted {
590 :     my $node = $_[0];
591 :     ! array_ref( $node ) ? undef : # Not a node ref
592 :     array_ref( $node->[0] ) ? @{ $node->[0] } == 1 : # 1 branch
593 :     0 ; # No descend list
594 :     }
595 :    
596 :     #===============================================================================
597 :     # Everything below this point refers to parts of the tree structure using
598 :     # only the routines above.
599 :     #===============================================================================
600 :     # Tree is bifurcating? If so, return number of descendents of root node.
601 :     #
602 :     # $n_desc = newick_is_bifurcating( $node )
603 :     #-------------------------------------------------------------------------------
604 :     sub newick_is_bifurcating {
605 :     my ( $node, $not_root ) = @_;
606 :     if ( ! array_ref( $node ) ) { return undef } # Bad arg
607 :    
608 :     my $n = newick_n_desc( $node );
609 :     $n == 0 && ! $not_root ? 0 :
610 :     $n == 1 && $not_root ? 0 :
611 :     $n == 3 && $not_root ? 0 :
612 :     $n > 3 ? 0 :
613 :     $n > 2 && ! newick_is_bifurcating( newick_desc_i( $node, 3, 1 ) ) ? 0 :
614 :     $n > 1 && ! newick_is_bifurcating( newick_desc_i( $node, 2, 1 ) ) ? 0 :
615 :     $n > 0 && ! newick_is_bifurcating( newick_desc_i( $node, 1, 1 ) ) ? 0 :
616 :     $n
617 :     }
618 :    
619 :    
620 :     #-------------------------------------------------------------------------------
621 :     # Number of tips:
622 :     #
623 :     # $n = newick_tip_count( $node )
624 :     #-------------------------------------------------------------------------------
625 :     sub newick_tip_count {
626 :     my ( $node, $not_root ) = @_;
627 :    
628 :     my $imax = newick_n_desc( $node );
629 :     if ( $imax < 1 ) { return 1 }
630 :    
631 :     # Special case for tree rooted on tip
632 :    
633 :     my $n = ( $imax == 1 && ( ! $not_root ) ) ? 1 : 0;
634 :    
635 :     foreach ( newick_desc_list( $node ) ) { $n += newick_tip_count( $_, 1 ) }
636 :    
637 :     $n;
638 :     }
639 :    
640 :    
641 :     #-------------------------------------------------------------------------------
642 :     # List of tip nodes:
643 :     #
644 :     # @tips = newick_tip_ref_list( $node )
645 :     #-------------------------------------------------------------------------------
646 :     sub newick_tip_ref_list {
647 :     my ( $node, $not_root ) = @_;
648 :    
649 :     my $imax = newick_n_desc( $node );
650 :     if ( $imax < 1 ) { return $node }
651 :    
652 :     my @list = ();
653 :    
654 :     # Tree rooted on tip?
655 :     if ( $imax == 1 && ! $not_root && newick_lbl( $node ) ) { push @list, $node }
656 :    
657 :     foreach ( newick_desc_list( $node ) ) {
658 :     push @list, newick_tip_ref_list( $_, 1 );
659 :     }
660 :    
661 :     @list;
662 :     }
663 :    
664 :    
665 :     #-------------------------------------------------------------------------------
666 :     # List of tips:
667 :     #
668 :     # @tips = newick_tip_list( $node )
669 :     #-------------------------------------------------------------------------------
670 :     sub newick_tip_list {
671 :     map { newick_lbl( $_ ) } newick_tip_ref_list( $_[0] );
672 :     }
673 :    
674 :    
675 :     #-------------------------------------------------------------------------------
676 :     # First tip node in tree:
677 :     #
678 :     # $tipref = newick_first_tip_ref( $node )
679 :     #-------------------------------------------------------------------------------
680 :     sub newick_first_tip_ref {
681 :     my ( $node, $not_root ) = @_;
682 :     valid_node( $node ) || return undef;
683 :    
684 :     # Arrived at tip, or start of a tip-rooted tree?
685 :     my $n = newick_n_desc( $node );
686 :     if ( ( $n < 1 ) || ( $n == 1 && ! $not_root ) ) { return $node }
687 :    
688 :     newick_first_tip_ref( newick_desc_i( $node, 1 ), 1 );
689 :     }
690 :    
691 :    
692 :     #-------------------------------------------------------------------------------
693 :     # First tip name in tree:
694 :     #
695 :     # $tip = newick_first_tip( $node )
696 :     #-------------------------------------------------------------------------------
697 :     sub newick_first_tip {
698 :     my ( $noderef ) = @_;
699 :    
700 :     my $tipref;
701 :     array_ref( $tipref = newick_first_tip_ref( $noderef ) ) ? newick_lbl( $tipref )
702 :     : undef;
703 :     }
704 :    
705 :    
706 :     #-------------------------------------------------------------------------------
707 :     # List of duplicated tip labels.
708 :     #
709 :     # @tips = newick_duplicated_tips( $node )
710 :     #-------------------------------------------------------------------------------
711 :     sub newick_duplicated_tips {
712 : overbeek 1.7 gjolists::duplicates( newick_tip_list( $_[0] ) );
713 : golsen 1.1 }
714 :    
715 :    
716 :     #-------------------------------------------------------------------------------
717 :     # Tip in tree?
718 :     #
719 :     # $bool = newick_tip_in_tree( $node, $tipname )
720 :     #-------------------------------------------------------------------------------
721 :     sub newick_tip_in_tree {
722 :     my ( $node, $tip, $not_root ) = @_;
723 :    
724 :     my $n = newick_n_desc( $node );
725 :     if ( $n < 1 ) { return ( newick_lbl( $node ) eq $tip) ? 1 : 0 }
726 :    
727 :     # Special case for tree rooted on tip
728 :    
729 :     if ( $n == 1 && ( ! $not_root ) && newick_lbl( $node ) eq $tip ) { return 1 }
730 :    
731 :     foreach ( newick_desc_list( $node ) ) {
732 :     if ( newick_tip_in_tree( $_, $tip, 1 ) ) { return 1 }
733 :     }
734 :    
735 :     0; # Fall through means not found
736 :     }
737 :    
738 :    
739 :     #-------------------------------------------------------------------------------
740 :     # Tips shared between 2 trees.
741 :     #
742 :     # @tips = newick_shared_tips( $tree1, $tree2 )
743 :     #-------------------------------------------------------------------------------
744 :     sub newick_shared_tips {
745 :     my ( $Tree1, $Tree2 ) = @_;
746 :     my ( @Tips1 ) = newick_tip_list( $Tree1 );
747 :     my ( @Tips2 ) = newick_tip_list( $Tree2 );
748 : overbeek 1.7 gjolists::intersection( \@Tips1, \@Tips2 );
749 : golsen 1.1 }
750 :    
751 :    
752 :     #-------------------------------------------------------------------------------
753 :     # Tree length.
754 :     #
755 :     # $length = newick_tree_length( $node )
756 :     #-------------------------------------------------------------------------------
757 :     sub newick_tree_length {
758 :     my ( $node, $not_root ) = @_;
759 :    
760 :     my $x = $not_root ? newick_x( $node ) : 0;
761 :     defined( $x ) || ( $x = 1 ); # Convert undefined to 1
762 :    
763 :     foreach ( newick_desc_list( $node ) ) { $x += newick_tree_length( $_, 1 ) }
764 :    
765 :     $x;
766 :     }
767 :    
768 :    
769 :     #-------------------------------------------------------------------------------
770 :     # Tree max X.
771 :     #
772 :     # $xmax = newick_max_X( $node )
773 :     #-------------------------------------------------------------------------------
774 :     sub newick_max_X {
775 :     my ( $node, $not_root ) = @_;
776 :    
777 :     my $xmax = 0;
778 :     foreach ( newick_desc_list( $node ) ) {
779 :     my $x = newick_max_X( $_, 1 );
780 :     if ( $x > $xmax ) { $xmax = $x }
781 :     }
782 :    
783 :     my $x = $not_root ? newick_x( $node ) : 0;
784 :     $xmax + ( defined( $x ) ? $x : 1 ); # Convert undefined to 1
785 :     }
786 :    
787 :    
788 :     #-------------------------------------------------------------------------------
789 :     # Most distant tip from root: distance and path.
790 :     #
791 :     # ( $xmax, @path ) = newick_most_distant_tip_path( $tree )
792 :     #-------------------------------------------------------------------------------
793 :     sub newick_most_distant_tip_path {
794 :     my ( $node, $not_root ) = @_;
795 :    
796 :     my $imax = newick_n_desc( $node );
797 :     my $xmax = ( $imax > 0 ) ? -1 : 0;
798 :     my @pmax = ();
799 :     for ( my $i = 1; $i <= $imax; $i++ ) {
800 :     my ( $x, @path ) = newick_most_distant_tip_path( newick_desc_i( $node, $i ), 1 );
801 :     if ( $x > $xmax ) { $xmax = $x; @pmax = ( $i, @path ) }
802 :     }
803 :    
804 :     my $x = $not_root ? newick_x( $node ) : 0;
805 :     $xmax += defined( $x ) ? $x : 0; # Convert undefined to 1
806 :     ( $xmax, $node, @pmax );
807 :     }
808 :    
809 :    
810 :     #-------------------------------------------------------------------------------
811 :     # Most distant tip from root, and its distance.
812 :     #
813 :     # ( $tipref, $xmax ) = newick_most_distant_tip_ref( $tree )
814 :     #-------------------------------------------------------------------------------
815 :     sub newick_most_distant_tip_ref {
816 :     my ( $node, $not_root ) = @_;
817 :    
818 :     my $imax = newick_n_desc( $node );
819 :     my $xmax = ( $imax > 0 ) ? -1 : 0;
820 :     my $tmax = $node;
821 :     foreach ( newick_desc_list( $node ) ) {
822 :     my ( $t, $x ) = newick_most_distant_tip_ref( $_, 1 );
823 :     if ( $x > $xmax ) { $xmax = $x; $tmax = $t }
824 :     }
825 :    
826 :     my $x = $not_root ? newick_x( $node ) : 0;
827 :     $xmax += defined( $x ) ? $x : 1; # Convert undefined to 1
828 :     ( $tmax, $xmax );
829 :     }
830 :    
831 :    
832 :     #-------------------------------------------------------------------------------
833 :     # Name of most distant tip from root, and its distance.
834 :     #
835 :     # ( $tipname, $xmax ) = newick_most_distant_tip_name( $tree )
836 :     #-------------------------------------------------------------------------------
837 :     sub newick_most_distant_tip_name {
838 :     my ( $tipref, $xmax ) = newick_most_distant_tip_ref( $_[0] );
839 :     ( newick_lbl( $tipref ), $xmax )
840 :     }
841 :    
842 :    
843 :     #-------------------------------------------------------------------------------
844 : golsen 1.8 # Tree tip insertion point (with standard node labels):
845 :     #
846 :     # [ $node1, $x1, $node2, $x2, $x ]
847 :     # = newick_tip_insertion_point( $tree, $tip )
848 :     #
849 :     # Which means: tip is on a branch of length x that is inserted into the branch
850 :     # connecting node1 and node2, at distance x1 from node1 and x2 from node2.
851 :     #
852 :     # x1 +------ n1a (lowest sorting tip of this subtree)
853 :     # +--------n1
854 :     # | +------n1b (lowest sorting tip of this subtree)
855 :     # tip-------n
856 :     # x | +------------- n2a (lowest sorting tip of this subtree)
857 :     # +------n2
858 :     # x2 +-------- n2b (lowest sorting tip of this subtree)
859 :     #
860 :     # The designations of 1 vs 2, and a vs b are chosen such that:
861 :     # n1a < n1b, and n2a < n2b, and n1a < n2a
862 :     #
863 :     # Then the statandard description becomes:
864 :     #
865 :     # [ [ $n1a, min(n1b,n2a), max(n1b,n2a) ], x1,
866 :     # [ $n2a, min(n2b,n1a), max(n2b,n1a) ], x2,
867 :     # x
868 :     # ]
869 :     #
870 :     #-------------------------------------------------------------------------------
871 :     sub newick_tip_insertion_point
872 :     {
873 :     my ( $tree, $tip ) = @_;
874 :     $tree && $tip && ref( $tree ) eq 'ARRAY' or return undef;
875 :     $tree = copy_newick_tree( $tree ) or return undef;
876 :     $tree = reroot_newick_to_tip( $tree, $tip ) or return undef;
877 :     my $node = $tree;
878 :    
879 :     my $x = 0; # Distance to node
880 :     my $dl = newick_desc_ref( $node ); # Descendent list of tip node;
881 :     $node = $dl->[0]; # Node adjacent to tip
882 :     $dl = newick_desc_ref( $node );
883 :     while ( $dl && ( @$dl == 1 ) ) # Traverse unbranched nodes
884 :     {
885 :     $node = $dl->[0];
886 :     $x += newick_x( $node );
887 :     $dl = newick_desc_ref( $node );
888 :     }
889 :     $x += newick_x( $node );
890 :    
891 :     # We are now at the node that is the insertion point.
892 :     # Is it a tip?
893 :    
894 :     my @description;
895 :    
896 :     if ( ( ! $dl ) || @$dl == 0 )
897 :     {
898 :     @description = ( [ newick_lbl( $node ) ], 0, undef, 0, $x );
899 :     }
900 :    
901 :     # Is it a trifurcation or greater, in which case it does not go
902 :     # away with tip deletion?
903 :    
904 :     elsif ( @$dl > 2 )
905 :     {
906 :     @description = ( [ std_node_name( $node, $node ) ], 0, undef, 0, $x );
907 :     }
908 :    
909 :     # The node is bifurcating. We need to describe it.
910 :    
911 :     else
912 :     {
913 :     my ( $n1, $x1 ) = describe_desc( $dl->[0] );
914 :     my ( $n2, $x2 ) = describe_desc( $dl->[1] );
915 :    
916 :     if ( @$n1 == 2 ) { push @$n1, $n2->[0] }
917 :     if ( @$n2 == 2 )
918 :     {
919 :     @$n2 = sort { lc $a cmp lc $b } ( @$n2, $n1->[0] );
920 :     }
921 :     if ( @$n1 == 3 ) { @$n2 = sort { lc $a cmp lc $b } @$n2 }
922 :     @description = ( $n1, $x1, $n2, $x2, $x );
923 :     }
924 :    
925 :     return wantarray ? @description : \@description;
926 :     }
927 :    
928 :    
929 :     sub describe_desc
930 :     {
931 :     my $node = shift;
932 :    
933 :     my $x = 0; # Distance to node
934 :     my $dl = newick_desc_ref( $node ); # Descendent list of tip node;
935 :     while ( $dl && ( @$dl == 1 ) ) # Traverse unbranched nodes
936 :     {
937 :     $node = $dl->[0];
938 :     $x += newick_x( $node );
939 :     $dl = newick_desc_ref( $node );
940 :     }
941 :     $x += newick_x( $node );
942 :    
943 :     # Is it a tip? Return list of one tip;
944 :    
945 :     if ( ( ! $dl ) || @$dl == 0 )
946 :     {
947 :     return ( [ newick_lbl( $node ) ], $x );
948 :     }
949 :    
950 :     # Get tips of each descendent, keeping lowest sorting from each.
951 :     # Return the two lowest of those (the third will come from the
952 :     # other side of the original node).
953 :    
954 :     else
955 :     {
956 :     my @rep_tips = sort { lc $a cmp lc $b }
957 :     map { ( sort { lc $a cmp lc $b } newick_tip_list( $_ ) )[0] }
958 :     @$dl;
959 :     return ( [ @rep_tips[0,1] ], $x );
960 :     }
961 :     }
962 :    
963 :    
964 :     #-------------------------------------------------------------------------------
965 : golsen 1.1 # Standard node name:
966 :     # Tip label if at a tip
967 :     # Three sorted tip labels intersecting at node, each being smallest
968 :     # of all the tips of their subtrees
969 :     #
970 :     # @TipOrTips = std_node_name( $Tree, $Node )
971 :     #-------------------------------------------------------------------------------
972 :     sub std_node_name {
973 :     my $tree = $_[0];
974 :    
975 :     # Node reference is last element of path to node
976 :    
977 :     my $noderef = ( path_to_node( @_ ) )[-1];
978 :     defined( $noderef ) || return ();
979 :    
980 :     if ( node_is_tip( $noderef ) || $noderef eq $tree ) { # Is it a tip?
981 :     return newick_lbl( $noderef );
982 :     }
983 :    
984 :     # Work through lists of tips in descendant subtrees, removing them from
985 :     # @rest, and keeping the best tip for each subtree.
986 :    
987 : golsen 1.8 my @rest = newick_tip_list( $tree );
988 : golsen 1.1 my @best = map {
989 : golsen 1.8 my @tips = sort { lc $a cmp lc $b } newick_tip_list( $_ );
990 : overbeek 1.7 @rest = gjolists::set_difference( \@rest, \@tips );
991 : golsen 1.1 $tips[0];
992 :     } newick_desc_list( $noderef );
993 :    
994 :     # Best of the rest of the tree
995 :     push @best, ( sort { lc $a cmp lc $b } @rest )[0];
996 :    
997 :     # Take the top 3, in order:
998 :    
999 :     ( @best >= 3 ) ? ( sort { lc $a cmp lc $b } @best )[0 .. 2] : ();
1000 :     }
1001 :    
1002 :    
1003 :     #===============================================================================
1004 :     # Functions to find paths in trees.
1005 :     #
1006 :     # Path descriptions are of form:
1007 :     # ( $node0, $i0, $node1, $i1, $node2, $i2, ..., $nodeN ) # Always odd
1008 :     # () is returned upon failure
1009 :     #
1010 :     # Numbering of descendants is 1-based.
1011 :     #===============================================================================
1012 :     # Path to tip:
1013 :     #
1014 :     # @path = path_to_tip( $treenode, $tipname )
1015 :     #-------------------------------------------------------------------------------
1016 :     sub path_to_tip {
1017 :     my ( $node, $tip, @path0 ) = @_;
1018 :    
1019 :     push @path0, $node;
1020 :     my $imax = newick_n_desc( $node );
1021 :     if ( $imax < 1 ) { return ( newick_lbl( $node ) eq $tip ) ? @path0 : () }
1022 :    
1023 :     # Special case for tree rooted on tip
1024 :    
1025 :     if ( ( $imax == 1 ) # One descendant
1026 :     && ( @path0 == 1 ) # First step in path
1027 :     && ( newick_lbl( $node ) eq $tip ) # Label matches
1028 :     ) { return @path0 }
1029 :    
1030 :     my @path;
1031 :     for (my $i = 1; $i <= $imax; $i++ ) {
1032 :     @path = path_to_tip( newick_desc_i( $node, $i ), $tip, ( @path0, $i ) );
1033 :     if ( @path ) { return @path }
1034 :     }
1035 :    
1036 :     (); # Not found
1037 :     }
1038 :    
1039 :    
1040 :     #-------------------------------------------------------------------------------
1041 :     # Path to named node.
1042 :     # Like path to tip, but will find named internal nodes as well.
1043 :     #
1044 :     # @path = path_to_named_node( $treenode, $name )
1045 :     #-------------------------------------------------------------------------------
1046 :     sub path_to_named_node {
1047 :     my ( $node, $name, @path0 ) = @_;
1048 :    
1049 :     push @path0, $node;
1050 :     if ( newick_lbl( $node ) eq $name ) { return @path0 }
1051 :    
1052 :     my @path;
1053 :     my $imax = newick_n_desc( $node );
1054 :     for ( my $i = 1; $i <= $imax; $i++ ) {
1055 :     @path = path_to_named_node( newick_desc_i( $node, $i ), $name, ( @path0, $i ) );
1056 :     if ( @path ) { return @path }
1057 :     }
1058 :    
1059 :     (); # Not found
1060 :     }
1061 :    
1062 :    
1063 :     #-------------------------------------------------------------------------------
1064 :     # Path to node reference.
1065 :     #
1066 :     # @path = path_to_node_ref( $treenode, $noderef )
1067 :     #-------------------------------------------------------------------------------
1068 :     sub path_to_node_ref {
1069 :     my ( $node, $noderef, @path0 ) = @_;
1070 :    
1071 :     push @path0, $node;
1072 :     if ( $node eq $noderef ) { return @path0 }
1073 :    
1074 :     my @path;
1075 :     my $imax = newick_n_desc( $node );
1076 :     for ( my $i = 1; $i <= $imax; $i++ ) {
1077 :     @path = path_to_node_ref( newick_desc_i( $node, $i ), $noderef, ( @path0, $i ) );
1078 :     if ( @path ) { return @path }
1079 :     }
1080 :    
1081 :     (); # Not found
1082 :     }
1083 :    
1084 :    
1085 :     #-------------------------------------------------------------------------------
1086 :     # Path to node, as defined by 1 or 3 tips.
1087 :     #
1088 :     # @path = path_to_node( $node, $tip1, $tip2, $tip3 ) # 3 tip names
1089 :     # @path = path_to_node( $node, [ $tip1, $tip2, $tip3 ] ) # Allow array ref
1090 :     # @path = path_to_node( $node, $tip1 ) # Use path_to_tip
1091 :     # @path = path_to_node( $node, [ $tip1 ] ) # Use path_to_tip
1092 :     #-------------------------------------------------------------------------------
1093 :     sub path_to_node {
1094 :     my ( $node, $tip1, $tip2, $tip3 ) = @_;
1095 :     array_ref( $node ) && defined( $tip1 ) || return ();
1096 :    
1097 :     # Allow arg 2 to be an array reference
1098 :     if ( array_ref( $tip1 ) ) { ( $tip1, $tip2, $tip3 ) = @$tip1 }
1099 :    
1100 :     my @p1 = path_to_tip( $node, $tip1 ); # Path to first tip
1101 :     @p1 || return (); # Was the tip found?
1102 :     defined( $tip2 ) && defined( $tip3 ) || return @p1; # Two more defined?
1103 :    
1104 :     my @p2 = path_to_tip( $node, $tip2 );
1105 :     my @p3 = path_to_tip( $node, $tip3 );
1106 :     @p2 && @p3 || return (); # Were they found?
1107 :    
1108 :     # Find the common prefix for each pair of paths
1109 : overbeek 1.7 my @p12 = gjolists::common_prefix( \@p1, \@p2 );
1110 :     my @p13 = gjolists::common_prefix( \@p1, \@p3 );
1111 :     my @p23 = gjolists::common_prefix( \@p2, \@p3 );
1112 : golsen 1.1
1113 :     # Return the longest common prefix of any two paths
1114 :     ( @p12 >= @p13 && @p12 >= @p23 ) ? @p12 :
1115 :     ( @p13 >= @p23 ) ? @p13 :
1116 :     @p23 ;
1117 :     }
1118 :    
1119 :    
1120 :     #-------------------------------------------------------------------------------
1121 :     # Distance along path.
1122 :     #
1123 :     # $distance = newick_path_length( @path )
1124 :     #-------------------------------------------------------------------------------
1125 :     sub newick_path_length {
1126 :     my $node = shift; # Discard the first node
1127 :     array_ref( $node ) || return undef;
1128 :     @_ ? distance_along_path_2( @_ ) : 0;
1129 :     }
1130 :    
1131 :    
1132 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1133 :     # This expects to get path minus root node:
1134 :     #
1135 :     # $distance = distance_along_path_2( @path )
1136 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1137 :     sub distance_along_path_2 {
1138 :     shift; # Discard descendant number
1139 :     my $node = shift;
1140 :     array_ref( $node ) || return undef;
1141 :     my $d1 = newick_x( $node );
1142 : golsen 1.8 my $d2 = @_ ? distance_along_path_2( @_ ) : 0;
1143 : golsen 1.1 defined( $d1 ) && defined( $d2 ) ? $d1 + $d2 : undef;
1144 :     }
1145 :    
1146 :    
1147 :     #-------------------------------------------------------------------------------
1148 :     # Tip-to-tip distance.
1149 :     #
1150 :     # $distance = tip_to_tip_distance( $tree, $tip1, $tip2 )
1151 :     #-------------------------------------------------------------------------------
1152 :     sub tip_to_tip_distance {
1153 :     my ( $node, $tip1, $tip2 ) = @_;
1154 :    
1155 :     array_ref( $node ) && defined( $tip1 )
1156 :     && defined( $tip2 ) || return undef;
1157 :     my @p1 = path_to_tip( $node, $tip1 );
1158 :     my @p2 = path_to_tip( $node, $tip2 );
1159 :     @p1 && @p2 || return undef; # Were they found?
1160 :    
1161 :     # Find the unique suffixes of the two paths
1162 : overbeek 1.7 my ( $suf1, $suf2 ) = gjolists::unique_suffixes( \@p1, \@p2 ); # Common node is lost
1163 : golsen 1.1 my $d1 = @$suf1 ? distance_along_path_2( @$suf1 ) : 0;
1164 :     my $d2 = @$suf2 ? distance_along_path_2( @$suf2 ) : 0;
1165 :    
1166 :     defined( $d1 ) && defined( $d2 ) ? $d1 + $d2 : undef;
1167 :     }
1168 :    
1169 :    
1170 :     #-------------------------------------------------------------------------------
1171 :     # Node-to-node distance.
1172 :     # Nodes can be: $tipname
1173 :     # [ $tipname ]
1174 :     # [ $tipname1, $tipname2, $tipname3 ]
1175 :     #
1176 :     # $distance = node_to_node_distance( $tree, $node1, $node2 )
1177 :     #-------------------------------------------------------------------------------
1178 :     sub node_to_node_distance {
1179 :     my ( $node, $node1, $node2 ) = @_;
1180 :    
1181 :     array_ref( $node ) && defined( $node1 )
1182 :     && defined( $node2 ) || return undef;
1183 : golsen 1.8 my @p1 = path_to_node( $node, $node1 ) or return undef;
1184 :     my @p2 = path_to_node( $node, $node2 ) or return undef;
1185 : golsen 1.1
1186 :     # Find the unique suffixes of the two paths
1187 : overbeek 1.7 my ( $suf1, $suf2 ) = gjolists::unique_suffixes( \@p1, \@p2 ); # Common node is lost
1188 : golsen 1.1 my $d1 = @$suf1 ? distance_along_path_2( @$suf1 ) : 0;
1189 :     my $d2 = @$suf2 ? distance_along_path_2( @$suf2 ) : 0;
1190 :    
1191 :     defined( $d1 ) && defined( $d2 ) ? $d1 + $d2 : undef;
1192 :     }
1193 :    
1194 :    
1195 :     #===============================================================================
1196 :     # Tree manipulations:
1197 :     #===============================================================================
1198 :     # Copy tree.
1199 :     # Lists are copied, except that references to empty lists go to undef.
1200 :     # Only defined fields are added, so tree list may be shorter than 8 fields.
1201 :     #
1202 : overbeek 1.4 # $treecopy = copy_newick_tree( $tree )
1203 : golsen 1.1 #-------------------------------------------------------------------------------
1204 : overbeek 1.4 sub copy_newick_tree {
1205 : golsen 1.1 my ( $node ) = @_;
1206 :     array_ref( $node ) || return undef;
1207 :    
1208 :     my $nn = []; # Reference to a new node structure
1209 :     # Build a new descendant list, if not empty
1210 :     my @dl = newick_desc_list( $node );
1211 : overbeek 1.4 set_newick_desc_ref( $nn, @dl ? [ map { copy_newick_tree( $_ ) } @dl ]
1212 : golsen 1.1 : undef
1213 :     );
1214 :    
1215 :     # Copy label and x, if defined
1216 :     my ( $l, $x );
1217 :     if ( defined( $l = newick_lbl( $node ) ) ) { set_newick_lbl( $nn, $l ) }
1218 :     if ( defined( $x = newick_x( $node ) ) ) { set_newick_x( $nn, $x ) }
1219 :    
1220 :     # Build new comment lists, when not empty ( does not extend array unless
1221 :     # necessary)
1222 :     my $c;
1223 :     if ( $c = newick_c1( $node ) and @$c ) { set_newick_c1( $nn, [ @$c ] ) }
1224 :     if ( $c = newick_c2( $node ) and @$c ) { set_newick_c2( $nn, [ @$c ] ) }
1225 :     if ( $c = newick_c3( $node ) and @$c ) { set_newick_c3( $nn, [ @$c ] ) }
1226 :     if ( $c = newick_c4( $node ) and @$c ) { set_newick_c4( $nn, [ @$c ] ) }
1227 :     if ( $c = newick_c5( $node ) and @$c ) { set_newick_c5( $nn, [ @$c ] ) }
1228 :    
1229 :     $nn;
1230 :     }
1231 :    
1232 :    
1233 :     #-------------------------------------------------------------------------------
1234 :     # Use a hash to relabel the nodes in a newick tree.
1235 :     #
1236 :     # $newtree = newick_relabel_nodes( $node, \%new_name )
1237 :     #-------------------------------------------------------------------------------
1238 :     sub newick_relabel_nodes {
1239 :     my ( $node, $new_name ) = @_;
1240 :    
1241 :     my ( $lbl, $new );
1242 :     if ( defined( $lbl = newick_lbl( $node ) )
1243 :     && ( $lbl ne "" )
1244 :     && defined( $new = $new_name->{ $lbl } )
1245 :     ) {
1246 :     set_newick_lbl( $node, $new );
1247 :     }
1248 :    
1249 :     foreach ( newick_desc_list( $node ) ) {
1250 :     newick_relabel_nodes( $_, $new_name );
1251 :     }
1252 :    
1253 :     $node;
1254 :     }
1255 :    
1256 :    
1257 :     #-------------------------------------------------------------------------------
1258 :     # Use a hash to relabel the nodes in a newick tree (case insensitive).
1259 :     #
1260 :     # $newtree = newick_relabel_nodes_i( $node, \%new_name )
1261 :     #-------------------------------------------------------------------------------
1262 :     sub newick_relabel_nodes_i {
1263 :     my ( $node, $new_name ) = @_;
1264 :    
1265 :     # Add any necessary lowercase keys to the hash:
1266 :    
1267 :     my $lc_lbl;
1268 :     foreach ( keys %$new_name ) {
1269 :     $lc_lbl = lc $_;
1270 :     ( $lc_lbl eq $_ ) or ( $new_name->{ $lc_lbl } = $new_name->{ $_ } );
1271 :     }
1272 :    
1273 :     newick_relabel_nodes_i2( $node, $new_name );
1274 :     }
1275 :    
1276 :    
1277 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1278 :     # Do the actual relabeling
1279 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1280 :     sub newick_relabel_nodes_i2 {
1281 :     my ( $node, $new_name ) = @_;
1282 :    
1283 :     my ( $lbl, $new );
1284 :     if ( defined( $lbl = newick_lbl( $node ) )
1285 :     && ( $lbl ne "" )
1286 :     && defined( $new = $new_name->{ lc $lbl } )
1287 :     ) {
1288 :     set_newick_lbl( $node, $new );
1289 :     }
1290 :    
1291 :     foreach ( newick_desc_list( $node ) ) {
1292 :     newick_relabel_nodes_i2( $_, $new_name );
1293 :     }
1294 :    
1295 :     $node;
1296 :     }
1297 :    
1298 :    
1299 :     #-------------------------------------------------------------------------------
1300 :     # Use a hash to relabel the tips in a newick tree.
1301 :     #
1302 :     # $newtree = newick_relabel_tips( $node, \%new_name )
1303 :     #-------------------------------------------------------------------------------
1304 :     sub newick_relabel_tips {
1305 :     my ( $node, $new_name ) = @_;
1306 :    
1307 :     my @desc = newick_desc_list( $node );
1308 :    
1309 :     if ( @desc ) {
1310 :     foreach ( @desc ) { newick_relabel_tips( $_, $new_name ) }
1311 :     }
1312 :     else {
1313 :     my ( $lbl, $new );
1314 :     if ( defined( $lbl = newick_lbl( $node ) )
1315 :     && ( $lbl ne "" )
1316 :     && defined( $new = $new_name->{ $lbl } )
1317 :     ) {
1318 :     set_newick_lbl( $node, $new );
1319 :     }
1320 :     }
1321 :    
1322 :     $node;
1323 :     }
1324 :    
1325 :    
1326 :     #-------------------------------------------------------------------------------
1327 :     # Use a hash to relabel the tips in a newick tree (case insensitive).
1328 :     #
1329 :     # $newtree = newick_relabel_tips_i( $node, \%new_name )
1330 :     #-------------------------------------------------------------------------------
1331 :     sub newick_relabel_tips_i {
1332 :     my ( $node, $new_name ) = @_;
1333 :    
1334 :     # Add any necessary lowercase keys to the hash:
1335 :    
1336 :     my $lc_lbl;
1337 :     foreach ( keys %$new_name ) {
1338 :     $lc_lbl = lc $_;
1339 :     ( $lc_lbl eq $_ ) or ( $new_name->{ $lc_lbl } = $new_name->{ $_ } );
1340 :     }
1341 :    
1342 :     newick_relabel_tips_i2( $node, $new_name );
1343 :     }
1344 :    
1345 :    
1346 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1347 :     # Do the actual relabeling
1348 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1349 :     sub newick_relabel_tips_i2 {
1350 :     my ( $node, $new_name ) = @_;
1351 :    
1352 :     my @desc = newick_desc_list( $node );
1353 :    
1354 :     if ( @desc ) {
1355 :     foreach ( @desc ) { newick_relabel_tips_i2( $_, $new_name ) }
1356 :     }
1357 :     else {
1358 :     my ( $lbl, $new );
1359 :     if ( defined( $lbl = newick_lbl( $node ) )
1360 :     && ( $lbl ne "" )
1361 :     && defined( $new = $new_name->{ lc $lbl } )
1362 :     ) {
1363 :     set_newick_lbl( $node, $new );
1364 :     }
1365 :     }
1366 :    
1367 :     $node;
1368 :     }
1369 :    
1370 :    
1371 :     #-------------------------------------------------------------------------------
1372 :     # Set undefined branch lenghts (except root) to length x.
1373 :     #
1374 :     # $n_changed = newick_set_undefined_branches( $node, $x )
1375 :     #-------------------------------------------------------------------------------
1376 :     sub newick_set_undefined_branches {
1377 :     my ( $node, $x, $not_root ) = @_;
1378 :    
1379 :     my $n = 0;
1380 :     if ( $not_root && ! defined( newick_x( $node ) ) ) {
1381 :     set_newick_x( $node, $x );
1382 :     $n++;
1383 :     }
1384 :    
1385 :     foreach ( newick_desc_list( $node ) ) {
1386 :     $n += newick_set_undefined_branches( $_, $x, 1 );
1387 :     }
1388 :    
1389 :     $n;
1390 :     }
1391 :    
1392 :    
1393 :     #-------------------------------------------------------------------------------
1394 :     # Set all branch lenghts (except root) to length x.
1395 :     #
1396 :     # $n_changed = newick_set_all_branches( $node, $x )
1397 :     #-------------------------------------------------------------------------------
1398 :     sub newick_set_all_branches {
1399 :     my ( $node, $x, $not_root ) = @_;
1400 :    
1401 :     my $n = 0;
1402 : overbeek 1.7 if ( $not_root )
1403 :     {
1404 : golsen 1.1 set_newick_x( $node, $x );
1405 :     $n++;
1406 :     }
1407 :    
1408 : overbeek 1.7 foreach ( newick_desc_list( $node ) )
1409 :     {
1410 : golsen 1.1 $n += newick_set_all_branches( $_, $x, 1 );
1411 :     }
1412 :    
1413 :     $n;
1414 :     }
1415 :    
1416 :    
1417 :     #-------------------------------------------------------------------------------
1418 : overbeek 1.7 # Rescale all branch lenghts by factor.
1419 :     #
1420 :     # $node = newick_rescale_branches( $node, $factor )
1421 :     #-------------------------------------------------------------------------------
1422 :     sub newick_rescale_branches {
1423 :     my ( $node, $factor ) = @_;
1424 :    
1425 :     my $x = newick_x( $node );
1426 :     set_newick_x( $node, $factor * $x ) if $x;
1427 :    
1428 :     foreach ( newick_desc_list( $node ) )
1429 :     {
1430 :     newick_rescale_branches( $_, $factor );
1431 :     }
1432 :    
1433 :     $node;
1434 :     }
1435 :    
1436 :    
1437 :     #-------------------------------------------------------------------------------
1438 : golsen 1.5 # Set negative branches to zero. The original tree is modfied.
1439 :     #
1440 :     # $n_changed = newick_fix_negative_branches( $tree )
1441 :     #-------------------------------------------------------------------------------
1442 :     sub newick_fix_negative_branches {
1443 :     my ( $tree ) = @_;
1444 :     array_ref( $tree ) or return undef;
1445 :     my $n_changed = 0;
1446 :     my $x = newick_x( $tree );
1447 :     if ( defined( $x ) and $x < 0 )
1448 :     {
1449 :     set_newick_x( $tree, 0 );
1450 :     $n_changed++;
1451 :     }
1452 :    
1453 :     foreach ( newick_desc_list( $tree ) )
1454 :     {
1455 :     $n_changed += newick_fix_negative_branches( $_ );
1456 :     }
1457 :    
1458 :     $n_changed;
1459 :     }
1460 :    
1461 :    
1462 :     #-------------------------------------------------------------------------------
1463 : golsen 1.8 # Remove comments from a newick tree (e.g., before writing for phylip).
1464 :     #
1465 :     # $node = newick_strip_comments( $node )
1466 :     #-------------------------------------------------------------------------------
1467 :     sub newick_strip_comments {
1468 :     my ( $node ) = @_;
1469 :    
1470 :     @$node = @$node[ 0 .. 2 ];
1471 :     foreach ( newick_desc_list( $node ) ) { newick_strip_comments( $_ ) }
1472 :     $node;
1473 :     }
1474 :    
1475 :    
1476 :     #-------------------------------------------------------------------------------
1477 : golsen 1.1 # Normalize tree order (in place).
1478 :     #
1479 :     # ( $tree, $label1 ) = normalize_newick_tree( $tree )
1480 :     #-------------------------------------------------------------------------------
1481 :     sub normalize_newick_tree {
1482 :     my ( $node ) = @_;
1483 :    
1484 :     my @descends = newick_desc_list( $node );
1485 :     if ( @descends == 0 ) { return ( $node, lc newick_lbl( $node ) ) }
1486 :    
1487 :     my %hash = map { (normalize_newick_tree( $_ ))[1] => $_ } @descends;
1488 :     my @keylist = sort { $a cmp $b } keys %hash;
1489 :     set_newick_desc_list( $node, map { $hash{$_} } @keylist );
1490 :    
1491 :     ( $node, $keylist[0] );
1492 :     }
1493 :    
1494 :    
1495 :     #-------------------------------------------------------------------------------
1496 :     # Reverse tree order (in place).
1497 :     #
1498 :     # $tree = reverse_newick_tree( $tree )
1499 :     #-------------------------------------------------------------------------------
1500 :     sub reverse_newick_tree {
1501 :     my ( $node ) = @_;
1502 :    
1503 :     my @descends = newick_desc_list( $node );
1504 :     if ( @descends ) {
1505 :     set_newick_desc_list( $node, reverse @descends );
1506 :     foreach ( @descends ) { reverse_newick_tree( $_ ) }
1507 :     }
1508 :     $node;
1509 :     }
1510 :    
1511 :    
1512 :     #-------------------------------------------------------------------------------
1513 :     # Standard unrooted tree (in place).
1514 :     #
1515 :     # $stdtree = std_unrooted_newick( $tree )
1516 :     #-------------------------------------------------------------------------------
1517 :     sub std_unrooted_newick {
1518 :     my ( $tree ) = @_;
1519 :    
1520 :     my ( $mintip ) = sort { lc $a cmp lc $b } newick_tip_list( $tree );
1521 :     ( normalize_newick_tree( reroot_newick_next_to_tip( $tree, $mintip ) ) )[0];
1522 :     }
1523 :    
1524 :    
1525 :     #-------------------------------------------------------------------------------
1526 :     # Move largest groups to periphery of tree (in place).
1527 :     #
1528 :     # dir <= -2 for up-sweeping tree (big groups always first),
1529 :     # = -1 for big group first, balanced tree,
1530 :     # = 0 for balanced tree,
1531 :     # = 1 for small group first, balanced tree, and
1532 :     # >= 2 for down-sweeping tree (small groups always top)
1533 :     #
1534 :     # $tree = aesthetic_newick_tree( $treeref, $dir )
1535 :     #-------------------------------------------------------------------------------
1536 :     sub aesthetic_newick_tree {
1537 :     my ( $tree, $dir ) = @_;
1538 :     my %cnt;
1539 :    
1540 :     $dir = ! $dir ? 0 : # Undefined or zero
1541 :     $dir <= -2 ? -1000000 :
1542 :     $dir < 0 ? -1 :
1543 :     $dir >= 2 ? 1000000 :
1544 :     1 ;
1545 :     build_tip_count_hash( $tree, \%cnt );
1546 :     reorder_by_tip_count( $tree, \%cnt, $dir );
1547 :     }
1548 :    
1549 :    
1550 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1551 :     # Build a hash to look up the number of descendants of each node.
1552 :     # Access count with $cntref->{$noderef}
1553 :     #
1554 :     # $count = build_tip_count_hash( $node, $cnt_hash_ref )
1555 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1556 :     sub build_tip_count_hash {
1557 :     my ( $node, $cntref ) = @_;
1558 :     my ( $i, $cnt );
1559 :    
1560 :     if ( newick_n_desc( $node ) < 1 ) { $cnt = 1 }
1561 :     else {
1562 :     $cnt = 0;
1563 :     foreach ( newick_desc_list( $node ) ) {
1564 :     $cnt += build_tip_count_hash( $_, $cntref );
1565 :     }
1566 :     }
1567 :    
1568 :     $cntref->{$node} = $cnt;
1569 :     $cnt;
1570 :     }
1571 :    
1572 :    
1573 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1574 :     # $node = reorder_by_tip_count( $node, $cntref, $dir )
1575 :     # dir < 0 for upward branch (big group first),
1576 :     # = 0 for no change, and
1577 :     # > 0 for downward branch (small group first).
1578 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1579 :     sub reorder_by_tip_count {
1580 :     my ( $node, $cntref, $dir ) = @_;
1581 :    
1582 :     my $nd = newick_n_desc( $node );
1583 :     if ( $nd < 1 ) { return $node } # Do nothing to a tip
1584 :    
1585 :     # Reorder this subtree:
1586 :    
1587 :     my $dl_ref = newick_desc_ref( $node );
1588 :     if ( $dir < 0 ) { # Big group first
1589 :     @$dl_ref = sort { $cntref->{$b} <=> $cntref->{$a} } @$dl_ref;
1590 :     }
1591 :     elsif ( $dir > 0 ) { # Small group first
1592 :     @$dl_ref = sort { $cntref->{$a} <=> $cntref->{$b} } @$dl_ref;
1593 :     }
1594 :    
1595 :     # Reorder within descendant subtrees:
1596 :    
1597 :     my $step = 0;
1598 :     if ( abs( $dir ) < 1e5 ) {
1599 :     $dir = 1 - $nd; # Midgroup => as is
1600 :     # $dir = 1 - $nd + ( $dir < 0 ? -0.5 : 0.5 ); # Midgroup => outward
1601 :     $step = 2;
1602 :     }
1603 :    
1604 :     for ( my $i = 0; $i < $nd; $i++ ) {
1605 :     reorder_by_tip_count( $dl_ref->[$i], $cntref, $dir );
1606 :     $dir += $step;
1607 :     }
1608 :    
1609 :     $node;
1610 :     }
1611 :    
1612 :    
1613 :     #-------------------------------------------------------------------------------
1614 :     # Move smallest groups to periphery of tree (in place).
1615 :     #
1616 :     # dir <= -2 for up-sweeping tree (big groups always first),
1617 :     # = -1 for big group first, balanced tree,
1618 :     # = 0 for balanced tree,
1619 :     # = 1 for small group first, balanced tree, and
1620 :     # >= 2 for down-sweeping tree (small groups always top)
1621 :     #
1622 :     # $tree = unaesthetic_newick_tree( $treeref, $dir )
1623 :     #-------------------------------------------------------------------------------
1624 :     sub unaesthetic_newick_tree {
1625 :     my ( $tree, $dir ) = @_;
1626 :     my %cnt;
1627 :    
1628 :     $dir = ! $dir ? 0 : # Undefined or zero
1629 :     $dir <= -2 ? -1000000 :
1630 :     $dir < 0 ? -1 :
1631 :     $dir >= 2 ? 1000000 :
1632 :     1 ;
1633 :     build_tip_count_hash( $tree, \%cnt );
1634 :     reorder_against_tip_count( $tree, \%cnt, $dir );
1635 :     }
1636 :    
1637 :    
1638 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1639 :     # $node = reorder_by_tip_count( $node, $cntref, $dir )
1640 :     # dir < 0 for upward branch (big group first),
1641 :     # = 0 for no change, and
1642 :     # > 0 for downward branch (small group first).
1643 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1644 :     sub reorder_against_tip_count {
1645 :     my ( $node, $cntref, $dir ) = @_;
1646 :    
1647 :     my $nd = newick_n_desc( $node );
1648 :     if ( $nd < 1 ) { return $node } # Do nothing to a tip
1649 :    
1650 :     # Reorder this subtree:
1651 :    
1652 :     my $dl_ref = newick_desc_ref( $node );
1653 :     if ( $dir > 0 ) { # Big group first
1654 :     @$dl_ref = sort { $cntref->{$b} <=> $cntref->{$a} } @$dl_ref;
1655 :     }
1656 :     elsif ( $dir < 0 ) { # Small group first
1657 :     @$dl_ref = sort { $cntref->{$a} <=> $cntref->{$b} } @$dl_ref;
1658 :     }
1659 :    
1660 :     # Reorder within descendant subtrees:
1661 :    
1662 :     my $step = 0;
1663 :     if (abs( $dir ) < 1e5) {
1664 :     $dir = 1 - $nd; # Midgroup => as is
1665 :     # $dir = 1 - $nd + ( $dir < 0 ? -0.5 : 0.5 ); # Midgroup => outward
1666 :     $step = 2;
1667 :     }
1668 :    
1669 :     for ( my $i = 0; $i < $nd; $i++ ) {
1670 :     reorder_by_tip_count( $dl_ref->[$i], $cntref, $dir );
1671 :     $dir += $step;
1672 :     }
1673 :    
1674 :     $node;
1675 :     }
1676 :    
1677 :    
1678 :     #-------------------------------------------------------------------------------
1679 :     # Randomize descendant order at each node (in place).
1680 :     #
1681 :     # $tree = random_order_newick_tree( $tree )
1682 :     #-------------------------------------------------------------------------------
1683 :     sub random_order_newick_tree {
1684 :     my ( $node ) = @_;
1685 :    
1686 :     my $nd = newick_n_desc( $node );
1687 :     if ( $nd < 1 ) { return $node } # Do nothing to a tip
1688 :    
1689 :     # Reorder this subtree:
1690 :    
1691 :     my $dl_ref = newick_desc_ref( $node );
1692 : overbeek 1.7 @$dl_ref = gjolists::random_order( @$dl_ref );
1693 : golsen 1.1
1694 :     # Reorder descendants:
1695 :    
1696 :     foreach ( @$dl_ref ) { random_order_newick_tree( $_ ) }
1697 :    
1698 :     $node;
1699 :     }
1700 :    
1701 :    
1702 :     #-------------------------------------------------------------------------------
1703 :     # Reroot a tree to the node that lies at the end of a path.
1704 :     #
1705 :     # $newtree = reroot_newick_by_path( @path )
1706 :     #-------------------------------------------------------------------------------
1707 :     sub reroot_newick_by_path {
1708 :     my ( $node1, $path1, @rest ) = @_;
1709 :     array_ref( $node1 ) || return undef; # Always expect a node
1710 :    
1711 :     defined( $path1 ) && @rest || return $node1; # If no path, we're done
1712 :    
1713 :     my $node2 = $rest[0]; # Next element in path is node 2
1714 :     newick_desc_i( $node1, $path1 ) eq $node2 || return undef; # Check link
1715 :    
1716 :     # Remove node 2 from node 1 descendant list. Could use a simple splice:
1717 :     #
1718 :     # splice( @$dl1, $path1-1, 1 );
1719 :     #
1720 : golsen 1.8 # But the following maintains the cyclic order of the nodes:
1721 : golsen 1.1
1722 :     my $dl1 = newick_desc_ref( $node1 );
1723 :     my $nd1 = @$dl1;
1724 :     if ( $path1 == 1 ) { shift @$dl1 }
1725 :     elsif ( $path1 == $nd1 ) { pop @$dl1 }
1726 :     else { @$dl1 = ( @$dl1[ $path1 .. $nd1-1 ]
1727 :     , @$dl1[ 0 .. $path1-2 ]
1728 :     )
1729 : golsen 1.8 }
1730 : golsen 1.1
1731 :     # Append node 1 to node 2 descendant list (does not alter numbering):
1732 :    
1733 :     my $dl2 = newick_desc_ref( $node2 );
1734 :     if ( array_ref( $dl2 ) ) { push @$dl2, $node1 }
1735 : golsen 1.8 else { set_newick_desc_list( $node2, $node1 ) }
1736 : golsen 1.1
1737 :     # Move c1 comments from node 1 to node 2:
1738 :    
1739 :     my $C11 = newick_c1( $node1 );
1740 :     my $C12 = newick_c1( $node2 );
1741 :     ! defined( $C11 ) || set_newick_c1( $node1, undef ); # Remove them from node 1
1742 : golsen 1.8 if ( $C12 && @$C12 ) { # If node 2 comments and
1743 :     if ( $C11 && @$C11 ) { unshift @$C12, @$C11 } # Node 1, prefix 1 to 2
1744 : golsen 1.1 }
1745 : golsen 1.8 elsif ( $C11 && @$C11 ) { set_newick_c1( $node2, $C11 ) } # Otherwise move node 1 link
1746 : golsen 1.1
1747 :     # Swap branch lengths and comments for reversal of link direction:
1748 :    
1749 :     my $x1 = newick_x( $node1 );
1750 :     my $x2 = newick_x( $node2 );
1751 :     ! defined( $x1 ) && ! defined ( $x2 ) || set_newick_x( $node1, $x2 );
1752 :     ! defined( $x1 ) && ! defined ( $x2 ) || set_newick_x( $node2, $x1 );
1753 :    
1754 :     my $c41 = newick_c4( $node1 );
1755 :     my $c42 = newick_c4( $node2 );
1756 :     ! defined( $c42 ) || ! @$c42 || set_newick_c4( $node1, $c42 );
1757 :     ! defined( $c41 ) || ! @$c41 || set_newick_c4( $node2, $c41 );
1758 :    
1759 :     my $c51 = newick_c5( $node1 );
1760 :     my $c52 = newick_c5( $node2 );
1761 :     ! defined( $c52 ) || ! @$c52 || set_newick_c5( $node1, $c52 );
1762 :     ! defined( $c51 ) || ! @$c51 || set_newick_c5( $node2, $c51 );
1763 :    
1764 :     reroot_newick_by_path( @rest ); # Node 2 is first element of rest
1765 :     }
1766 :    
1767 :    
1768 :     #-------------------------------------------------------------------------------
1769 :     # Move root of tree to named tip.
1770 :     #
1771 :     # $newtree = reroot_newick_to_tip( $tree, $tip )
1772 :     #-------------------------------------------------------------------------------
1773 :     sub reroot_newick_to_tip {
1774 :     my ( $tree, $tipname ) = @_;
1775 :     reroot_newick_by_path( path_to_tip( $tree, $tipname ) );
1776 :     }
1777 :    
1778 :    
1779 :     #-------------------------------------------------------------------------------
1780 :     # Move root of tree to be node adjacent to a named tip.
1781 :     #
1782 :     # $newtree = reroot_newick_next_to_tip( $tree, $tip )
1783 :     #-------------------------------------------------------------------------------
1784 :     sub reroot_newick_next_to_tip {
1785 :     my ( $tree, $tipname ) = @_;
1786 :     my @path = path_to_tip( $tree, $tipname );
1787 :     @path || return undef;
1788 :     @path == 1 ? reroot_newick_by_path( $tree, 1, newick_desc_i( $tree, 1 ) )
1789 :     : reroot_newick_by_path( @path[0 .. @path-3] );
1790 :     }
1791 :    
1792 :    
1793 :     #-------------------------------------------------------------------------------
1794 :     # Move root of tree to a node, defined by 1 or 3 tip names.
1795 :     #
1796 :     # $newtree = reroot_newick_to_node( $tree, @node )
1797 :     #-------------------------------------------------------------------------------
1798 :     sub reroot_newick_to_node {
1799 :     reroot_newick_by_path( path_to_node( @_ ) );
1800 :     }
1801 :    
1802 :    
1803 :     #-------------------------------------------------------------------------------
1804 :     # Move root of tree to a node, defined by reference.
1805 :     #
1806 :     # $newtree = reroot_newick_to_node_ref( $tree, $noderef )
1807 :     #-------------------------------------------------------------------------------
1808 :     sub reroot_newick_to_node_ref {
1809 :     my ( $tree, $node ) = @_;
1810 :     reroot_newick_by_path( path_to_node_ref( $tree, $node ) );
1811 :     }
1812 :    
1813 :    
1814 :     #-------------------------------------------------------------------------------
1815 :     # Move root of tree to an approximate midpoint.
1816 :     #
1817 :     # $newtree = reroot_newick_to_approx_midpoint( $tree )
1818 :     #-------------------------------------------------------------------------------
1819 :     sub reroot_newick_to_approx_midpoint {
1820 :     my ( $tree ) = @_;
1821 : golsen 1.5
1822 : golsen 1.1 # Compile average tip to node distances assending
1823 :    
1824 :     my $dists1 = average_to_tips_1( $tree );
1825 :    
1826 :     # Compile average tip to node distances descending, returning midpoint node
1827 :    
1828 :     my $node = average_to_tips_2( $dists1, undef, undef );
1829 :    
1830 :     # Reroot
1831 :    
1832 :     $node ? reroot_newick_to_node_ref( $tree, $node ) : $tree
1833 :     }
1834 :    
1835 :    
1836 :     sub average_to_tips_1 {
1837 :     my ( $node ) = @_;
1838 :    
1839 :     my @desc_dists = map { average_to_tips_1( $_ ) } newick_desc_list( $node );
1840 :     my $x_below = 0;
1841 :     if ( @desc_dists )
1842 :     {
1843 :     foreach ( @desc_dists ) { $x_below += $_->[0] }
1844 :     $x_below /= @desc_dists;
1845 :     }
1846 :     my $x = newick_x( $node ) || 0;
1847 :     my $x_net = $x_below + $x;
1848 :    
1849 :     [ $x_net, $x, $x_below, [ @desc_dists ], $node ]
1850 :     }
1851 :    
1852 :    
1853 :     sub average_to_tips_2 {
1854 :     my ( $dists1, $x_above, $anc_node ) = @_;
1855 :     my ( undef, $x, $x_below, $desc_list, $node ) = @$dists1;
1856 :    
1857 :     # Are we done? Root is in this node's branch, or "above"?
1858 :    
1859 :     # defined( $x_above ) and print STDERR "x_above = $x_above\n";
1860 :     # print STDERR "x = $x\n";
1861 :     # print STDERR "x_below = $x_below\n";
1862 :     # print STDERR "n_desc = ", scalar @$desc_list, "\n\n";
1863 :    
1864 :     if ( defined( $x_above ) && ( ( $x_above + $x ) >= $x_below ) )
1865 :     {
1866 :     # At this point the root can only be in this node's branch,
1867 :     # or "above" it in the current rooting of the tree (which
1868 :     # would mean that the midpoint is actually down a different
1869 :     # path from the root of the current tree).
1870 :     #
1871 :     # Is the root in the current branch?
1872 :    
1873 :     if ( ( $x_below + $x ) >= $x_above )
1874 :     {
1875 :     return ( $x_above >= $x_below ) ? $anc_node : $node;
1876 :     }
1877 :     else
1878 :     {
1879 :     return undef;
1880 :     }
1881 :     }
1882 :    
1883 : golsen 1.5 # The root must be somewhere below this node:
1884 : golsen 1.1
1885 : golsen 1.5 my $n_1 = @$desc_list - ( $anc_node ? 0 : 1 );
1886 : golsen 1.1 my $ttl_dist = ( @$desc_list * $x_below ) + ( defined( $x_above ) ? ( $x_above + $x ) : 0 );
1887 :    
1888 :     foreach ( @$desc_list )
1889 :     {
1890 :     # If input tree is tip_rooted, $n-1 can be 0, so:
1891 :    
1892 :     my $above2 = $n_1 ? ( ( $ttl_dist - $_->[0] ) / $n_1 ) : 0;
1893 :     my $root = average_to_tips_2( $_, $above2, $node );
1894 :     if ( $root ) { return $root }
1895 :     }
1896 :    
1897 :     # Was not anywhere below this node (oh-oh):
1898 :    
1899 :     return undef;
1900 :     }
1901 :    
1902 :    
1903 :     #-------------------------------------------------------------------------------
1904 : golsen 1.5 # Move root of tree to an approximate midpoint. Weight by tips.
1905 :     #
1906 :     # $newtree = reroot_newick_to_approx_midpoint_w( $tree )
1907 :     #-------------------------------------------------------------------------------
1908 :     sub reroot_newick_to_approx_midpoint_w {
1909 :     my ( $tree ) = @_;
1910 :    
1911 :     # Compile average tip to node distances assending
1912 :    
1913 :     my $dists1 = average_to_tips_1_w( $tree );
1914 :    
1915 :     # Compile average tip to node distances descending, returning midpoint node
1916 :    
1917 :     my $node = average_to_tips_2_w( $dists1, undef, undef, undef );
1918 :    
1919 :     # Reroot
1920 :    
1921 :     $node ? reroot_newick_to_node_ref( $tree, $node ) : $tree
1922 :     }
1923 :    
1924 :    
1925 :     sub average_to_tips_1_w {
1926 :     my ( $node ) = @_;
1927 :    
1928 :     my @desc_dists = map { average_to_tips_1_w( $_ ) } newick_desc_list( $node );
1929 :     my $x_below = 0;
1930 :     my $n_below = 1;
1931 :     if ( @desc_dists )
1932 :     {
1933 :     $n_below = 0;
1934 :     my $n;
1935 :     foreach ( @desc_dists )
1936 :     {
1937 :     $n_below += $n = $_->[1];
1938 :     $x_below += $n * $_->[0];
1939 :     }
1940 :     $x_below /= $n_below;
1941 :     }
1942 :     my $x = newick_x( $node ) || 0;
1943 :     my $x_net = $x_below + $x;
1944 :    
1945 :     [ $x_net, $n_below, $x, $x_below, [ @desc_dists ], $node ]
1946 :     }
1947 :    
1948 :    
1949 :     sub average_to_tips_2_w {
1950 :     my ( $dists1, $x_above, $n_above, $anc_node ) = @_;
1951 :     my ( undef, $n_below, $x, $x_below, $desc_list, $node ) = @$dists1;
1952 :    
1953 :     # Are we done? Root is in this node's branch, or "above"?
1954 :    
1955 :     # defined( $x_above ) and print STDERR "x_above = $x_above\n";
1956 :     # print STDERR "x = $x\n";
1957 :     # print STDERR "x_below = $x_below\n";
1958 :     # print STDERR "n_desc = ", scalar @$desc_list, "\n\n";
1959 :    
1960 :     if ( defined( $x_above ) && ( ( $x_above + $x ) >= $x_below ) )
1961 :     {
1962 :     # At this point the root can only be in this node's branch,
1963 :     # or "above" it in the current rooting of the tree (which
1964 :     # would mean that the midpoint is actually down a different
1965 :     # path from the root of the current tree).
1966 :     #
1967 :     # Is the root in the current branch?
1968 :    
1969 :     if ( ( $x_below + $x ) >= $x_above )
1970 :     {
1971 :     return ( $x_above >= $x_below ) ? $anc_node : $node;
1972 :     }
1973 :     else
1974 :     {
1975 :     return undef;
1976 :     }
1977 :     }
1978 :    
1979 :     # The root must be some where below this node:
1980 :    
1981 :     $n_above ||= 0;
1982 :     my $n = $n_above + $n_below;
1983 :     my $ttl_w_dist = ( $n_below * $x_below )
1984 :     + ( defined( $x_above ) ? $n_above * ( $x_above + $x ) : 0 );
1985 :    
1986 :     foreach ( @$desc_list )
1987 :     {
1988 :     my $n_2 = $_->[1]; # n in subtree
1989 :     my $n_above2 = $n - $n_2; # tip rooted has 1 above
1990 :    
1991 :     # If input tree is tip_rooted, $n_above2 can be 0, so:
1992 :    
1993 :     my $x_above2 = $n_above2 ? ( ( $ttl_w_dist - $n_2 * $_->[0] ) / $n_above2 )
1994 :     : 0;
1995 :     my $root = average_to_tips_2_w( $_, $x_above2, $n_above2 || 1, $node );
1996 :     if ( $root ) { return $root }
1997 :     }
1998 :    
1999 :     # Was not anywhere below this node (oh-oh):
2000 :    
2001 :     return undef;
2002 :     }
2003 :    
2004 :    
2005 :     #-------------------------------------------------------------------------------
2006 : golsen 1.1 # Move root of tree from tip to adjacent node.
2007 :     #
2008 :     # $newtree = uproot_tip_rooted_newick( $tree )
2009 :     #-------------------------------------------------------------------------------
2010 :     sub uproot_tip_rooted_newick {
2011 :     my ( $node ) = @_;
2012 :     newick_is_tip_rooted( $node ) || return $node;
2013 :    
2014 :     # Path to the sole descendant:
2015 :    
2016 :     reroot_newick_by_path( $node, 1, newick_desc_i( $node, 1 ) );
2017 :     }
2018 :    
2019 :    
2020 :     #-------------------------------------------------------------------------------
2021 :     # Remove root bifurcation.
2022 :     #
2023 :     # Root node label, label comment and descendant list comment are discarded.
2024 :     #
2025 :     # $newtree = uproot_newick( $tree )
2026 :     #-------------------------------------------------------------------------------
2027 :     sub uproot_newick {
2028 :     my ( $node0 ) = @_;
2029 :     newick_is_rooted( $node0 ) || return $node0;
2030 :    
2031 :     my ( $node1, $node2 ) = newick_desc_list( $node0 );
2032 :    
2033 :     # Ensure that node1 has at least 1 descendant
2034 :    
2035 :     if ( newick_n_desc( $node1 ) ) {
2036 :     push @{ newick_desc_ref( $node1 ) }, $node2; # Add node2 to descend list
2037 :     }
2038 :    
2039 :     # Or node2 has at least 1 descendant
2040 :    
2041 :     elsif ( newick_n_desc( $node2 ) ) {
2042 :     unshift @{ newick_desc_ref( $node2 ) }, $node1; # Add node1 to descend list
2043 :     ( $node1, $node2 ) = ( $node2, $node1 ); # And reverse labels
2044 :     }
2045 :    
2046 :     # We could make this into a tip rooted tree, but for now:
2047 :    
2048 :     else { return $node0 }
2049 :    
2050 :     # Prefix node1 branch to that of node2:
2051 :    
2052 :     add_to_newick_branch( $node2, $node1 );
2053 :     set_newick_x( $node1, undef );
2054 :    
2055 :     # Tree prefix comment lists (as references):
2056 :    
2057 :     my $C10 = newick_c1( $node0 );
2058 :     my $C11 = newick_c1( $node1 );
2059 :     if ( $C11 && @$C11 ) {
2060 :     if ( $C10 && @$C10 ) { unshift @$C11, @$C10 } # Prefix to node1 comments
2061 :     }
2062 :     elsif ( $C10 && @$C10 ) {
2063 :     set_newick_c1( $node1, $C10 ) # Or move node0 comments to node1
2064 :     }
2065 :    
2066 :     $node1;
2067 :     }
2068 :    
2069 :    
2070 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2071 :     # Prefix branch of node2 to that of node1:
2072 :     #
2073 :     # $node1 = add_to_newick_branch( $node1, $node2 )
2074 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2075 :     sub add_to_newick_branch {
2076 :     my ( $node1, $node2 ) = @_;
2077 :     array_ref( $node1 ) || die "add_to_newick_branch: arg 1 not array ref\n";
2078 :     array_ref( $node2 ) || die "add_to_newick_branch: arg 2 not array ref\n";
2079 :    
2080 :     # Node structure template:
2081 :     # my ( $DL, $L, $X, $C1, $C2, $C3, $C4, $C5 ) = @$node;
2082 :    
2083 :     # Fix branch lengths for joining of two branches:
2084 :    
2085 :     set_newick_x( $node1, newick_x( $node1 ) + newick_x( $node2 ) );
2086 :    
2087 :     # Merge branch length comments:
2088 :    
2089 :     my $C41 = newick_c4( $node1 ); # Ref to node1 C4
2090 :     my $C42 = newick_c4( $node2 ); # Ref to node2 C4
2091 :     if ( $C41 && @$C41 ) {
2092 :     if ( $C42 && @$C42 ) { unshift @$C41, @$C42 } # Add node2 comment
2093 :     }
2094 :     elsif ( $C42 && @$C42 ) { set_newick_c4( $node1, $C42 ) } # Or move node1 comment
2095 :    
2096 :     my $C51 = newick_c5( $node1 ); # Ref to node1 C5
2097 :     my $C52 = newick_c5( $node2 ); # Ref to node2 C5
2098 :     if ( $C51 && @$C51 ) {
2099 :     if ( $C52 && @$C52 ) { unshift @$C51, @$C52 } # Add node2 comment
2100 :     }
2101 :     elsif ( $C52 && @$C52 ) { set_newick_c5( $node1, $C52 ) } # Or move node1 comment
2102 :    
2103 :     $node1;
2104 :     }
2105 :    
2106 :    
2107 :     #-------------------------------------------------------------------------------
2108 : golsen 1.5 # Collapse zero-length branches to make multifurcation. The original tree
2109 :     # is modified.
2110 :     #
2111 :     # $tree = collapse_zero_length_branches( $tree )
2112 :     # $tree = collapse_zero_length_branches( $tree, $not_root )
2113 :     #-------------------------------------------------------------------------------
2114 :     sub collapse_zero_length_branches {
2115 :     my ( $tree, $not_root ) = @_;
2116 :     array_ref( $tree ) || return undef;
2117 :    
2118 :     my @desc = newick_desc_list( $tree );
2119 :     @desc or return ( $tree ); # Cannot collapse terminal branch
2120 :    
2121 :     # Analyze descendants:
2122 :    
2123 :     $not_root ||= 0;
2124 :     my @new_desc = ();
2125 :     my $changed = 0;
2126 :     foreach ( @desc )
2127 :     {
2128 :     my ( undef, @to_add ) = collapse_zero_length_branches( $_, $not_root+1 );
2129 :     if ( @to_add )
2130 :     {
2131 :     push @new_desc, @to_add;
2132 :     $changed = 1;
2133 :     }
2134 :     else
2135 :     {
2136 :     push @new_desc, $_;
2137 :     }
2138 :     }
2139 :     set_newick_desc_ref( $tree, [ @new_desc ] ) if $changed;
2140 :    
2141 :     # Collapse if not root, not tip and zero (or negative) branch:
2142 :    
2143 :     my $collapse = $not_root && @new_desc && ( newick_x( $tree ) <= 0 ) ? 1 : 0;
2144 :     ( $tree, ( $collapse ? @new_desc : () ) );
2145 :     }
2146 :    
2147 : golsen 1.8 #-------------------------------------------------------------------------------
2148 :     # Add a subtree to a newick tree node:
2149 :     #
2150 :     # $node = newick_insert_at_node( $node, $subtree )
2151 :     #-------------------------------------------------------------------------------
2152 :     sub newick_insert_at_node
2153 :     {
2154 :     my ( $node, $subtree ) = @_;
2155 :     array_ref( $node ) && array_ref( $subtree ) or return undef;
2156 :    
2157 :     # We could check validity of trees, but ....
2158 :    
2159 :     my $dl = newick_desc_ref( $node );
2160 :     if ( array_ref( $dl ) )
2161 :     {
2162 :     push @$dl, $subtree;
2163 :     }
2164 :     else
2165 :     {
2166 :     set_newick_desc_ref( $node, [ $subtree ] );
2167 :     }
2168 :     return $node;
2169 :     }
2170 :    
2171 :    
2172 :     #-------------------------------------------------------------------------------
2173 :     # Insert a subtree into a newick tree along the path between 2 nodes:
2174 :     #
2175 :     # $tree = newick_insert_between_nodes( $tree, $subtree, $node1, $node2, $fraction )
2176 :     #-------------------------------------------------------------------------------
2177 :     sub newick_insert_between_nodes
2178 :     {
2179 :     my ( $tree, $subtree, $node1, $node2, $fraction ) = @_;
2180 :     array_ref( $tree ) && array_ref( $subtree ) or return undef;
2181 :     $fraction >= 0 && $fraction <= 1 or return undef;
2182 :    
2183 :     # Find the paths to the nodes:
2184 :    
2185 :     my @path1 = path_to_node( $tree, $node1 ) or return undef;
2186 :     my @path2 = path_to_node( $tree, $node2 ) or return undef;
2187 :    
2188 :     # Trim the common prefix:
2189 :    
2190 :     while ( $path1[1] == $path2[1] )
2191 :     {
2192 :     splice( @path1, 0, 2 );
2193 :     splice( @path2, 0, 2 );
2194 :     }
2195 :    
2196 :     my ( @path, $dist );
2197 :     if ( @path1 < 3 )
2198 :     {
2199 :     @path2 >= 3 or return undef; # node1 = node2
2200 :     $dist = $fraction* newick_path_length( @path2 );
2201 :     @path = @path2;
2202 :     }
2203 :     elsif ( @path2 < 3 )
2204 :     {
2205 :     $dist = ( 1 - $fraction ) * newick_path_length( @path1 );
2206 :     @path = @path1;
2207 :     }
2208 :     else
2209 :     {
2210 :     my $dist1 = newick_path_length( @path1 );
2211 :     my $dist2 = newick_path_length( @path2 );
2212 :     $dist = $fraction * ( $dist1 + $dist2 ) - $dist1;
2213 :     @path = ( $dist <= 0 ) ? @path1 : @path2;
2214 :     $dist = abs( $dist );
2215 :     }
2216 :    
2217 :     # Descend tree until we reach the insertion branch:
2218 :    
2219 :     my $x;
2220 :     while ( ( $dist > ( $x = newick_x( $path[2] ) ) ) && ( @path > 3 ) )
2221 :     {
2222 :     $dist -= $x;
2223 :     splice( @path, 0, 2 );
2224 :     }
2225 :    
2226 :     # Insert the new node:
2227 :    
2228 :     set_newick_desc_i( $path[0], $path[1], [ [ $path[2], $subtree ], undef, $dist ] );
2229 :     set_newick_x( $path[2], ( ( $x > $dist ) ? ( $x - $dist ) : 0 ) );
2230 :    
2231 :     return $tree;
2232 :     }
2233 :    
2234 : golsen 1.5
2235 :     #-------------------------------------------------------------------------------
2236 : golsen 1.1 # Prune one or more tips from a tree:
2237 :     # Caveat: if one tip is listed, the original tree is modified.
2238 : golsen 1.5 # if more than one tip is listed, a copy of the tree is returned
2239 : golsen 1.1 # (even if it is just listing the same tip twice!).
2240 :     #
2241 :     # $newtree = prune_from_newick( $tree, $tip )
2242 :     # $newtree = prune_from_newick( $tree, @tips )
2243 :     # $newtree = prune_from_newick( $tree, \@tips )
2244 :     #-------------------------------------------------------------------------------
2245 :     sub prune_from_newick {
2246 :     my ( $tr, @tips ) = @_;
2247 :     if ( @tips == 1 && ref( $tips[0] ) eq "ARRAY" ) { @tips = @{ $tips[0] } }
2248 :    
2249 :     if ( @tips == 0 ) { return $tr }
2250 :     if ( @tips == 1 ) { return prune_1_from_newick( $tr, @tips ) }
2251 :    
2252 :     my %del = map { ( $_, 1 ) } @tips;
2253 :     my @keep = grep { ! $del{ $_ } } newick_tip_list( $tr );
2254 :     newick_subtree( $tr, @keep );
2255 :     }
2256 :    
2257 :    
2258 :     #-------------------------------------------------------------------------------
2259 :     # Prune a tip from a tree:
2260 :     #
2261 :     # $newtree = prune_1_from_newick( $tree, $tip )
2262 :     #-------------------------------------------------------------------------------
2263 :     sub prune_1_from_newick {
2264 :     my ( $tr, $tip ) = @_;
2265 :     my @path = path_to_tip( $tr, $tip );
2266 :     if ( @path < 3 ) { return $tr }
2267 :    
2268 :     my $node = $path[-1]; # Node with the tip
2269 :     my $i1 = $path[-2]; # Descendant number of node in ancestor desc list
2270 :     my $anc1 = $path[-3]; # Ancestor of node
2271 :     my $nd1 = newick_n_desc( $anc1 ); # Number of descendants of ancestor
2272 :     my $anc2 = ( @path >= 5 ) ? $path[-5] : undef; # Ancestor of anc1
2273 :    
2274 :     # dump_tree( $node );
2275 :     # print STDERR "i1 = $i1\n";
2276 :     # dump_tree( $anc1 );
2277 :     # print STDERR "nd1 = $nd1\n";
2278 :     # defined( $anc2 ) && dump_tree( $anc2 );
2279 :    
2280 :     if ( $nd1 > 3 || ( $anc2 && $nd1 > 2 ) ) { # Tip joins at multifurcation
2281 :     splice( @{ $anc1->[0] }, $i1-1, 1 ); # delete the descendant
2282 :     }
2283 :    
2284 :     elsif ( $anc2 ) { # Tip joins at internal bifurcation
2285 :     my $sis = newick_desc_i( $anc1, 3-$i1 ); # find sister node
2286 :     add_to_newick_branch( $sis, $anc1 ); # combine internal branches
2287 :     set_newick_desc_i( $anc2, $path[-4], $sis ); # remove $anc1
2288 :     }
2289 :    
2290 :     elsif ( $nd1 == 2) { # Tip joins bifurcating root node
2291 :     my $sis = newick_desc_i( $anc1, 3-$i1 ); # find sister node
2292 :     $sis->[1] = $anc1->[1] if ! $sis->[1] && $anc1->[1]; # root label
2293 :     $sis->[2] = undef; # root branch len
2294 :     $sis->[3] = $anc1->[3] if ! $sis->[3] && $anc1->[3]; # tree comment
2295 :     $sis->[4] = $anc1->[4] if ! $sis->[4] && $anc1->[4]; # desc list comment
2296 :     $sis->[5] = $anc1->[5] if ! $sis->[5] && $anc1->[5]; # label comment
2297 :     $sis->[6] = undef if $sis->[6]; # root branch comment
2298 :     $sis->[7] = undef if $sis->[7]; # root branch comment
2299 :     $tr = $sis; # sister is new root
2300 :     }
2301 :    
2302 :     elsif ( $nd1 == 3 ) { # Tip joins trifurcating root:
2303 :     splice( @{ $anc1->[0] }, $i1-1, 1 ); # delete the descendant, and
2304 :     $tr = uproot_newick( $tr ); # fix the rooting
2305 :     }
2306 :    
2307 :     else {
2308 :     return undef;
2309 :     }
2310 :    
2311 :     return $tr;
2312 :     }
2313 :    
2314 :    
2315 :     #-------------------------------------------------------------------------------
2316 :     # Produce a subtree with the desired tips:
2317 :     #
2318 :     # Except for (some) tip nodes, the tree produced is a copy.
2319 :     # There is no check that requested tips exist.
2320 :     #
2321 :     # $newtree = newick_subtree( $tree, @tips )
2322 :     # $newtree = newick_subtree( $tree, \@tips )
2323 :     #-------------------------------------------------------------------------------
2324 :     sub newick_subtree {
2325 :     my ( $tr, @tips ) = @_;
2326 :     if ( @tips == 1 && ref( $tips[0] ) eq "ARRAY" ) { @tips = @{ $tips[0] } }
2327 :    
2328 :     if ( @tips < 2 ) { return undef }
2329 :     my $was_rooted = newick_is_rooted( $tr );
2330 :     my $keephash = { map { ( $_, 1 ) } @tips };
2331 :     my $tr2 = subtree1( $tr, $keephash );
2332 :     $tr2 = uproot_newick( $tr2 ) if ! $was_rooted && newick_is_rooted( $tr2 );
2333 :     $tr2->[2] = undef if $tr2; # undef root branch length
2334 :     $tr2;
2335 :     }
2336 :    
2337 :    
2338 :     sub subtree1 {
2339 :     my ( $tr, $keep ) = @_;
2340 :     my @desc1 = newick_desc_list( $tr );
2341 :    
2342 :     # Is this a tip, and is it in the keep list?
2343 :    
2344 :     if ( @desc1 < 1 ) {
2345 :     return ( $keep->{ newick_lbl( $tr ) } ) ? $tr : undef;
2346 :     }
2347 :    
2348 :     # Internal node: analyze the descendants:
2349 :    
2350 :     my @desc2 = ();
2351 :     foreach ( @desc1 ) {
2352 :     my $desc = subtree1( $_, $keep );
2353 :     if ( $desc && @$desc ) { push @desc2, $desc }
2354 :     }
2355 :    
2356 :     if ( @desc2 == 0 ) { return undef }
2357 :     if ( @desc2 > 1 ) { return [ \@desc2, @$tr[ 1 .. @$tr - 1 ] ] }
2358 :    
2359 :     # Exactly 1 descendant
2360 :    
2361 :     my $desc = $desc2[ 0 ];
2362 :     my @nn = ( $desc->[0],
2363 :     $desc->[1] ? $desc->[1] : $tr->[1],
2364 :     defined( $tr->[2] ) ? $desc->[2] + $tr->[2] : undef
2365 :     );
2366 :    
2367 :     # Merge comments (only recreating the ones that existed):
2368 :    
2369 :     if ( $tr->[3] && @{$tr->[3]} || $desc->[3] && @{$desc->[3]} ) {
2370 :     $nn[3] = [ $tr->[3] ? @{$tr->[3]} : (), $desc->[3] ? @{$desc->[3]} : () ];
2371 :     }
2372 :     if ( $tr->[4] && @{$tr->[4]} || $desc->[4] && @{$desc->[4]} ) {
2373 :     $nn[4] = [ $tr->[4] ? @{$tr->[4]} : (), $desc->[4] ? @{$desc->[4]} : () ];
2374 :     }
2375 :     if ( $tr->[5] && @{$tr->[5]} || $desc->[5] && @{$desc->[5]} ) {
2376 :     $nn[5] = [ $tr->[5] ? @{$tr->[5]} : (), $desc->[5] ? @{$desc->[5]} : () ];
2377 :     }
2378 :     if ( $tr->[6] && @{$tr->[6]} || $desc->[6] && @{$desc->[6]} ) {
2379 :     $nn[6] = [ $tr->[6] ? @{$tr->[6]} : (), $desc->[6] ? @{$desc->[6]} : () ];
2380 :     }
2381 :     if ( $tr->[7] && @{$tr->[7]} || $desc->[7] && @{$desc->[7]} ) {
2382 :     $nn[7] = [ $tr->[7] ? @{$tr->[7]} : (), $desc->[7] ? @{$desc->[7]} : () ];
2383 :     }
2384 :    
2385 :     return \@nn;
2386 :     }
2387 :    
2388 :    
2389 :     #===============================================================================
2390 :     #
2391 :     # Tree writing and reading
2392 :     #
2393 :     #===============================================================================
2394 : overbeek 1.7 # writeNewickTree( $tree )
2395 :     # writeNewickTree( $tree, $file )
2396 :     # writeNewickTree( $tree, \*FH )
2397 : golsen 1.1 #-------------------------------------------------------------------------------
2398 :     sub writeNewickTree {
2399 :     my ( $tree, $file ) = @_;
2400 : overbeek 1.7 my ( $fh, $close ) = open_output( $file );
2401 :     $fh or return;
2402 :     print $fh ( strNewickTree( $tree ), "\n" );
2403 :     close $fh if $close;
2404 : golsen 1.1 }
2405 :    
2406 :    
2407 :     #-------------------------------------------------------------------------------
2408 :     # fwriteNewickTree( $file, $tree ) # Args reversed to writeNewickTree
2409 :     #-------------------------------------------------------------------------------
2410 :     sub fwriteNewickTree { writeNewickTree( $_[1], $_[0] ) }
2411 :    
2412 :    
2413 :     #-------------------------------------------------------------------------------
2414 :     # $treestring = strNewickTree( $tree )
2415 :     #-------------------------------------------------------------------------------
2416 :     sub strNewickTree {
2417 :     my $node = shift @_;
2418 :     strNewickSubtree( $node, "" ) . ";";
2419 :     }
2420 :    
2421 :    
2422 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2423 :     # $string = strNewickSubtree( $node, $prefix )
2424 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2425 :     sub strNewickSubtree {
2426 :     my ( $node, $prefix ) = @_;
2427 :     my $s;
2428 :    
2429 :     $s = strNewickComments( newick_c1( $node ), $prefix );
2430 :     if ( $s ) { $prefix = " " }
2431 :    
2432 :     my $ndesc;
2433 :     if ( $ndesc = newick_n_desc( $node ) ) {
2434 :     for (my $d = 1; $d <= $ndesc; $d++) {
2435 :     $s .= ( ( $d == 1 ) ? $prefix . "(" : "," )
2436 :     . strNewickSubtree( newick_desc_i( $node, $d ), " " );
2437 :     }
2438 :    
2439 :     $s .= ")" . strNewickComments( newick_c2( $node ), " " );
2440 :     $prefix = " ";
2441 :     }
2442 :    
2443 :     if ( defined( newick_lbl( $node ) ) && newick_lbl( $node ) ) {
2444 :     $s .= $prefix
2445 :     . q_newick_lbl( $node )
2446 :     . strNewickComments( newick_c3( $node ), " " );
2447 :     }
2448 :    
2449 :     if ( defined( newick_x( $node ) ) ) {
2450 :     $s .= ":"
2451 :     . strNewickComments( newick_c4( $node ), " " )
2452 :     . sprintf( " %.6f", newick_x( $node ) )
2453 :     . strNewickComments( newick_c5( $node ), " " );
2454 :     }
2455 :    
2456 :     $s;
2457 :     }
2458 :    
2459 :    
2460 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2461 :     # $string = strNewickComments( $clist, $prefix )
2462 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2463 :     sub strNewickComments {
2464 :     my ( $clist, $prefix ) = @_;
2465 :     array_ref( $clist ) && ( @$clist > 0 ) || return "";
2466 :     $prefix . "[" . join( "] [", @$clist ) . "]";
2467 :     }
2468 :    
2469 :    
2470 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2471 :     # $quoted_label = q_newick_lbl( $label )
2472 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2473 :     sub q_newick_lbl {
2474 :     my $lbl = newick_lbl( $_[0] );
2475 :     defined( $lbl ) && ( $lbl ne "" ) || return undef;
2476 :    
2477 :     if ( $lbl =~ m/^[^][()_:;,]+$/ # Anything but []()_:;,
2478 :     && $lbl !~ m/^'/ ) { # and does not start with '
2479 :     $lbl =~ s/ /_/g; # Recode blanks as _
2480 :     return $lbl;
2481 :     }
2482 :    
2483 :     else {
2484 :     $lbl =~ s/'/''/g; # Double existing single quote marks
2485 :     return q(') . $lbl . q('); # Wrap in single quote marks
2486 :     }
2487 :     }
2488 :    
2489 :    
2490 :     #===============================================================================
2491 :     # $treestring = formatNewickTree( $tree )
2492 :     #===============================================================================
2493 :     sub formatNewickTree {
2494 :     formatNewickSubtree( $_[0], "", "" ) . ";";
2495 :     }
2496 :    
2497 :    
2498 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2499 :     # $string = formatNewickSubtree( $node, $prefix, $indent )
2500 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2501 :     sub formatNewickSubtree {
2502 :     my ( $node, $prefix, $indent ) = @_;
2503 :     my $s;
2504 :    
2505 :     $s = formatNewickComments( newick_c1( $node ), $prefix, $indent );
2506 :     if ( $s ) { $prefix = "\n$indent" }
2507 :    
2508 :     if ( my $ndesc = newick_n_desc( $node ) ) {
2509 :     for (my $d = 1; $d <= $ndesc; $d++) {
2510 :     $s .= ( ( $d == 1 ) ? $prefix . "(" : ",\n$indent " )
2511 :     . formatNewickSubtree( newick_desc_i( $node, $d ), " ", $indent . " " );
2512 :     }
2513 :    
2514 :     $s .= "\n$indent)" . formatNewickComments( newick_c2( $node ), " ", $indent );
2515 :     $prefix = " ";
2516 :     }
2517 :    
2518 :     if ( defined( newick_lbl( $node ) ) && newick_lbl( $node ) ) {
2519 :     $s .= $prefix
2520 :     . q_newick_lbl( $node )
2521 :     . formatNewickComments( newick_c3( $node ), " ", $indent );
2522 :     }
2523 :    
2524 :     if ( defined( newick_x( $node ) ) ) {
2525 :     $s .= ":"
2526 :     . formatNewickComments( newick_c4( $node ), " ", $indent )
2527 :     . sprintf(" %.6f", newick_x( $node ) )
2528 :     . formatNewickComments( newick_c5( $node ), " ", $indent );
2529 :     }
2530 :    
2531 :     $s;
2532 :     }
2533 :    
2534 :    
2535 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2536 :     # $string = formatNewickComments( $clist, $prefix, $indent )
2537 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2538 :     sub formatNewickComments {
2539 :     my ( $clist, $prefix, $indent ) = @_;
2540 :     array_ref( $clist ) && @$clist || return "";
2541 :     $prefix . "[" . join( "] [", @$clist ) . "]";
2542 :     }
2543 :    
2544 :    
2545 :     #===============================================================================
2546 : overbeek 1.7 # $tree = read_newick_tree( $file ) # reads to a semicolon
2547 :     # @trees = read_newick_trees( $file ) # reads to end of file
2548 :     #===============================================================================
2549 :    
2550 :     sub read_newick_tree
2551 :     {
2552 :     my $file = shift;
2553 :     my ( $fh, $close ) = open_input( $file );
2554 :     my $tree;
2555 :     my @lines = ();
2556 :     while ( defined( $_ = <$fh> ) )
2557 :     {
2558 :     chomp;
2559 :     push @lines, $_;
2560 :     if ( /;/ )
2561 :     {
2562 :     $tree = parse_newick_tree_str( join( ' ', @lines ) );
2563 :     last;
2564 :     }
2565 :     }
2566 :     close $fh if $close;
2567 :    
2568 :     $tree;
2569 :     }
2570 :    
2571 :    
2572 :     sub read_newick_trees
2573 :     {
2574 :     my $file = shift;
2575 :     my ( $fh, $close ) = open_input( $file );
2576 :     my @trees = ();
2577 :     my @lines = ();
2578 :     while ( defined( $_ = <$fh> ) )
2579 :     {
2580 :     chomp;
2581 :     push @lines, $_;
2582 :     if ( /;/ )
2583 :     {
2584 :     push @trees, parse_newick_tree_str( join( ' ', @lines ) );
2585 :     @lines = ()
2586 :     }
2587 :     }
2588 :     close $fh if $close;
2589 :    
2590 :     @trees;
2591 :     }
2592 :    
2593 :    
2594 :     #===============================================================================
2595 : golsen 1.1 # Tree reader adapted from the C language reader in fastDNAml
2596 :     #
2597 :     # $tree = parse_newick_tree_str( $string )
2598 :     #===============================================================================
2599 :     sub parse_newick_tree_str {
2600 :     my $s = shift @_;
2601 :    
2602 :     my ( $ind, $rootnode ) = parse_newick_subtree( $s, 0 );
2603 :     if ( substr( $s, $ind, 1 ) ne ";") { warn "warning: tree missing ';'\n" }
2604 :     $rootnode;
2605 :     }
2606 :    
2607 :    
2608 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2609 :     # Read a subtrees recursively (everything of tree but a semicolon)
2610 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2611 :     sub parse_newick_subtree {
2612 :     my ( $s, $ind ) = @_;
2613 :    
2614 :     my $newnode = [];
2615 :     my @dlist = ();
2616 :     my ( $lbl, $x, $c1, $c2, $c3, $c4, $c5 );
2617 :    
2618 :     ( $ind, $c1 ) = getNextTreeChar( $s, $ind ); # Comment 1
2619 :     if ( ! defined( $ind ) ) { treeParseError( "missing subtree" ) }
2620 :     if ( $c1 && @$c1 ) { set_newick_c1( $newnode, $c1 ) }
2621 :    
2622 :     if ( substr( $s, $ind, 1 ) eq "(" ) { # New internal node
2623 :     while ( ! @dlist || ( substr( $s, $ind, 1 ) eq "," ) ) {
2624 :     my $desc;
2625 :     ( $ind, $desc ) = parse_newick_subtree( $s, $ind+1 );
2626 :     if (! $ind) { return () }
2627 :     push @dlist, $desc;
2628 :     }
2629 :     if ( substr( $s, $ind, 1 ) ne ")" ) { treeParseError( "missing ')'" ) }
2630 :    
2631 :     ( $ind, $c2 ) = getNextTreeChar( $s, $ind+1 ); # Comment 2
2632 :     if ( $c2 && @$c2 ) { set_newick_c2( $newnode, $c2 ) }
2633 :     ( $ind, $lbl ) = parseTreeNodeLabel( $s, $ind ); # Node label
2634 :     }
2635 :    
2636 :     elsif ( substr( $s, $ind, 1 ) =~ /[^][(,):;]/ ) { # New tip
2637 :     ( $ind, $lbl ) = parseTreeNodeLabel( $s, $ind ); # Tip label
2638 :     if (! $ind) { return () }
2639 :     }
2640 :    
2641 :     @dlist || $lbl || treeParseError( "no descendant list or label" );
2642 :    
2643 :     if ( @dlist ) { set_newick_desc_ref( $newnode, \@dlist ) }
2644 :     if ( $lbl ) { set_newick_lbl( $newnode, $lbl ) }
2645 :    
2646 :     ( $ind, $c3 ) = getNextTreeChar( $s, $ind ); # Comment 3
2647 :     if ( $c3 && @$c3 ) { set_newick_c3( $newnode, $c3 ) }
2648 :    
2649 :     if (substr( $s, $ind, 1 ) eq ":") { # Branch length
2650 :     ( $ind, $c4 ) = getNextTreeChar( $s, $ind+1 ); # Comment 4
2651 :     if ( $c4 && @$c4 ) { set_newick_c4( $newnode, $c4 ) }
2652 :     ( $ind, $x ) = parseBranchLength( $s, $ind );
2653 :     if ( defined( $x ) ) { set_newick_x( $newnode, $x ) }
2654 :     ( $ind, $c5 ) = getNextTreeChar( $s, $ind ); # Comment 5
2655 :     if ( $c5 && @$c5 ) { set_newick_c5( $newnode, $c5 ) }
2656 :     }
2657 :    
2658 :     ( $ind, $newnode );
2659 :     }
2660 :    
2661 :    
2662 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2663 :     # Read a Newick tree label
2664 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2665 :     sub parseTreeNodeLabel { # Empty string is permitted
2666 :     my ( $s, $ind ) = @_;
2667 :     my ( $lbl, $c );
2668 :    
2669 :     if ( substr( $s, $ind, 1 ) eq "'") {
2670 :     my $ind1 = ++$ind;
2671 :    
2672 :     while ( ) {
2673 :     if ( ! defined( $c = substr( $s, $ind, 1 ) ) || $c eq "" ) {
2674 :     treeParseError( "missing close quote on label '" . substr( $s, $ind1 ) . "'" )
2675 :     }
2676 :     elsif ( $c ne "'" ) { $ind++ }
2677 :     elsif ( substr( $s, $ind, 2 ) eq "''" ) { $ind += 2 }
2678 :     else { last }
2679 :     }
2680 :    
2681 :     $lbl = substr( $s, $ind1, $ind-$ind1 );
2682 :     $lbl =~ s/''/'/g;
2683 :     $ind++;
2684 :     }
2685 :    
2686 :     else {
2687 :     my $ind1 = $ind;
2688 :     while ( defined( $c = substr($s, $ind, 1) ) && $c ne "" && $c !~ /[][\s(,):;]/ ) { $ind++ }
2689 :     $lbl = substr( $s, $ind1, $ind-$ind1 );
2690 :     $lbl =~ s/_/ /g;
2691 :     }
2692 :    
2693 :     ( $ind, $lbl );
2694 :     }
2695 :    
2696 :    
2697 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2698 :     # Read a Newick tree branch length
2699 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2700 :     sub parseBranchLength {
2701 :     my ( $s, $ind ) = @_;
2702 :    
2703 :     my $c = substr( $s, $ind, 1 );
2704 :    
2705 :     my $sign = ( $c ne "-" ) ? 1 : -1; # Sign
2706 :     if ( $c =~ /[-+]/ ) { $c = substr( $s, ++$ind, 1 ) }
2707 :    
2708 :     if ( $c !~ /^[.0-9]$/ ) { # Allows starting with decimal
2709 :     treeParseError( "invalid branch length character '$c'" )
2710 :     }
2711 :    
2712 :     my $v = 0;
2713 :     while ( $c =~ /[0-9]/ ) { # Whole number
2714 :     $v = 10 * $v + $c;
2715 :     $c = substr( $s, ++$ind, 1 );
2716 :     }
2717 :    
2718 :     if ( $c eq "." ) { # Fraction
2719 :     my $f = 0.1;
2720 :     $c = substr( $s, ++$ind, 1 );
2721 :     while ( $c =~ /[0-9]/ ) {
2722 :     $v += $f * $c;
2723 :     $f *= 0.1;
2724 :     $c = substr( $s, ++$ind, 1 );
2725 :     }
2726 :     }
2727 :    
2728 :     $v *= $sign;
2729 :    
2730 :     if ( $c =~ /[dDeEgG]/ ) { # Exponent
2731 :     $c = substr( $s, ++$ind, 1 );
2732 :     my $esign = ( $c ne "-" ) ? 1 : -1;
2733 :     if ( $c =~ /^[-+]$/ ) { $c = substr( $s, ++$ind, 1 ) }
2734 :     if ( $c !~ /^[0-9]$/ ) {
2735 :     treeParseError( "missing branch length exponent '$c'" )
2736 :     }
2737 :    
2738 :     my $e = 0;
2739 :     while ( $c =~ /[0-9]/ ) {
2740 :     $e = 10 * $e + $c;
2741 :     $c = substr( $s, ++$ind, 1 );
2742 :     }
2743 :     $e *= $esign;
2744 :     $v *= 10**$e;
2745 :     }
2746 :    
2747 :     ( $ind, $v );
2748 :     }
2749 :    
2750 :    
2751 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2752 :     # ( $index, /@commentlist ) = getNextTreeChar( $string, $index )
2753 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2754 :     sub getNextTreeChar { # Move to next nonblank, noncomment character
2755 :     my ( $s, $ind ) = @_;
2756 :    
2757 :     my @clist = ();
2758 :    
2759 :     # Skip white space
2760 :     if ( substr( $s, $ind ) =~ /^(\s+)/ ) { $ind += length( $1 ) }
2761 :    
2762 :     # Loop while it is a comment:
2763 :     while ( substr( $s, $ind, 1 ) eq "[" ) {
2764 :     $ind++;
2765 :    
2766 :     # Find end
2767 :     if ( substr( $s, $ind ) !~ /^([^]]*)\]/ ) {
2768 :     treeParseError( "comment missing closing bracket '["
2769 :     . substr( $s, $ind ) . "'" )
2770 :     }
2771 :     my $comment = $1;
2772 :    
2773 :     # Save if it includes any "text"
2774 :     if ( $comment =~ m/\S/ ) { push @clist, $comment }
2775 :    
2776 :     $ind += length( $comment ) + 1; # Comment plus closing bracket
2777 :    
2778 :     # Skip white space
2779 :     if ( substr( $s, $ind ) =~ /^(\s+)/ ) { $ind += length( $1 ) }
2780 :     }
2781 :    
2782 :     ( $ind, @clist ? \@clist : undef )
2783 :     }
2784 :    
2785 :    
2786 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2787 :     # treeParseError( $message )
2788 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2789 :     sub treeParseError { die "Error: parse_newick_subtree: " . $_[0] . "\n" }
2790 :    
2791 :    
2792 :     #===============================================================================
2793 :     # Make a printer plot of a tree:
2794 :     #
2795 :     # $node newick tree root node
2796 : overbeek 1.4 # $file undef (= \*STDOUT), \*STDOUT, \*STDERR, or a file name.
2797 : golsen 1.1 # $width the approximate characters for the tree without labels
2798 :     # $min_dx the minimum horizontal branch length
2799 :     # $dy the vertical space per taxon
2800 :     #
2801 : overbeek 1.4 # printer_plot_newick( $node, $file (D=\*STDOUT), $width (D=68), $min_dx (D=2), $dy (D=1) )
2802 : golsen 1.1 #===============================================================================
2803 :     sub printer_plot_newick {
2804 :     my ( $node, $file, $width, $min_dx, $dy ) = @_;
2805 :    
2806 : overbeek 1.7 my ( $fh, $close ) = open_output( $file );
2807 :     $fh or return;
2808 : golsen 1.1
2809 :     print $fh join( "\n", text_plot_newick( $node, $width, $min_dx, $dy ) ), "\n";
2810 :     if ( $close ) { close $fh }
2811 :     }
2812 :    
2813 :    
2814 :     #===============================================================================
2815 :     # Make a text plot of a tree:
2816 :     #
2817 :     # $node newick tree root node
2818 :     # $width the approximate characters for the tree without labels
2819 :     # $min_dx the minimum horizontal branch length
2820 :     # $dy the vertical space per taxon
2821 :     #
2822 :     # @textlines = text_plot_newick( $node, $width (D=68), $min_dx (D=2), $dy (D=1) )
2823 :     #===============================================================================
2824 :     sub text_plot_newick {
2825 :     my ( $node, $width, $min_dx, $dy ) = @_;
2826 :     array_ref( $node ) || die "Bad node passed to text_plot_newick\n";
2827 :     defined( $min_dx ) and ( $min_dx >= 0 ) or $min_dx = 2;
2828 :     defined( $dy ) and ( $dy >= 1 ) or $dy = 1;
2829 :     defined( $width ) or $width = 68;
2830 :    
2831 :     $min_dx = int( $min_dx );
2832 :     $dy = int( $dy );
2833 : golsen 1.5 my $x_scale = $width / ( newick_max_X( $node ) || 1 ); # Div by zero caught by RAE
2834 : golsen 1.1
2835 :     my $hash = {};
2836 :     layout_printer_plot( $node, $hash, 0, -0.5 * $dy, $x_scale, $min_dx, $dy );
2837 :    
2838 :     # dump_tree_hash( $node, $hash ); exit;
2839 :    
2840 :     # Generate the lines of the tree one by one:
2841 :    
2842 :     my ( $y1, $y2 ) = @{ $hash->{ $node } };
2843 :     map { text_tree_row( $node, $hash, $_, "", "+" ) } ( $y1 .. $y2 );
2844 :     }
2845 :    
2846 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2847 :     # ( $xmax, $ymax, $root_y ) = layout_printer_plot( $node, $hash, $x0, $y0, $x_scale, $min_dx, $dy )
2848 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2849 :     sub layout_printer_plot {
2850 :     my ( $node, $hash, $x0, $y0, $x_scale, $min_dx, $dy ) = @_;
2851 :     array_ref( $node ) || die "Bad node ref passed to layout_printer_plot\n";
2852 :     hash_ref( $hash ) || die "Bad hash ref passed to layout_printer_plot\n";
2853 :    
2854 :     my $dx = newick_x( $node );
2855 :     if ( defined( $dx ) ) {
2856 :     $dx *= $x_scale;
2857 :     $dx >= $min_dx or $dx = $min_dx;
2858 :     }
2859 :     else {
2860 :     $dx = ( $x0 > 0 ) ? $min_dx : 0;
2861 :     }
2862 :     $dx = int( $dx + 0.4999 );
2863 :    
2864 :     my ( $x, $xmax, $y, $ymax, $y1, $y2, $yn1, $yn2 );
2865 :    
2866 :     $x = $x0 + $dx;
2867 :     $y1 = int( $y0 + 0.5 * $dy + 0.4999 );
2868 :     my @dl = newick_desc_list( $node );
2869 :    
2870 :     if ( ! @dl ) { # A tip
2871 :     $xmax = $x;
2872 :     $y = $yn1 = $yn2 = $y2 = $y1;
2873 :     $ymax = $y + 0.5 * $dy;
2874 :     }
2875 :    
2876 :     else { # A subtree
2877 :     $xmax = -1;
2878 :     my $xmaxi;
2879 :     my $yi;
2880 :     my @ylist = ();
2881 :     $ymax = $y0;
2882 :    
2883 :     foreach ( @dl ) {
2884 :     ( $xmaxi, $ymax, $yi ) = layout_printer_plot( $_, $hash, $x, $ymax, $x_scale, $min_dx, $dy );
2885 :     push @ylist, $yi;
2886 :     if ( $xmaxi > $xmax ) { $xmax = $xmaxi }
2887 :     }
2888 :    
2889 :     # Use of y-list is overkill for saving first and last values,
2890 :     # but eases implimentation of alternative y-value calculations.
2891 :    
2892 :     $yn1 = $ylist[ 0];
2893 :     $yn2 = $ylist[-1];
2894 :     $y = int( 0.5 * ( $yn1 + $yn2 ) + 0.4999 );
2895 :     }
2896 :    
2897 :     $y2 = int( $ymax - 0.5 * $dy + 0.4999 );
2898 :    
2899 :     $hash->{ $node } = [ $y1, $y2, $x0, $x, $y, $yn1, $yn2 ];
2900 :     ( $xmax, $ymax, $y );
2901 :     }
2902 :    
2903 :    
2904 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2905 :     # Debug routine
2906 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2907 :     sub dump_tree {
2908 :     my ( $node, $prefix ) = @_;
2909 :     defined( $prefix ) or $prefix = "";
2910 :     print STDERR $prefix, join(", ", @$node), "\n";
2911 :     my @dl = $node->[0] ? @{$node->[0]} : ();
2912 :     foreach ( @dl ) { dump_tree( $_, $prefix . " " ) }
2913 :     $prefix or print STDERR "\n";
2914 :     }
2915 :    
2916 :    
2917 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2918 :     # Debug routine
2919 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2920 :     sub dump_tree_hash {
2921 :     my ( $node, $hash, $prefix ) = @_;
2922 :     defined( $prefix ) or print STDERR "node; [ y1, y2, x0, x, y, yn1, yn2 ]\n" and $prefix = "";
2923 :     print STDERR $prefix, join(", ", @$node), "; ", join(", ", @{ $hash->{ $node } } ), "\n";
2924 :     my @dl = $node->[0] ? @{$node->[0]} : ();
2925 :     foreach (@dl) { dump_tree_hash( $_, $hash, $prefix . " " ) }
2926 :     }
2927 :    
2928 :    
2929 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2930 :     # $line = text_tree_row( $node, $hash, $row, $line, $symb )
2931 :     #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2932 :     sub text_tree_row {
2933 :     my ( $node, $hash, $row, $line, $symb ) = @_;
2934 :    
2935 :     my ( $y1, $y2, $x0, $x, $y, $yn1, $yn2 ) = @{ $hash->{ $node } };
2936 :     if ( $row < $y1 || $row > $y2 ) { return $line }
2937 :    
2938 :     if ( length( $line ) < $x0 ) { $line .= " " x ( $x0 - length( $line ) ) }
2939 :    
2940 :     if ( $row == $y ) {
2941 :     $line = substr( $line, 0, $x0 ) . $symb . (( $x > $x0 ) ? "-" x ($x - $x0) : "");
2942 :     }
2943 :    
2944 :     elsif ( $row > $yn1 && $row < $yn2 ) {
2945 :     if ( length( $line ) < $x ) { $line .= " " x ( $x - length( $line ) ) . "|" }
2946 :     else { substr( $line, $x ) = "|" }
2947 :     }
2948 :    
2949 :     my @dl = newick_desc_list( $node );
2950 :    
2951 :     if ( @dl < 1 ) {
2952 :     $line .= " " . $node->[1];
2953 :     }
2954 :    
2955 :     else {
2956 :     my @list = map { [ $_, "+" ] } @dl; # Print symbol for line
2957 :     $list[ 0]->[1] = "/";
2958 :     $list[-1]->[1] = "\\";
2959 :    
2960 :     foreach ( @list ) {
2961 :     my ( $n, $s ) = @$_;
2962 :     if ( $row >= $hash->{ $n }->[0] && $row <= $hash->{ $n }->[1] ) {
2963 :     $line = text_tree_row( $n, $hash, $row, $line, $s );
2964 :     }
2965 :     }
2966 :    
2967 :     if ( $row == $y ) { substr( $line, $x, 1 ) = "+" }
2968 :     }
2969 :    
2970 :     return $line;
2971 :     }
2972 :    
2973 :    
2974 : overbeek 1.7 #===============================================================================
2975 :     # Open an input file stream:
2976 :     #
2977 :     # ( $handle, undef ) = open_input( ); # \*STDIN
2978 :     # ( $handle, undef ) = open_input( \*FH );
2979 :     # ( $handle, 1 ) = open_input( $file ); # need to close $handle
2980 :     #
2981 :     #===============================================================================
2982 :     sub open_input
2983 :     {
2984 :     my $file = shift;
2985 :     my $fh;
2986 :     if ( ! defined( $file ) ) { return ( \*STDIN ) }
2987 :     elsif ( ref( $file ) eq 'GLOB' ) { return ( $file ) }
2988 :     elsif ( open( $fh, "<$file" ) ) { return ( $fh, 1 ) } # Need to close
2989 :    
2990 :     print STDERR "gjonewick::open_input could not open '$file' for reading\n";
2991 :     return undef;
2992 :     }
2993 :    
2994 :    
2995 :     #===============================================================================
2996 :     # Open an output file stream:
2997 :     #
2998 :     # ( $handle, undef ) = open_output( ); # \*STDOUT
2999 :     # ( $handle, undef ) = open_output( \*FH );
3000 :     # ( $handle, 1 ) = open_output( $file ); # need to close $handle
3001 :     #
3002 :     #===============================================================================
3003 :     sub open_output
3004 :     {
3005 :     my $file = shift;
3006 :     my $fh;
3007 :     if ( ! defined( $file ) ) { return ( \*STDOUT ) }
3008 :     elsif ( ref( $file ) eq 'GLOB' ) { return ( $file ) }
3009 :     elsif ( ( open $fh, ">$file" ) ) { return ( $fh, 1 ) } # Need to close
3010 :    
3011 :     print STDERR "gjonewick::open_output could not open '$file' for writing\n";
3012 :     return undef;
3013 :     }
3014 :    
3015 : golsen 1.1 1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3