fix graphml subgraph generation; fix tab parsing to only set 'collated' where needed...
[scpubgit/stemmatology.git] / lib / Text / Tradition / Collation / RelationshipStore.pm
index 55d6943..314d003 100644 (file)
@@ -37,7 +37,7 @@ my $t = Text::Tradition->new(
     );
 my $c = $t->collation;
 
-my @v1 = $c->add_relationship( 'n21', 'n22', { 'type' => 'meaning' } );
+my @v1 = $c->add_relationship( 'n21', 'n22', { 'type' => 'lexical' } );
 is( scalar @v1, 1, "Added a single relationship" );
 is( $v1[0]->[0], 'n21', "Got correct node 1" );
 is( $v1[0]->[1], 'n22', "Got correct node 2" );
@@ -202,13 +202,109 @@ scoped non-locally.
 Returns a status boolean and a list of all reading pairs connected by the call to
 add_relationship.
 
+=begin testing
+
+use Text::Tradition;
+use TryCatch;
+
+my $t1 = Text::Tradition->new( 'input' => 'Self', 'file' => 't/data/legendfrag.xml' );
+# Test 1: try to equate nodes that are prevented with an intermediate collation
+ok( $t1, "Parsed test fragment file" );
+my $c1 = $t1->collation;
+my $trel = $c1->get_relationship( '9,2', '9,3' );
+is( ref( $trel ), 'Text::Tradition::Collation::Relationship',
+       "Troublesome relationship exists" );
+is( $trel->type, 'collated', "Troublesome relationship is a collation" );
+
+# Try to make the link we want
+try {
+       $c1->add_relationship( '8,6', '10,3', { 'type' => 'orthographic' } );
+       ok( 1, "Added cross-collation relationship as expected" );
+} catch {
+       ok( 0, "Existing collation blocked equivalence relationship" );
+}
+
+try {
+       $c1->calculate_ranks();
+       ok( 1, "Successfully calculated ranks" );
+} catch {
+       ok( 0, "Collation now has a cycle" );
+}
+
+# Test 2: try to equate nodes that are prevented with a real intermediate
+# equivalence
+my $t2 = Text::Tradition->new( 'input' => 'Self', 'file' => 't/data/legendfrag.xml' );
+my $c2 = $t2->collation;
+$c2->add_relationship( '9,2', '9,3', { 'type' => 'lexical' } );
+my $trel2 = $c2->get_relationship( '9,2', '9,3' );
+is( ref( $trel2 ), 'Text::Tradition::Collation::Relationship',
+       "Created blocking relationship" );
+is( $trel2->type, 'lexical', "Blocking relationship is not a collation" );
+# This time the link ought to fail
+try {
+       $c2->add_relationship( '8,6', '10,3', { 'type' => 'orthographic' } );
+       ok( 0, "Added cross-equivalent bad relationship" );
+} catch {
+       ok( 1, "Existing equivalence blocked crossing relationship" );
+}
+
+try {
+       $c2->calculate_ranks();
+       ok( 1, "Successfully calculated ranks" );
+} catch {
+       ok( 0, "Collation now has a cycle" );
+}
+
+# Test 3: make a straightforward pair of transpositions.
+my $t3 = Text::Tradition->new( 'input' => 'Self', 'file' => 't/data/lf2.xml' );
+# Test 1: try to equate nodes that are prevented with an intermediate collation
+my $c3 = $t3->collation;
+try {
+       $c3->add_relationship( '36,4', '38,3', { 'type' => 'transposition' } );
+       ok( 1, "Added straightforward transposition" );
+} catch {
+       ok( 0, "Failed to add normal transposition" );
+}
+try {
+       $c3->add_relationship( '36,3', '38,2', { 'type' => 'transposition' } );
+       ok( 1, "Added straightforward transposition complement" );
+} catch {
+       ok( 0, "Failed to add normal transposition complement" );
+}
+
+# Test 4: try to make a transposition that could be a parallel.
+try {
+       $c3->add_relationship( '28,2', '29,2', { 'type' => 'transposition' } );
+       ok( 0, "Added bad colocated transposition" );
+} catch {
+       ok( 1, "Prevented bad colocated transposition" );
+}
+
+# Test 5: make the parallel, and then make the transposition again.
+try {
+       $c3->add_relationship( '28,3', '29,3', { 'type' => 'orthographic' } );
+       ok( 1, "Equated identical readings for transposition" );
+} catch {
+       ok( 0, "Failed to equate identical readings" );
+}
+try {
+       $c3->add_relationship( '28,2', '29,2', { 'type' => 'transposition' } );
+       ok( 1, "Added straightforward transposition complement" );
+} catch {
+       ok( 0, "Failed to add normal transposition complement" );
+}
+
+=end testing
+
 =cut
 
 sub add_relationship {
-       my( $self, $source, $source_rdg, $target, $target_rdg, $options ) = @_;
+       my( $self, $source, $target, $options ) = @_;
+    my $c = $self->collation;
 
        my $relationship;
        my $thispaironly;
+       my $droppedcolls = [];
        if( ref( $options ) eq 'Text::Tradition::Collation::Relationship' ) {
                $relationship = $options;
                $thispaironly = 1;  # If existing rel, set only where asked.
@@ -216,16 +312,17 @@ sub add_relationship {
                # Check the options
                $options->{'scope'} = 'local' unless $options->{'scope'};
                $options->{'scope'} = 'local' if $options->{'type'} eq 'collated';
+               $options->{'scope'} = 'local' if $options->{'type'} eq 'transposition';
                
-               my( $is_valid, $reason ) = 
-                       $self->relationship_valid( $source, $target, $options->{'type'} );
+               my( $is_valid, $reason ) = $self->relationship_valid( $source, $target, 
+                       $options->{'type'}, $droppedcolls );
                unless( $is_valid ) {
                        throw( "Invalid relationship: $reason" );
                }
                
                # Try to create the relationship object.
-               $options->{'reading_a'} = $source_rdg->text;
-               $options->{'reading_b'} = $target_rdg->text;
+               $options->{'reading_a'} = $c->reading( $source )->text;
+               $options->{'reading_b'} = $c->reading( $target )->text;
                $options->{'orig_a'} = $source;
                $options->{'orig_b'} = $target;
        if( $options->{'scope'} ne 'local' ) {
@@ -247,31 +344,59 @@ sub add_relationship {
 
 
        # Find all the pairs for which we need to set the relationship.
-       my @vectors = [ $source, $target ];
+       my @vectors;
     if( $relationship->colocated && $relationship->nonlocal && !$thispaironly ) {
        push( @vectors, $self->_find_applicable( $relationship ) );
     }
         
     # Now set the relationship(s).
     my @pairs_set;
+       my $rel = $self->get_relationship( $source, $target );
+       my $skip;
+       if( $rel && $rel ne $relationship ) {
+               if( $rel->nonlocal ) {
+                       throw( "Found conflicting relationship at $source - $target" );
+               } elsif( $rel->type ne 'collated' ) {
+                       # Replace a collation relationship; leave any other sort in place.
+                       my $r1ann = $rel->has_annotation ? $rel->annotation : '';
+                       my $r2ann = $relationship->has_annotation ? $relationship->annotation : '';
+                       unless( $rel->type eq $relationship->type && $r1ann eq $r2ann ) {
+                               warn sprintf( "Not overriding local relationship %s with global %s " 
+                                       . "set at %s -> %s (%s -> %s)", $rel->type, $relationship->type,
+                                       $source, $target, $rel->reading_a, $rel->reading_b );
+                               $skip = 1;
+                       }
+               }
+       }
+       $self->_set_relationship( $relationship, $source, $target ) unless $skip;
+       push( @pairs_set, [ $source, $target ] );
+    
+    # Set any additional relationships that might be in @vectors.
     foreach my $v ( @vectors ) {
-               my $rel = $self->get_relationship( @$v );
-       if( $rel && $rel ne $relationship ) {
-               if( $rel->nonlocal ) {
-                       throw( "Found conflicting relationship at @$v" );
-               } elsif( $rel->type ne 'collated' ) {
-                       # Replace a collation relationship; leave any other sort in place.
-                       warn "Not overriding local relationship set at @$v";
-                               next;
-               }
-       }
-       $self->_set_relationship( $relationship, @$v );
-       push( @pairs_set, $v );
+       next if $v->[0] eq $source && $v->[1] eq $target;
+       next if $v->[1] eq $source && $v->[0] eq $target;
+       my @added = $self->add_relationship( @$v, $relationship );
+       push( @pairs_set, @added );
     }
     
+    # Finally, restore whatever collations we can, and return.
+    $self->_restore_collations( @$droppedcolls );
     return @pairs_set;
 }
 
+=head2 del_scoped_relationship( $reading_a, $reading_b )
+
+Returns the general (document-level or global) relationship that has been defined 
+between the two reading strings. Returns undef if there is no general relationship.
+
+=cut
+
+sub del_scoped_relationship {
+       my( $self, $rdga, $rdgb ) = @_;
+       my( $first, $second ) = sort( $rdga, $rdgb );
+       return delete $self->scopedrels->{$first}->{$second};
+}
+
 sub _find_applicable {
        my( $self, $rel ) = @_;
        my $c = $self->collation;
@@ -328,12 +453,14 @@ sub del_relationship {
        $self->_remove_relationship( $source, $target );
        if( $rel->nonlocal ) {
                # Remove the relationship wherever it occurs.
+               # Remove the relationship wherever it occurs.
                my @rel_edges = grep { $self->get_relationship( @$_ ) == $rel }
                        $self->relationships;
                foreach my $re ( @rel_edges ) {
                        $self->_remove_relationship( @$re );
                        push( @vectors, $re );
                }
+               $self->del_scoped_relationship( $rel->reading_a, $rel->reading_b );
        }
        return @vectors;
 }
@@ -352,7 +479,8 @@ a yes/no boolean and, if the answer is no, message gives the reason why.
 =cut
 
 sub relationship_valid {
-    my( $self, $source, $target, $rel ) = @_;
+    my( $self, $source, $target, $rel, $mustdrop ) = @_;
+    $mustdrop = [] unless $mustdrop; # in case we were passed nothing
     my $c = $self->collation;
     if ( $rel eq 'transposition' || $rel eq 'repetition' ) {
                # Check that the two readings do (for a repetition) or do not (for
@@ -365,45 +493,62 @@ sub relationship_valid {
                                return ( 0, "Readings both occur in witness $w" ) 
                                        if $rel eq 'transposition';
                                return ( 1, "ok" ) if $rel eq 'repetition';
+                       }
                }
-               return $rel eq 'transposition' ? ( 1, "ok" )
-                       : ( 0, "Readings occur only in distinct witnesses" );
+               return ( 0, "Readings occur only in distinct witnesses" )
+                       if $rel eq 'repetition';
+       } 
+       if ( $rel eq 'transposition' ) {
+               # We also need to check both that the readings occur in distinct
+               # witnesses, and that they are not in the same place. That is,
+               # proposing to link them should cause a witness loop.
+               my $map = {};
+               my( $startrank, $endrank );
+               if( $c->end->has_rank ) {
+                       my $cpred = $c->common_predecessor( $source, $target );
+                       my $csucc = $c->common_successor( $source, $target );
+                       $startrank = $cpred->rank;
+                       $endrank = $csucc->rank;
                }
-       } else {
-               # Check that linking the source and target in a relationship won't lead
-               # to a path loop for any witness.  If they have the same rank then fine.
-               return( 1, "ok" ) 
-                       if $c->reading( $source )->has_rank
-                               && $c->reading( $target )->has_rank
-                               && $c->reading( $source )->rank == $c->reading( $target )->rank;
-               
-               # Otherwise, first make a lookup table of all the
-               # readings related to either the source or the target.
-               my @proposed_related = ( $source, $target );
-               # Drop the collation links of source and target, unless we want to
-               # add a collation relationship.
-               foreach my $r ( ( $source, $target ) ) {
-                       $self->_drop_collations( $r ) unless $rel eq 'collated';
-                       push( @proposed_related, $self->related_readings( $r, 'colocated' ) );
+               my $eqgraph = $c->equivalence_graph( $map, $startrank, $endrank, 
+                       $source, $target );
+               if( $eqgraph->has_a_cycle ) {
+                       return ( 1, "ok" );
+               } else {
+                       return ( 0, "Readings appear to be colocated, not transposed" );
                }
-               my %pr_ids;
-               map { $pr_ids{ $_ } = 1 } @proposed_related;
-       
-               # The cumulative predecessors and successors of the proposed-related readings
-               # should not overlap.
-               my %all_pred;
-               my %all_succ;
-               foreach my $pr ( keys %pr_ids ) {
-                       map { $all_pred{$_} = 1 } $c->sequence->all_predecessors( $pr );
-                       map { $all_succ{$_} = 1 } $c->sequence->all_successors( $pr );
+               
+       } elsif( $rel ne 'repetition' ) {
+               # Check that linking the source and target in a relationship won't lead
+               # to a path loop for any witness. 
+               # First, drop/stash any collations that might interfere
+               my $sourceobj = $c->reading( $source );
+               my $targetobj = $c->reading( $target );
+               my $sourcerank = $sourceobj->has_rank ? $sourceobj->rank : -1;
+               my $targetrank = $targetobj->has_rank ? $targetobj->rank : -1;
+               unless( $rel eq 'collated' || $sourcerank == $targetrank ) {
+                       push( @$mustdrop, $self->_drop_collations( $source ) );
+                       push( @$mustdrop, $self->_drop_collations( $target ) );
                }
-               foreach my $k ( keys %all_pred ) {
-                       return( 0, "Relationship would create witness loop" )
-                               if exists $all_succ{$k};
+               my $map = {};
+               my( $startrank, $endrank );
+               if( $c->end->has_rank ) {
+                       my $cpred = $c->common_predecessor( $source, $target );
+                       my $csucc = $c->common_successor( $source, $target );
+                       $startrank = $cpred->rank;
+                       $endrank = $csucc->rank;
+                       unless( $rel eq 'collated' || $sourcerank == $targetrank ) {
+                               foreach my $rk ( $startrank+1 .. $endrank-1 ) {
+                                       map { push( @$mustdrop, $self->_drop_collations( $_->id ) ) }
+                                               $c->readings_at_rank( $rk );
+                               }
+                       }
                }
-               foreach my $k ( keys %pr_ids ) {
-                       return( 0, "Relationship would create witness loop" )
-                               if exists $all_pred{$k} || exists $all_succ{$k};
+               my $eqgraph = $c->equivalence_graph( $map, $startrank, $endrank, 
+                       $source, $target );
+               if( $eqgraph->has_a_cycle ) {
+                       $self->_restore_collations( @$mustdrop );
+                       return( 0, "Relationship would create witness loop" );
                }
                return ( 1, "ok" );
        }
@@ -411,11 +556,58 @@ sub relationship_valid {
 
 sub _drop_collations {
        my( $self, $reading ) = @_;
+       my @dropped;
        foreach my $n ( $self->graph->neighbors( $reading ) ) {
                if( $self->get_relationship( $reading, $n )->type eq 'collated' ) {
+                       push( @dropped, [ $reading, $n ] );
                        $self->del_relationship( $reading, $n );
                }
        }
+       return @dropped;
+}
+
+sub _restore_collations {
+       my( $self, @vectors ) = @_;
+       foreach my $v ( @vectors ) {
+               try {
+                       $self->add_relationship( @$v, { 'type' => 'collated' } );
+               } catch {
+                       print STDERR $v->[0] . " - " . $v->[1] . " no longer collate\n";
+               }
+       }
+}
+
+=head2 filter_collations()
+
+Utility function. Removes any redundant 'collated' relationships from the graph.
+A collated relationship is redundant if the readings in question would occupy
+the same rank regardless of the existence of the relationship.
+
+=cut
+
+sub filter_collations {
+       my $self = shift;
+       my $c = $self->collation;
+       foreach my $r ( 1 .. $c->end->rank - 1 ) {
+               my $anchor;
+               my @need_collations;
+               foreach my $rdg ( $c->readings_at_rank( $r ) ) {
+                       next if $rdg->is_meta;
+                       my $ip = 0;
+                       foreach my $pred ( $rdg->predecessors ) {
+                               if( $pred->rank == $r - 1 ) {
+                                       $ip = 1;
+                                       $anchor = $rdg unless( $anchor );
+                                       last;
+                               }
+                       }
+                       push( @need_collations, $rdg ) unless $ip;
+                       $c->relations->_drop_collations( "$rdg" );
+               }
+               $anchor
+                       ? map { $c->add_relationship( $anchor, $_, { 'type' => 'collated' } ) } @need_collations
+                       : warn "No anchor found at $r";
+       }
 }
 
 =head2 related_readings( $reading, $filter )
@@ -503,23 +695,27 @@ sub _as_graphml {
        $rgraph->setAttribute( 'edgedefault', 'directed' );
     $rgraph->setAttribute( 'id', 'relationships', );
     $rgraph->setAttribute( 'parse.edgeids', 'canonical' );
-    $rgraph->setAttribute( 'parse.edges', scalar($self->graph->edges) );
+    $rgraph->setAttribute( 'parse.edges', 0 );
     $rgraph->setAttribute( 'parse.nodeids', 'canonical' );
-    $rgraph->setAttribute( 'parse.nodes', scalar($self->graph->vertices) );
+    $rgraph->setAttribute( 'parse.nodes', 0 );
     $rgraph->setAttribute( 'parse.order', 'nodesfirst' );
     
     # Add the vertices according to their XML IDs
     my %rdg_lookup = ( reverse %$node_hash );
-    foreach my $n ( sort _by_xmlid keys( %rdg_lookup ) ) {
+    # my @nlist = sort _by_xmlid keys( %rdg_lookup ); ## CAUSES SEGFAULT
+    my @nlist = sort keys( %rdg_lookup );
+    foreach my $n ( @nlist ) {
        my $n_el = $rgraph->addNewChild( $graphml_ns, 'node' );
        $n_el->setAttribute( 'id', $n );
        _add_graphml_data( $n_el, $nodeid_key, $rdg_lookup{$n} );
     }
+       $rgraph->setAttribute( 'parse.nodes', scalar @nlist );
     
     # Add the relationship edges, with their object information
     my $edge_ctr = 0;
     foreach my $e ( sort { $a->[0] cmp $b->[0] } $self->graph->edges ) {
        # Add an edge and fill in its relationship info.
+       next unless( exists $node_hash->{$e->[0]} && exists $node_hash->{$e->[1]} );
                my $edge_el = $rgraph->addNewChild( $graphml_ns, 'edge' );
                $edge_el->setAttribute( 'source', $node_hash->{$e->[0]} );
                $edge_el->setAttribute( 'target', $node_hash->{$e->[1]} );
@@ -532,6 +728,7 @@ sub _as_graphml {
                                if defined $value;
                }
        }
+       $rgraph->setAttribute( 'parse.edges', $edge_ctr );
 }
 
 sub _by_xmlid {