Commit | Line | Data |
22222af9 |
1 | package Text::Tradition::Collation::RelationshipStore; |
2 | |
3 | use strict; |
4 | use warnings; |
63778331 |
5 | use Text::Tradition::Error; |
22222af9 |
6 | use Text::Tradition::Collation::Relationship; |
a1615ee4 |
7 | use TryCatch; |
22222af9 |
8 | |
9 | use Moose; |
10 | |
11 | =head1 NAME |
12 | |
2626f709 |
13 | Text::Tradition::Collation::RelationshipStore - Keeps track of the relationships |
14 | between readings in a given collation |
22222af9 |
15 | |
16 | =head1 DESCRIPTION |
17 | |
18 | Text::Tradition is a library for representation and analysis of collated |
19 | texts, particularly medieval ones. The RelationshipStore is an internal object |
20 | of the collation, to keep track of the defined relationships (both specific and |
21 | general) between readings. |
22 | |
3ae5e2ad |
23 | =begin testing |
24 | |
25 | use Text::Tradition; |
ee801e17 |
26 | use TryCatch; |
3ae5e2ad |
27 | |
28 | use_ok( 'Text::Tradition::Collation::RelationshipStore' ); |
29 | |
ee801e17 |
30 | # Add some relationships, and delete them |
31 | |
32 | my $cxfile = 't/data/Collatex-16.xml'; |
33 | my $t = Text::Tradition->new( |
56772e8c |
34 | 'name' => 'inline', |
35 | 'input' => 'CollateX', |
36 | 'file' => $cxfile, |
37 | ); |
ee801e17 |
38 | my $c = $t->collation; |
39 | |
f8331a4d |
40 | my @v1 = $c->add_relationship( 'n21', 'n22', { 'type' => 'lexical' } ); |
ee801e17 |
41 | is( scalar @v1, 1, "Added a single relationship" ); |
42 | is( $v1[0]->[0], 'n21', "Got correct node 1" ); |
43 | is( $v1[0]->[1], 'n22', "Got correct node 2" ); |
679f17e1 |
44 | my @v2 = $c->add_relationship( 'n24', 'n23', |
ee801e17 |
45 | { 'type' => 'spelling', 'scope' => 'global' } ); |
46 | is( scalar @v2, 2, "Added a global relationship with two instances" ); |
47 | @v1 = $c->del_relationship( 'n22', 'n21' ); |
48 | is( scalar @v1, 1, "Deleted first relationship" ); |
679f17e1 |
49 | @v2 = $c->del_relationship( 'n12', 'n13' ); |
ee801e17 |
50 | is( scalar @v2, 2, "Deleted second global relationship" ); |
681893aa |
51 | my @v3 = $c->del_relationship( 'n1', 'n2' ); |
52 | is( scalar @v3, 0, "Nothing deleted on non-existent relationship" ); |
ee801e17 |
53 | |
3ae5e2ad |
54 | =end testing |
55 | |
22222af9 |
56 | =head1 METHODS |
57 | |
58 | =head2 new( collation => $collation ); |
59 | |
60 | Creates a new relationship store for the given collation. |
61 | |
62 | =cut |
63 | |
64 | has 'collation' => ( |
65 | is => 'ro', |
66 | isa => 'Text::Tradition::Collation', |
67 | required => 1, |
68 | weak_ref => 1, |
69 | ); |
70 | |
71 | has 'scopedrels' => ( |
72 | is => 'ro', |
73 | isa => 'HashRef[HashRef[Text::Tradition::Collation::Relationship]]', |
74 | default => sub { {} }, |
75 | ); |
76 | |
77 | has 'graph' => ( |
78 | is => 'ro', |
79 | isa => 'Graph', |
80 | default => sub { Graph->new( undirected => 1 ) }, |
81 | handles => { |
82 | relationships => 'edges', |
83 | add_reading => 'add_vertex', |
84 | delete_reading => 'delete_vertex', |
85 | }, |
86 | ); |
87 | |
359944f7 |
88 | =head2 equivalence_graph() |
89 | |
90 | Returns an equivalence graph of the collation, in which all readings |
91 | related via a 'colocated' relationship are transformed into a single |
92 | vertex. Can be used to determine the validity of a new relationship. |
93 | |
94 | =cut |
95 | |
96 | has 'equivalence_graph' => ( |
97 | is => 'ro', |
98 | isa => 'Graph', |
99 | default => sub { Graph->new() }, |
e1083e99 |
100 | writer => '_reset_equivalence', |
359944f7 |
101 | ); |
102 | |
103 | has '_node_equivalences' => ( |
104 | is => 'ro', |
105 | traits => ['Hash'], |
106 | handles => { |
107 | equivalence => 'get', |
108 | set_equivalence => 'set', |
109 | remove_equivalence => 'delete', |
04482188 |
110 | _clear_equivalence => 'clear', |
359944f7 |
111 | }, |
112 | ); |
113 | |
114 | has '_equivalence_readings' => ( |
115 | is => 'ro', |
116 | traits => ['Hash'], |
117 | handles => { |
118 | eqreadings => 'get', |
119 | set_eqreadings => 'set', |
120 | remove_eqreadings => 'delete', |
04482188 |
121 | _clear_eqreadings => 'clear', |
359944f7 |
122 | }, |
123 | ); |
124 | |
125 | around add_reading => sub { |
126 | my $orig = shift; |
127 | my $self = shift; |
128 | |
129 | $self->equivalence_graph->add_vertex( @_ ); |
130 | $self->set_equivalence( $_[0], $_[0] ); |
131 | $self->set_eqreadings( $_[0], [ $_[0] ] ); |
132 | $self->$orig( @_ ); |
133 | }; |
134 | |
135 | around delete_reading => sub { |
136 | my $orig = shift; |
137 | my $self = shift; |
138 | |
359944f7 |
139 | $self->_remove_equivalence_node( @_ ); |
140 | $self->$orig( @_ ); |
141 | }; |
142 | |
3ae5e2ad |
143 | =head2 get_relationship |
144 | |
145 | Return the relationship object, if any, that exists between two readings. |
146 | |
147 | =cut |
148 | |
149 | sub get_relationship { |
4633f9e4 |
150 | my $self = shift; |
151 | my @vector; |
152 | if( @_ == 1 && ref( $_[0] ) eq 'ARRAY' ) { |
153 | # Dereference the edge arrayref that was passed. |
154 | my $edge = shift; |
155 | @vector = @$edge; |
156 | } else { |
157 | @vector = @_; |
158 | } |
3ae5e2ad |
159 | my $relationship; |
160 | if( $self->graph->has_edge_attribute( @vector, 'object' ) ) { |
161 | $relationship = $self->graph->get_edge_attribute( @vector, 'object' ); |
ca6e6095 |
162 | } |
3ae5e2ad |
163 | return $relationship; |
164 | } |
165 | |
166 | sub _set_relationship { |
167 | my( $self, $relationship, @vector ) = @_; |
168 | $self->graph->add_edge( @vector ); |
169 | $self->graph->set_edge_attribute( @vector, 'object', $relationship ); |
176badfe |
170 | $self->_make_equivalence( @vector ) if $relationship->colocated; |
3ae5e2ad |
171 | } |
a1615ee4 |
172 | |
22222af9 |
173 | =head2 create |
174 | |
175 | Create a new relationship with the given options and return it. |
176 | Warn and return undef if the relationship cannot be created. |
177 | |
178 | =cut |
179 | |
180 | sub create { |
181 | my( $self, $options ) = @_; |
182 | # Check to see if a relationship exists between the two given readings |
183 | my $source = delete $options->{'orig_a'}; |
184 | my $target = delete $options->{'orig_b'}; |
3ae5e2ad |
185 | my $rel = $self->get_relationship( $source, $target ); |
186 | if( $rel ) { |
3d14b48e |
187 | if( $rel->type eq 'collated' ) { |
188 | # Always replace a 'collated' relationship with a more descriptive |
189 | # one, if asked. |
190 | $self->del_relationship( $source, $target ); |
191 | } elsif( $rel->type ne $options->{'type'} ) { |
63778331 |
192 | throw( "Another relationship of type " . $rel->type |
193 | . " already exists between $source and $target" ); |
22222af9 |
194 | } else { |
195 | return $rel; |
196 | } |
197 | } |
198 | |
99ab9535 |
199 | $rel = Text::Tradition::Collation::Relationship->new( $options ); |
200 | $self->add_scoped_relationship( $rel ) if $rel->nonlocal; |
201 | return $rel; |
22222af9 |
202 | } |
203 | |
204 | =head2 add_scoped_relationship( $rel ) |
205 | |
206 | Keep track of relationships defined between specific readings that are scoped |
207 | non-locally. Key on whichever reading occurs first alphabetically. |
208 | |
209 | =cut |
210 | |
211 | sub add_scoped_relationship { |
212 | my( $self, $rel ) = @_; |
f222800e |
213 | my $rdga = $rel->type eq 'orthographic' ? $rel->reading_a : lc( $rel->reading_a ); |
214 | my $rdgb = $rel->type eq 'orthographic' ? $rel->reading_b : lc( $rel->reading_b ); |
215 | my $r = $self->scoped_relationship( $rdga, $rdgb ); |
22222af9 |
216 | if( $r ) { |
217 | warn sprintf( "Scoped relationship of type %s already exists between %s and %s", |
f222800e |
218 | $r->type, $rdga, $rdgb ); |
22222af9 |
219 | return; |
220 | } |
f222800e |
221 | my( $first, $second ) = sort ( $rdga, $rdgb ); |
222 | $self->scopedrels->{$first}->{$second} = $rel; |
22222af9 |
223 | } |
224 | |
225 | =head2 scoped_relationship( $reading_a, $reading_b ) |
226 | |
227 | Returns the general (document-level or global) relationship that has been defined |
228 | between the two reading strings. Returns undef if there is no general relationship. |
229 | |
230 | =cut |
231 | |
232 | sub scoped_relationship { |
233 | my( $self, $rdga, $rdgb ) = @_; |
234 | my( $first, $second ) = sort( $rdga, $rdgb ); |
428bcf0b |
235 | my( $lcfirst, $lcsecond ) = sort( lc( $rdga ), lc( $rdgb ) ); |
22222af9 |
236 | if( exists $self->scopedrels->{$first}->{$second} ) { |
237 | return $self->scopedrels->{$first}->{$second}; |
428bcf0b |
238 | } elsif( exists $self->scopedrels->{$lcfirst}->{$lcsecond} ) { |
239 | my $rel = $self->scopedrels->{$lcfirst}->{$lcsecond}; |
240 | return $rel->type ne 'orthographic' ? $rel : undef; |
22222af9 |
241 | } else { |
242 | return undef; |
243 | } |
244 | } |
245 | |
246 | =head2 add_relationship( $self, $source, $sourcetext, $target, $targettext, $opts ) |
247 | |
248 | Adds the relationship specified in $opts (see Text::Tradition::Collation::Relationship |
249 | for the possible options) between the readings given in $source and $target. Sets |
250 | up a scoped relationship between $sourcetext and $targettext if the relationship is |
251 | scoped non-locally. |
252 | |
253 | Returns a status boolean and a list of all reading pairs connected by the call to |
254 | add_relationship. |
255 | |
6d381462 |
256 | =begin testing |
257 | |
56772e8c |
258 | use Test::Warn; |
6d381462 |
259 | use Text::Tradition; |
260 | use TryCatch; |
261 | |
56772e8c |
262 | my $t1; |
e92d4229 |
263 | warnings_exist { |
56772e8c |
264 | $t1 = Text::Tradition->new( 'input' => 'Self', 'file' => 't/data/legendfrag.xml' ); |
e92d4229 |
265 | } [qr/Cannot set relationship on a meta reading/], |
56772e8c |
266 | "Got expected relationship drop warning on parse"; |
267 | |
176badfe |
268 | # Test 1.1: try to equate nodes that are prevented with an intermediate collation |
6d381462 |
269 | ok( $t1, "Parsed test fragment file" ); |
270 | my $c1 = $t1->collation; |
10e4b1ac |
271 | my $trel = $c1->get_relationship( 'r9.2', 'r9.3' ); |
6d381462 |
272 | is( ref( $trel ), 'Text::Tradition::Collation::Relationship', |
273 | "Troublesome relationship exists" ); |
274 | is( $trel->type, 'collated', "Troublesome relationship is a collation" ); |
275 | |
276 | # Try to make the link we want |
277 | try { |
10e4b1ac |
278 | $c1->add_relationship( 'r8.6', 'r10.3', { 'type' => 'orthographic' } ); |
6d381462 |
279 | ok( 1, "Added cross-collation relationship as expected" ); |
176badfe |
280 | } catch( Text::Tradition::Error $e ) { |
281 | ok( 0, "Existing collation blocked equivalence relationship: " . $e->message ); |
6d381462 |
282 | } |
283 | |
284 | try { |
285 | $c1->calculate_ranks(); |
286 | ok( 1, "Successfully calculated ranks" ); |
176badfe |
287 | } catch ( Text::Tradition::Error $e ) { |
288 | ok( 0, "Collation now has a cycle: " . $e->message ); |
6d381462 |
289 | } |
290 | |
176badfe |
291 | # Test 1.2: attempt merge of an identical reading |
359944f7 |
292 | try { |
10e4b1ac |
293 | $c1->merge_readings( 'r9.3', 'r11.5' ); |
359944f7 |
294 | ok( 1, "Successfully merged reading 'pontifex'" ); |
295 | } catch ( Text::Tradition::Error $e ) { |
296 | ok( 0, "Merge of mergeable readings failed: $e->message" ); |
297 | |
298 | } |
299 | |
176badfe |
300 | # Test 1.3: attempt relationship with a meta reading (should fail) |
301 | try { |
10e4b1ac |
302 | $c1->add_relationship( 'r8.1', 'r9.2', { 'type' => 'collated' } ); |
176badfe |
303 | ok( 0, "Allowed a meta-reading to be used in a relationship" ); |
304 | } catch ( Text::Tradition::Error $e ) { |
305 | is( $e->message, 'Cannot set relationship on a meta reading', |
306 | "Relationship link prevented for a meta reading" ); |
307 | } |
308 | |
beb47b16 |
309 | # Test 1.4: try to break a relationship near a meta reading |
310 | $c1->add_relationship( 'r7.6', 'r7.3', { type => 'orthographic' } ); |
311 | try { |
312 | $c1->del_relationship( 'r7.6', 'r7.7' ); |
313 | $c1->del_relationship( 'r7.6', 'r7.3' ); |
314 | ok( 1, "Relationship broken with a meta reading as neighbor" ); |
315 | } catch { |
316 | ok( 0, "Relationship deletion failed with a meta reading as neighbor" ); |
317 | } |
318 | |
176badfe |
319 | # Test 2.1: try to equate nodes that are prevented with a real intermediate |
6d381462 |
320 | # equivalence |
56772e8c |
321 | my $t2; |
e92d4229 |
322 | warnings_exist { |
56772e8c |
323 | $t2 = Text::Tradition->new( 'input' => 'Self', 'file' => 't/data/legendfrag.xml' ); |
e92d4229 |
324 | } [qr/Cannot set relationship on a meta reading/], |
56772e8c |
325 | "Got expected relationship drop warning on parse"; |
6d381462 |
326 | my $c2 = $t2->collation; |
10e4b1ac |
327 | $c2->add_relationship( 'r9.2', 'r9.3', { 'type' => 'lexical' } ); |
328 | my $trel2 = $c2->get_relationship( 'r9.2', 'r9.3' ); |
6d381462 |
329 | is( ref( $trel2 ), 'Text::Tradition::Collation::Relationship', |
330 | "Created blocking relationship" ); |
331 | is( $trel2->type, 'lexical', "Blocking relationship is not a collation" ); |
332 | # This time the link ought to fail |
333 | try { |
10e4b1ac |
334 | $c2->add_relationship( 'r8.6', 'r10.3', { 'type' => 'orthographic' } ); |
414cc046 |
335 | ok( 0, "Added cross-equivalent bad relationship" ); |
176badfe |
336 | } catch ( Text::Tradition::Error $e ) { |
337 | like( $e->message, qr/witness loop/, |
338 | "Existing equivalence blocked crossing relationship" ); |
6d381462 |
339 | } |
340 | |
341 | try { |
342 | $c2->calculate_ranks(); |
343 | ok( 1, "Successfully calculated ranks" ); |
176badfe |
344 | } catch ( Text::Tradition::Error $e ) { |
345 | ok( 0, "Collation now has a cycle: " . $e->message ); |
6d381462 |
346 | } |
347 | |
176badfe |
348 | # Test 3.1: make a straightforward pair of transpositions. |
cc31ebaa |
349 | my $t3 = Text::Tradition->new( 'input' => 'Self', 'file' => 't/data/lf2.xml' ); |
350 | # Test 1: try to equate nodes that are prevented with an intermediate collation |
351 | my $c3 = $t3->collation; |
352 | try { |
10e4b1ac |
353 | $c3->add_relationship( 'r36.4', 'r38.3', { 'type' => 'transposition' } ); |
cc31ebaa |
354 | ok( 1, "Added straightforward transposition" ); |
176badfe |
355 | } catch ( Text::Tradition::Error $e ) { |
356 | ok( 0, "Failed to add normal transposition: " . $e->message ); |
cc31ebaa |
357 | } |
358 | try { |
10e4b1ac |
359 | $c3->add_relationship( 'r36.3', 'r38.2', { 'type' => 'transposition' } ); |
cc31ebaa |
360 | ok( 1, "Added straightforward transposition complement" ); |
176badfe |
361 | } catch ( Text::Tradition::Error $e ) { |
362 | ok( 0, "Failed to add normal transposition complement: " . $e->message ); |
cc31ebaa |
363 | } |
364 | |
176badfe |
365 | # Test 3.2: try to make a transposition that could be a parallel. |
cc31ebaa |
366 | try { |
10e4b1ac |
367 | $c3->add_relationship( 'r28.2', 'r29.2', { 'type' => 'transposition' } ); |
cc31ebaa |
368 | ok( 0, "Added bad colocated transposition" ); |
176badfe |
369 | } catch ( Text::Tradition::Error $e ) { |
370 | like( $e->message, qr/Readings appear to be colocated/, |
371 | "Prevented bad colocated transposition" ); |
cc31ebaa |
372 | } |
373 | |
176badfe |
374 | # Test 3.3: make the parallel, and then make the transposition again. |
cc31ebaa |
375 | try { |
10e4b1ac |
376 | $c3->add_relationship( 'r28.3', 'r29.3', { 'type' => 'orthographic' } ); |
cc31ebaa |
377 | ok( 1, "Equated identical readings for transposition" ); |
176badfe |
378 | } catch ( Text::Tradition::Error $e ) { |
379 | ok( 0, "Failed to equate identical readings: " . $e->message ); |
cc31ebaa |
380 | } |
381 | try { |
10e4b1ac |
382 | $c3->add_relationship( 'r28.2', 'r29.2', { 'type' => 'transposition' } ); |
cc31ebaa |
383 | ok( 1, "Added straightforward transposition complement" ); |
176badfe |
384 | } catch ( Text::Tradition::Error $e ) { |
385 | ok( 0, "Failed to add normal transposition complement: " . $e->message ); |
cc31ebaa |
386 | } |
387 | |
6d381462 |
388 | =end testing |
389 | |
22222af9 |
390 | =cut |
391 | |
392 | sub add_relationship { |
414cc046 |
393 | my( $self, $source, $target, $options ) = @_; |
394 | my $c = $self->collation; |
176badfe |
395 | my $sourceobj = $c->reading( $source ); |
396 | my $targetobj = $c->reading( $target ); |
359944f7 |
397 | throw( "Adding self relationship at $source" ) if $source eq $target; |
176badfe |
398 | throw( "Cannot set relationship on a meta reading" ) |
399 | if( $sourceobj->is_meta || $targetobj->is_meta ); |
ca6e6095 |
400 | my $relationship; |
401 | my $thispaironly; |
414cc046 |
402 | my $droppedcolls = []; |
ca6e6095 |
403 | if( ref( $options ) eq 'Text::Tradition::Collation::Relationship' ) { |
404 | $relationship = $options; |
405 | $thispaironly = 1; # If existing rel, set only where asked. |
406 | } else { |
407 | # Check the options |
408 | $options->{'scope'} = 'local' unless $options->{'scope'}; |
bf6e338d |
409 | $options->{'scope'} = 'local' if $options->{'type'} eq 'collated'; |
8d5c8893 |
410 | $options->{'scope'} = 'local' if $options->{'type'} eq 'transposition'; |
ca6e6095 |
411 | |
414cc046 |
412 | my( $is_valid, $reason ) = $self->relationship_valid( $source, $target, |
413 | $options->{'type'}, $droppedcolls ); |
ca6e6095 |
414 | unless( $is_valid ) { |
415 | throw( "Invalid relationship: $reason" ); |
416 | } |
417 | |
418 | # Try to create the relationship object. |
176badfe |
419 | $options->{'reading_a'} = $sourceobj->text; |
420 | $options->{'reading_b'} = $targetobj->text; |
ca6e6095 |
421 | $options->{'orig_a'} = $source; |
422 | $options->{'orig_b'} = $target; |
0ac5e750 |
423 | if( $options->{'scope'} ne 'local' ) { |
424 | # Is there a relationship with this a & b already? |
f222800e |
425 | # Case-insensitive for non-orthographics. |
428bcf0b |
426 | my $rdga = $options->{'reading_a'}; |
427 | my $rdgb = $options->{'reading_b'}; |
f222800e |
428 | my $otherrel = $self->scoped_relationship( $rdga, $rdgb ); |
0ac5e750 |
429 | if( $otherrel && $otherrel->type eq $options->{type} |
430 | && $otherrel->scope eq $options->{scope} ) { |
99ab9535 |
431 | warn "Applying existing scoped relationship for $rdga / $rdgb"; |
0ac5e750 |
432 | $relationship = $otherrel; |
99ab9535 |
433 | } elsif( $otherrel ) { |
434 | throw( "Conflicting scoped relationship for $rdga / $rdgb at $source / $target" ); |
0ac5e750 |
435 | } |
436 | } |
437 | $relationship = $self->create( $options ) unless $relationship; # Will throw on error |
22222af9 |
438 | } |
ca6e6095 |
439 | |
22222af9 |
440 | |
22222af9 |
441 | # Now set the relationship(s). |
442 | my @pairs_set; |
414cc046 |
443 | my $rel = $self->get_relationship( $source, $target ); |
cc31ebaa |
444 | my $skip; |
414cc046 |
445 | if( $rel && $rel ne $relationship ) { |
446 | if( $rel->nonlocal ) { |
447 | throw( "Found conflicting relationship at $source - $target" ); |
448 | } elsif( $rel->type ne 'collated' ) { |
449 | # Replace a collation relationship; leave any other sort in place. |
450 | my $r1ann = $rel->has_annotation ? $rel->annotation : ''; |
451 | my $r2ann = $relationship->has_annotation ? $relationship->annotation : ''; |
452 | unless( $rel->type eq $relationship->type && $r1ann eq $r2ann ) { |
453 | warn sprintf( "Not overriding local relationship %s with global %s " |
454 | . "set at %s -> %s (%s -> %s)", $rel->type, $relationship->type, |
455 | $source, $target, $rel->reading_a, $rel->reading_b ); |
cc31ebaa |
456 | $skip = 1; |
414cc046 |
457 | } |
458 | } |
459 | } |
cc31ebaa |
460 | $self->_set_relationship( $relationship, $source, $target ) unless $skip; |
414cc046 |
461 | push( @pairs_set, [ $source, $target ] ); |
462 | |
428bcf0b |
463 | # Find all the pairs for which we need to set the relationship. |
464 | if( $relationship->colocated && $relationship->nonlocal && !$thispaironly ) { |
465 | push( @pairs_set, $self->add_global_relationship( $relationship ) ); |
22222af9 |
466 | } |
414cc046 |
467 | # Finally, restore whatever collations we can, and return. |
468 | $self->_restore_collations( @$droppedcolls ); |
63778331 |
469 | return @pairs_set; |
22222af9 |
470 | } |
471 | |
428bcf0b |
472 | =head2 add_global_relationship( $options, $skipvector ) |
473 | |
474 | Adds the relationship specified wherever the relevant readings appear together |
475 | in the graph. Options as in add_relationship above. |
476 | |
477 | =cut |
478 | |
479 | sub add_global_relationship { |
480 | my( $self, $options ) = @_; |
481 | # First see if we are dealing with a relationship object already |
482 | my $relationship; |
483 | if( ref( $options ) eq 'Text::Tradition::Collation::Relationship' ) { |
484 | $relationship = $options; |
485 | } else { |
486 | # Then see if a scoped relationship already applies for the words. |
487 | my $scopedrel = $self->scoped_relationship( |
488 | $options->{reading_a}, $options->{reading_b} ); |
489 | $relationship = $scopedrel ? $scopedrel |
490 | : $self->create( $options ); |
491 | } |
492 | # Sanity checking |
493 | throw( "Relationship passed to add_global is not global" ) |
494 | unless $relationship->nonlocal; |
495 | throw( "Relationship passed to add_global is not a valid global type" ) |
496 | unless $relationship->colocated && $relationship->type ne 'collated'; |
497 | |
498 | # Apply the relationship wherever it is valid |
499 | my @pairs_set; |
500 | foreach my $v ( $self->_find_applicable( $relationship ) ) { |
501 | my $exists = $self->get_relationship( @$v ); |
502 | if( $exists && $exists->type ne 'collated' ) { |
503 | throw( "Found conflicting relationship at @$v" ) |
504 | unless $exists->type eq $relationship->type |
505 | && $exists->scope eq $relationship->scope; |
506 | } else { |
507 | my @added = $self->add_relationship( @$v, $relationship ); |
508 | push( @pairs_set, @added ); |
509 | } |
510 | } |
511 | return @pairs_set; |
512 | } |
513 | |
514 | |
9d829138 |
515 | =head2 del_scoped_relationship( $reading_a, $reading_b ) |
516 | |
517 | Returns the general (document-level or global) relationship that has been defined |
518 | between the two reading strings. Returns undef if there is no general relationship. |
519 | |
520 | =cut |
521 | |
522 | sub del_scoped_relationship { |
523 | my( $self, $rdga, $rdgb ) = @_; |
524 | my( $first, $second ) = sort( $rdga, $rdgb ); |
525 | return delete $self->scopedrels->{$first}->{$second}; |
526 | } |
527 | |
bf6e338d |
528 | sub _find_applicable { |
529 | my( $self, $rel ) = @_; |
530 | my $c = $self->collation; |
531 | # TODO Someday we might use a case sensitive language. |
bf6e338d |
532 | my @vectors; |
533 | my @identical_readings; |
534 | if( $rel->type eq 'orthographic' ) { |
535 | @identical_readings = grep { $_->text eq $rel->reading_a } |
536 | $c->readings; |
537 | } else { |
538 | @identical_readings = grep { lc( $_->text ) eq lc( $rel->reading_a ) } |
539 | $c->readings; |
540 | } |
541 | foreach my $ir ( @identical_readings ) { |
542 | my @itarget; |
543 | if( $rel->type eq 'orthographic' ) { |
544 | @itarget = grep { $_->rank == $ir->rank |
545 | && $_->text eq $rel->reading_b } $c->readings; |
546 | } else { |
547 | @itarget = grep { $_->rank == $ir->rank |
548 | && lc( $_->text ) eq lc( $rel->reading_b ) } $c->readings; |
549 | } |
550 | if( @itarget ) { |
551 | # Warn if there is more than one hit with no orth link between them. |
552 | my $itmain = shift @itarget; |
553 | if( @itarget ) { |
554 | my %all_targets; |
555 | map { $all_targets{$_} = 1 } @itarget; |
556 | map { delete $all_targets{$_} } |
557 | $self->related_readings( $itmain, |
558 | sub { $_[0]->type eq 'orthographic' } ); |
559 | warn "More than one unrelated reading with text " . $itmain->text |
560 | . " at rank " . $ir->rank . "!" if keys %all_targets; |
561 | } |
562 | push( @vectors, [ $ir->id, $itmain->id ] ); |
563 | } |
564 | } |
565 | return @vectors; |
566 | } |
567 | |
ee801e17 |
568 | =head2 del_relationship( $source, $target ) |
569 | |
570 | Removes the relationship between the given readings. If the relationship is |
571 | non-local, removes the relationship everywhere in the graph. |
572 | |
573 | =cut |
574 | |
575 | sub del_relationship { |
576 | my( $self, $source, $target ) = @_; |
577 | my $rel = $self->get_relationship( $source, $target ); |
681893aa |
578 | return () unless $rel; # Nothing to delete; return an empty set. |
359944f7 |
579 | my $colo = $rel->colocated; |
ee801e17 |
580 | my @vectors = ( [ $source, $target ] ); |
359944f7 |
581 | $self->_remove_relationship( $colo, $source, $target ); |
ee801e17 |
582 | if( $rel->nonlocal ) { |
583 | # Remove the relationship wherever it occurs. |
9d829138 |
584 | # Remove the relationship wherever it occurs. |
ee801e17 |
585 | my @rel_edges = grep { $self->get_relationship( @$_ ) == $rel } |
586 | $self->relationships; |
587 | foreach my $re ( @rel_edges ) { |
359944f7 |
588 | $self->_remove_relationship( $colo, @$re ); |
ee801e17 |
589 | push( @vectors, $re ); |
590 | } |
9d829138 |
591 | $self->del_scoped_relationship( $rel->reading_a, $rel->reading_b ); |
ee801e17 |
592 | } |
593 | return @vectors; |
594 | } |
595 | |
ca6e6095 |
596 | sub _remove_relationship { |
359944f7 |
597 | my( $self, $equiv, @vector ) = @_; |
ca6e6095 |
598 | $self->graph->delete_edge( @vector ); |
176badfe |
599 | $self->_break_equivalence( @vector ) if $equiv; |
ca6e6095 |
600 | } |
601 | |
22222af9 |
602 | =head2 relationship_valid( $source, $target, $type ) |
603 | |
604 | Checks whether a relationship of type $type may exist between the readings given |
605 | in $source and $target. Returns a tuple of ( status, message ) where status is |
606 | a yes/no boolean and, if the answer is no, message gives the reason why. |
607 | |
608 | =cut |
609 | |
610 | sub relationship_valid { |
414cc046 |
611 | my( $self, $source, $target, $rel, $mustdrop ) = @_; |
612 | $mustdrop = [] unless $mustdrop; # in case we were passed nothing |
22222af9 |
613 | my $c = $self->collation; |
10943ab0 |
614 | ## Assume validity is okay if we are initializing from scratch. |
3579c22b |
615 | return ( 1, "initializing" ) unless $c->tradition->_initialized; |
56772e8c |
616 | if ( $rel eq 'transposition' || $rel eq 'repetition' ) { |
22222af9 |
617 | # Check that the two readings do (for a repetition) or do not (for |
618 | # a transposition) appear in the same witness. |
56772e8c |
619 | # TODO this might be called before witness paths are set... |
22222af9 |
620 | my %seen_wits; |
621 | map { $seen_wits{$_} = 1 } $c->reading_witnesses( $source ); |
622 | foreach my $w ( $c->reading_witnesses( $target ) ) { |
623 | if( $seen_wits{$w} ) { |
624 | return ( 0, "Readings both occur in witness $w" ) |
625 | if $rel eq 'transposition'; |
626 | return ( 1, "ok" ) if $rel eq 'repetition'; |
d6936dea |
627 | } |
22222af9 |
628 | } |
abadc997 |
629 | return ( 0, "Readings occur only in distinct witnesses" ) |
630 | if $rel eq 'repetition'; |
631 | } |
632 | if ( $rel eq 'transposition' ) { |
633 | # We also need to check both that the readings occur in distinct |
634 | # witnesses, and that they are not in the same place. That is, |
635 | # proposing to link them should cause a witness loop. |
359944f7 |
636 | if( $self->test_equivalence( $source, $target ) ) { |
abadc997 |
637 | return ( 0, "Readings appear to be colocated, not transposed" ); |
359944f7 |
638 | } else { |
639 | return ( 1, "ok" ); |
abadc997 |
640 | } |
641 | |
642 | } elsif( $rel ne 'repetition' ) { |
22222af9 |
643 | # Check that linking the source and target in a relationship won't lead |
414cc046 |
644 | # to a path loop for any witness. |
645 | # First, drop/stash any collations that might interfere |
646 | my $sourceobj = $c->reading( $source ); |
647 | my $targetobj = $c->reading( $target ); |
648 | my $sourcerank = $sourceobj->has_rank ? $sourceobj->rank : -1; |
649 | my $targetrank = $targetobj->has_rank ? $targetobj->rank : -1; |
650 | unless( $rel eq 'collated' || $sourcerank == $targetrank ) { |
651 | push( @$mustdrop, $self->_drop_collations( $source ) ); |
652 | push( @$mustdrop, $self->_drop_collations( $target ) ); |
359944f7 |
653 | if( $c->end->has_rank ) { |
176badfe |
654 | foreach my $rk ( $sourcerank .. $targetrank ) { |
414cc046 |
655 | map { push( @$mustdrop, $self->_drop_collations( $_->id ) ) } |
656 | $c->readings_at_rank( $rk ); |
657 | } |
658 | } |
a1615ee4 |
659 | } |
359944f7 |
660 | unless( $self->test_equivalence( $source, $target ) ) { |
414cc046 |
661 | $self->_restore_collations( @$mustdrop ); |
662 | return( 0, "Relationship would create witness loop" ); |
a1615ee4 |
663 | } |
22222af9 |
664 | return ( 1, "ok" ); |
665 | } |
666 | } |
667 | |
778251a6 |
668 | sub _drop_collations { |
669 | my( $self, $reading ) = @_; |
414cc046 |
670 | my @dropped; |
778251a6 |
671 | foreach my $n ( $self->graph->neighbors( $reading ) ) { |
672 | if( $self->get_relationship( $reading, $n )->type eq 'collated' ) { |
414cc046 |
673 | push( @dropped, [ $reading, $n ] ); |
778251a6 |
674 | $self->del_relationship( $reading, $n ); |
359944f7 |
675 | #print STDERR "Dropped collation $reading -> $n\n"; |
778251a6 |
676 | } |
677 | } |
414cc046 |
678 | return @dropped; |
679 | } |
680 | |
681 | sub _restore_collations { |
682 | my( $self, @vectors ) = @_; |
683 | foreach my $v ( @vectors ) { |
684 | try { |
685 | $self->add_relationship( @$v, { 'type' => 'collated' } ); |
359944f7 |
686 | #print STDERR "Restored collation @$v\n"; |
414cc046 |
687 | } catch { |
688 | print STDERR $v->[0] . " - " . $v->[1] . " no longer collate\n"; |
689 | } |
690 | } |
778251a6 |
691 | } |
692 | |
cc31ebaa |
693 | =head2 filter_collations() |
694 | |
695 | Utility function. Removes any redundant 'collated' relationships from the graph. |
696 | A collated relationship is redundant if the readings in question would occupy |
697 | the same rank regardless of the existence of the relationship. |
698 | |
699 | =cut |
700 | |
701 | sub filter_collations { |
702 | my $self = shift; |
703 | my $c = $self->collation; |
704 | foreach my $r ( 1 .. $c->end->rank - 1 ) { |
705 | my $anchor; |
706 | my @need_collations; |
707 | foreach my $rdg ( $c->readings_at_rank( $r ) ) { |
708 | next if $rdg->is_meta; |
709 | my $ip = 0; |
710 | foreach my $pred ( $rdg->predecessors ) { |
711 | if( $pred->rank == $r - 1 ) { |
712 | $ip = 1; |
713 | $anchor = $rdg unless( $anchor ); |
714 | last; |
715 | } |
716 | } |
717 | push( @need_collations, $rdg ) unless $ip; |
718 | $c->relations->_drop_collations( "$rdg" ); |
719 | } |
720 | $anchor |
46e1fe14 |
721 | ? map { $c->add_relationship( $anchor, $_, { 'type' => 'collated' } ) |
722 | unless $c->get_relationship( $anchor, $_ ) } @need_collations |
cc31ebaa |
723 | : warn "No anchor found at $r"; |
724 | } |
725 | } |
726 | |
7f52eac8 |
727 | =head2 related_readings( $reading, $filter ) |
22222af9 |
728 | |
729 | Returns a list of readings that are connected via relationship links to $reading. |
7f52eac8 |
730 | If $filter is set to a subroutine ref, returns only those related readings where |
731 | $filter( $relationship ) returns a true value. |
22222af9 |
732 | |
733 | =cut |
734 | |
735 | sub related_readings { |
7f52eac8 |
736 | my( $self, $reading, $filter ) = @_; |
22222af9 |
737 | my $return_object; |
738 | if( ref( $reading ) eq 'Text::Tradition::Collation::Reading' ) { |
739 | $reading = $reading->id; |
740 | $return_object = 1; |
741 | } |
c84275ff |
742 | my @answer; |
7f52eac8 |
743 | if( $filter ) { |
744 | # Backwards compat |
745 | if( $filter eq 'colocated' ) { |
746 | $filter = sub { $_[0]->colocated }; |
d002ccb7 |
747 | } elsif( !ref( $filter ) ) { |
748 | my $type = $filter; |
749 | $filter = sub { $_[0]->type eq $type }; |
7f52eac8 |
750 | } |
c84275ff |
751 | my %found = ( $reading => 1 ); |
752 | my $check = [ $reading ]; |
753 | my $iter = 0; |
754 | while( @$check ) { |
c84275ff |
755 | my $more = []; |
756 | foreach my $r ( @$check ) { |
757 | foreach my $nr ( $self->graph->neighbors( $r ) ) { |
7f52eac8 |
758 | if( &$filter( $self->get_relationship( $r, $nr ) ) ) { |
c84275ff |
759 | push( @$more, $nr ) unless exists $found{$nr}; |
760 | $found{$nr} = 1; |
761 | } |
762 | } |
763 | } |
764 | $check = $more; |
22222af9 |
765 | } |
7f52eac8 |
766 | delete $found{$reading}; |
c84275ff |
767 | @answer = keys %found; |
768 | } else { |
769 | @answer = $self->graph->all_reachable( $reading ); |
22222af9 |
770 | } |
771 | if( $return_object ) { |
772 | my $c = $self->collation; |
c84275ff |
773 | return map { $c->reading( $_ ) } @answer; |
22222af9 |
774 | } else { |
c84275ff |
775 | return @answer; |
22222af9 |
776 | } |
777 | } |
778 | |
779 | =head2 merge_readings( $kept, $deleted ); |
780 | |
781 | Makes a best-effort merge of the relationship links between the given readings, and |
782 | stops tracking the to-be-deleted reading. |
783 | |
784 | =cut |
785 | |
786 | sub merge_readings { |
787 | my( $self, $kept, $deleted, $combined ) = @_; |
788 | foreach my $edge ( $self->graph->edges_at( $deleted ) ) { |
789 | # Get the pair of kept / rel |
790 | my @vector = ( $kept ); |
791 | push( @vector, $edge->[0] eq $deleted ? $edge->[1] : $edge->[0] ); |
792 | next if $vector[0] eq $vector[1]; # Don't add a self loop |
793 | |
794 | # If kept changes its text, drop the relationship. |
795 | next if $combined; |
796 | |
f222800e |
797 | # If kept / rel already has a relationship, just keep the old |
3ae5e2ad |
798 | my $rel = $self->get_relationship( @vector ); |
f222800e |
799 | next if $rel; |
22222af9 |
800 | |
801 | # Otherwise, adopt the relationship that would be deleted. |
3ae5e2ad |
802 | $rel = $self->get_relationship( @$edge ); |
803 | $self->_set_relationship( $rel, @vector ); |
22222af9 |
804 | } |
56772e8c |
805 | $self->_make_equivalence( $deleted, $kept ); |
22222af9 |
806 | } |
807 | |
359944f7 |
808 | ### Equivalence logic |
809 | |
810 | sub _remove_equivalence_node { |
811 | my( $self, $node ) = @_; |
812 | my $group = $self->equivalence( $node ); |
813 | my $nodelist = $self->eqreadings( $group ); |
814 | if( @$nodelist == 1 && $nodelist->[0] eq $node ) { |
3579c22b |
815 | $self->equivalence_graph->delete_vertex( $group ); |
359944f7 |
816 | $self->remove_eqreadings( $group ); |
3579c22b |
817 | $self->remove_equivalence( $group ); |
359944f7 |
818 | } elsif( @$nodelist == 1 ) { |
3579c22b |
819 | throw( "DATA INCONSISTENCY in equivalence graph: " . $nodelist->[0] . |
820 | " in group that should have only $node" ); |
359944f7 |
821 | } else { |
10e4b1ac |
822 | my @newlist = grep { $_ ne $node } @$nodelist; |
359944f7 |
823 | $self->set_eqreadings( $group, \@newlist ); |
824 | $self->remove_equivalence( $node ); |
825 | } |
826 | } |
827 | |
828 | =head2 add_equivalence_edge |
829 | |
176badfe |
830 | Add an edge in the equivalence graph corresponding to $source -> $target in the |
831 | collation. Should only be called by Collation. |
359944f7 |
832 | |
833 | =cut |
834 | |
835 | sub add_equivalence_edge { |
836 | my( $self, $source, $target ) = @_; |
837 | my $seq = $self->equivalence( $source ); |
838 | my $teq = $self->equivalence( $target ); |
359944f7 |
839 | $self->equivalence_graph->add_edge( $seq, $teq ); |
840 | } |
841 | |
176badfe |
842 | =head2 delete_equivalence_edge |
359944f7 |
843 | |
176badfe |
844 | Remove an edge in the equivalence graph corresponding to $source -> $target in the |
845 | collation. Should only be called by Collation. |
359944f7 |
846 | |
847 | =cut |
848 | |
849 | sub delete_equivalence_edge { |
850 | my( $self, $source, $target ) = @_; |
851 | my $seq = $self->equivalence( $source ); |
852 | my $teq = $self->equivalence( $target ); |
359944f7 |
853 | $self->equivalence_graph->delete_edge( $seq, $teq ); |
854 | } |
855 | |
856 | sub _is_disconnected { |
857 | my $self = shift; |
858 | return( scalar $self->equivalence_graph->predecessorless_vertices > 1 |
859 | || scalar $self->equivalence_graph->successorless_vertices > 1 ); |
860 | } |
861 | |
176badfe |
862 | # Equate two readings in the equivalence graph |
863 | sub _make_equivalence { |
56772e8c |
864 | my( $self, $source, $target ) = @_; |
359944f7 |
865 | # Get the source equivalent readings |
866 | my $seq = $self->equivalence( $source ); |
867 | my $teq = $self->equivalence( $target ); |
868 | # Nothing to do if they are already equivalent... |
869 | return if $seq eq $teq; |
56772e8c |
870 | my $sourcepool = $self->eqreadings( $seq ); |
359944f7 |
871 | # and add them to the target readings. |
56772e8c |
872 | push( @{$self->eqreadings( $teq )}, @$sourcepool ); |
873 | map { $self->set_equivalence( $_, $teq ) } @$sourcepool; |
359944f7 |
874 | # Then merge the nodes in the equivalence graph. |
875 | foreach my $pred ( $self->equivalence_graph->predecessors( $seq ) ) { |
56772e8c |
876 | $self->equivalence_graph->add_edge( $pred, $teq ); |
359944f7 |
877 | } |
878 | foreach my $succ ( $self->equivalence_graph->successors( $seq ) ) { |
56772e8c |
879 | $self->equivalence_graph->add_edge( $teq, $succ ); |
359944f7 |
880 | } |
881 | $self->equivalence_graph->delete_vertex( $seq ); |
176badfe |
882 | # TODO enable this after collation parsing is done |
10943ab0 |
883 | throw( "Graph got disconnected making $source / $target equivalence" ) |
3579c22b |
884 | if $self->_is_disconnected && $self->collation->tradition->_initialized; |
359944f7 |
885 | } |
886 | |
887 | =head2 test_equivalence |
888 | |
176badfe |
889 | Test whether, if two readings were equated with a 'colocated' relationship, |
890 | the graph would still be valid. |
359944f7 |
891 | |
892 | =cut |
893 | |
894 | sub test_equivalence { |
895 | my( $self, $source, $target ) = @_; |
896 | # Try merging the nodes in the equivalence graph; return a true value if |
897 | # no cycle is introduced thereby. Restore the original graph first. |
898 | |
899 | # Keep track of edges we add |
900 | my %added_pred; |
901 | my %added_succ; |
902 | # Get the reading equivalents |
903 | my $seq = $self->equivalence( $source ); |
904 | my $teq = $self->equivalence( $target ); |
905 | # Maybe this is easy? |
906 | return 1 if $seq eq $teq; |
907 | |
908 | # Save the first graph |
909 | my $checkstr = $self->equivalence_graph->stringify(); |
910 | # Add and save relevant edges |
911 | foreach my $pred ( $self->equivalence_graph->predecessors( $seq ) ) { |
912 | if( $self->equivalence_graph->has_edge( $pred, $teq ) ) { |
913 | $added_pred{$pred} = 0; |
914 | } else { |
915 | $self->equivalence_graph->add_edge( $pred, $teq ); |
916 | $added_pred{$pred} = 1; |
917 | } |
918 | } |
919 | foreach my $succ ( $self->equivalence_graph->successors( $seq ) ) { |
920 | if( $self->equivalence_graph->has_edge( $teq, $succ ) ) { |
921 | $added_succ{$succ} = 0; |
922 | } else { |
923 | $self->equivalence_graph->add_edge( $teq, $succ ); |
924 | $added_succ{$succ} = 1; |
925 | } |
926 | } |
927 | # Delete source equivalent and test |
928 | $self->equivalence_graph->delete_vertex( $seq ); |
929 | my $ret = !$self->equivalence_graph->has_a_cycle; |
930 | |
931 | # Restore what we changed |
932 | $self->equivalence_graph->add_vertex( $seq ); |
933 | foreach my $pred ( keys %added_pred ) { |
934 | $self->equivalence_graph->add_edge( $pred, $seq ); |
935 | $self->equivalence_graph->delete_edge( $pred, $teq ) if $added_pred{$pred}; |
936 | } |
937 | foreach my $succ ( keys %added_succ ) { |
938 | $self->equivalence_graph->add_edge( $seq, $succ ); |
939 | $self->equivalence_graph->delete_edge( $teq, $succ ) if $added_succ{$succ}; |
940 | } |
941 | unless( $self->equivalence_graph->eq( $checkstr ) ) { |
942 | warn "GRAPH CHANGED after testing"; |
943 | } |
944 | # Return our answer |
945 | return $ret; |
946 | } |
947 | |
176badfe |
948 | # Unmake an equivalence link between two readings. Should only be called internally. |
949 | sub _break_equivalence { |
359944f7 |
950 | my( $self, $source, $target ) = @_; |
951 | |
952 | # This is the hard one. Need to reconstruct the equivalence groups without |
953 | # the given link. |
954 | my( %sng, %tng ); |
955 | map { $sng{$_} = 1 } $self->_find_equiv_without( $source, $target ); |
956 | map { $tng{$_} = 1 } $self->_find_equiv_without( $target, $source ); |
957 | # If these groups intersect, they are still connected; do nothing. |
958 | foreach my $el ( keys %tng ) { |
10e4b1ac |
959 | return if( exists $sng{$el} ); |
359944f7 |
960 | } |
359944f7 |
961 | # If they don't intersect, then we split the nodes in the graph and in |
962 | # the hashes. First figure out which group has which name |
176badfe |
963 | my $oldgroup = $self->equivalence( $source ); # same as $target |
964 | my $keepsource = $sng{$oldgroup}; |
965 | my $newgroup = $keepsource ? $target : $source; |
359944f7 |
966 | my( $oldmembers, $newmembers ); |
176badfe |
967 | if( $keepsource ) { |
359944f7 |
968 | $oldmembers = [ keys %sng ]; |
969 | $newmembers = [ keys %tng ]; |
970 | } else { |
971 | $oldmembers = [ keys %tng ]; |
972 | $newmembers = [ keys %sng ]; |
973 | } |
974 | |
975 | # First alter the old group in the hash |
976 | $self->set_eqreadings( $oldgroup, $oldmembers ); |
176badfe |
977 | foreach my $el ( @$oldmembers ) { |
978 | $self->set_equivalence( $el, $oldgroup ); |
979 | } |
359944f7 |
980 | |
981 | # then add the new group back to the hash with its new key |
982 | $self->set_eqreadings( $newgroup, $newmembers ); |
983 | foreach my $el ( @$newmembers ) { |
984 | $self->set_equivalence( $el, $newgroup ); |
985 | } |
986 | |
987 | # Now add the new group back to the equivalence graph |
988 | $self->equivalence_graph->add_vertex( $newgroup ); |
989 | # ...add the appropriate edges to the source group vertext |
990 | my $c = $self->collation; |
991 | foreach my $rdg ( @$newmembers ) { |
992 | foreach my $rp ( $c->sequence->predecessors( $rdg ) ) { |
beb47b16 |
993 | next unless $self->equivalence( $rp ); |
359944f7 |
994 | $self->equivalence_graph->add_edge( $self->equivalence( $rp ), $newgroup ); |
995 | } |
996 | foreach my $rs ( $c->sequence->successors( $rdg ) ) { |
beb47b16 |
997 | next unless $self->equivalence( $rs ); |
359944f7 |
998 | $self->equivalence_graph->add_edge( $newgroup, $self->equivalence( $rs ) ); |
999 | } |
1000 | } |
1001 | |
1002 | # ...and figure out which edges on the old group vertex to delete. |
1003 | my( %old_pred, %old_succ ); |
1004 | foreach my $rdg ( @$oldmembers ) { |
1005 | foreach my $rp ( $c->sequence->predecessors( $rdg ) ) { |
beb47b16 |
1006 | next unless $self->equivalence( $rp ); |
359944f7 |
1007 | $old_pred{$self->equivalence( $rp )} = 1; |
1008 | } |
1009 | foreach my $rs ( $c->sequence->successors( $rdg ) ) { |
beb47b16 |
1010 | next unless $self->equivalence( $rs ); |
359944f7 |
1011 | $old_succ{$self->equivalence( $rs )} = 1; |
1012 | } |
1013 | } |
1014 | foreach my $p ( $self->equivalence_graph->predecessors( $oldgroup ) ) { |
1015 | unless( $old_pred{$p} ) { |
1016 | $self->equivalence_graph->delete_edge( $p, $oldgroup ); |
1017 | } |
1018 | } |
1019 | foreach my $s ( $self->equivalence_graph->successors( $oldgroup ) ) { |
1020 | unless( $old_succ{$s} ) { |
1021 | $self->equivalence_graph->delete_edge( $oldgroup, $s ); |
1022 | } |
1023 | } |
176badfe |
1024 | # TODO enable this after collation parsing is done |
10943ab0 |
1025 | throw( "Graph got disconnected breaking $source / $target equivalence" ) |
3579c22b |
1026 | if $self->_is_disconnected && $self->collation->tradition->_initialized; |
359944f7 |
1027 | } |
1028 | |
1029 | sub _find_equiv_without { |
1030 | my( $self, $first, $second ) = @_; |
1031 | my %found = ( $first => 1 ); |
1032 | my $check = [ $first ]; |
1033 | my $iter = 0; |
1034 | while( @$check ) { |
1035 | my $more = []; |
1036 | foreach my $r ( @$check ) { |
1037 | foreach my $nr ( $self->graph->neighbors( $r ) ) { |
1038 | next if $r eq $second; |
1039 | if( $self->get_relationship( $r, $nr )->colocated ) { |
1040 | push( @$more, $nr ) unless exists $found{$nr}; |
1041 | $found{$nr} = 1; |
1042 | } |
1043 | } |
1044 | } |
1045 | $check = $more; |
1046 | } |
1047 | return keys %found; |
1048 | } |
1049 | |
e1083e99 |
1050 | =head2 rebuild_equivalence |
1051 | |
1052 | (Re)build the equivalence graph from scratch. Dumps the graph, makes a new one, |
1053 | adds all readings and edges, then makes an equivalence for all relationships. |
1054 | |
1055 | =cut |
1056 | |
1057 | sub rebuild_equivalence { |
1058 | my $self = shift; |
1059 | my $newgraph = Graph->new(); |
04482188 |
1060 | # Set this as the new equivalence graph |
1061 | $self->_reset_equivalence( $newgraph ); |
1062 | # Clear out the data hashes |
1063 | $self->_clear_equivalence; |
1064 | $self->_clear_eqreadings; |
1065 | |
b6f13859 |
1066 | $self->collation->tradition->_init_done(0); |
04482188 |
1067 | # Add the readings |
e1083e99 |
1068 | foreach my $r ( $self->collation->readings ) { |
04482188 |
1069 | my $rid = $r->id; |
1070 | $newgraph->add_vertex( $rid ); |
1071 | $self->set_equivalence( $rid, $rid ); |
1072 | $self->set_eqreadings( $rid, [ $rid ] ); |
e1083e99 |
1073 | } |
04482188 |
1074 | |
1075 | # Now add the edges |
e1083e99 |
1076 | foreach my $e ( $self->collation->paths ) { |
04482188 |
1077 | $self->add_equivalence_edge( @$e ); |
e1083e99 |
1078 | } |
04482188 |
1079 | |
1080 | # Now equate the colocated readings. This does no testing; |
1081 | # it assumes that all preexisting relationships are valid. |
e1083e99 |
1082 | foreach my $rel ( $self->relationships ) { |
1083 | my $relobj = $self->get_relationship( $rel ); |
1084 | next unless $relobj && $relobj->colocated; |
1085 | $self->_make_equivalence( @$rel ); |
1086 | } |
b6f13859 |
1087 | $self->collation->tradition->_init_done(1); |
e1083e99 |
1088 | } |
1089 | |
56772e8c |
1090 | =head2 equivalence_ranks |
1091 | |
1092 | Rank all vertices in the equivalence graph, and return a hash reference with |
1093 | vertex => rank mapping. |
1094 | |
1095 | =cut |
1096 | |
1097 | sub equivalence_ranks { |
1098 | my $self = shift; |
1099 | my $eqstart = $self->equivalence( $self->collation->start ); |
1100 | my $eqranks = { $eqstart => 0 }; |
1101 | my $rankeqs = { 0 => [ $eqstart ] }; |
1102 | my @curr_origin = ( $eqstart ); |
1103 | # A little iterative function. |
1104 | while( @curr_origin ) { |
1105 | @curr_origin = $self->_assign_rank( $eqranks, $rankeqs, @curr_origin ); |
1106 | } |
1107 | return( $eqranks, $rankeqs ); |
1108 | } |
1109 | |
1110 | sub _assign_rank { |
1111 | my( $self, $node_ranks, $rank_nodes, @current_nodes ) = @_; |
1112 | my $graph = $self->equivalence_graph; |
1113 | # Look at each of the children of @current_nodes. If all the child's |
1114 | # parents have a rank, assign it the highest rank + 1 and add it to |
1115 | # @next_nodes. Otherwise skip it; we will return when the highest-ranked |
1116 | # parent gets a rank. |
1117 | my @next_nodes; |
1118 | foreach my $c ( @current_nodes ) { |
1119 | warn "Current reading $c has no rank!" |
1120 | unless exists $node_ranks->{$c}; |
1121 | foreach my $child ( $graph->successors( $c ) ) { |
1122 | next if exists $node_ranks->{$child}; |
1123 | my $highest_rank = -1; |
1124 | my $skip = 0; |
1125 | foreach my $parent ( $graph->predecessors( $child ) ) { |
1126 | if( exists $node_ranks->{$parent} ) { |
1127 | $highest_rank = $node_ranks->{$parent} |
1128 | if $highest_rank <= $node_ranks->{$parent}; |
1129 | } else { |
1130 | $skip = 1; |
1131 | last; |
1132 | } |
1133 | } |
1134 | next if $skip; |
1135 | my $c_rank = $highest_rank + 1; |
1136 | # print STDERR "Assigning rank $c_rank to node $child \n"; |
1137 | $node_ranks->{$child} = $c_rank if $node_ranks; |
1138 | push( @{$rank_nodes->{$c_rank}}, $child ) if $rank_nodes; |
1139 | push( @next_nodes, $child ); |
1140 | } |
1141 | } |
1142 | return @next_nodes; |
1143 | } |
1144 | |
359944f7 |
1145 | ### Output logic |
1146 | |
027d819c |
1147 | sub _as_graphml { |
2626f709 |
1148 | my( $self, $graphml_ns, $xmlroot, $node_hash, $nodeid_key, $edge_keys ) = @_; |
c84275ff |
1149 | |
1150 | my $rgraph = $xmlroot->addNewChild( $graphml_ns, 'graph' ); |
1151 | $rgraph->setAttribute( 'edgedefault', 'directed' ); |
1152 | $rgraph->setAttribute( 'id', 'relationships', ); |
1153 | $rgraph->setAttribute( 'parse.edgeids', 'canonical' ); |
cc31ebaa |
1154 | $rgraph->setAttribute( 'parse.edges', 0 ); |
c84275ff |
1155 | $rgraph->setAttribute( 'parse.nodeids', 'canonical' ); |
cc31ebaa |
1156 | $rgraph->setAttribute( 'parse.nodes', 0 ); |
c84275ff |
1157 | $rgraph->setAttribute( 'parse.order', 'nodesfirst' ); |
1158 | |
1159 | # Add the vertices according to their XML IDs |
2626f709 |
1160 | my %rdg_lookup = ( reverse %$node_hash ); |
cc31ebaa |
1161 | # my @nlist = sort _by_xmlid keys( %rdg_lookup ); ## CAUSES SEGFAULT |
826d8773 |
1162 | my @nlist = sort keys( %rdg_lookup ); |
414cc046 |
1163 | foreach my $n ( @nlist ) { |
c84275ff |
1164 | my $n_el = $rgraph->addNewChild( $graphml_ns, 'node' ); |
1165 | $n_el->setAttribute( 'id', $n ); |
2626f709 |
1166 | _add_graphml_data( $n_el, $nodeid_key, $rdg_lookup{$n} ); |
c84275ff |
1167 | } |
cc31ebaa |
1168 | $rgraph->setAttribute( 'parse.nodes', scalar @nlist ); |
c84275ff |
1169 | |
1170 | # Add the relationship edges, with their object information |
1171 | my $edge_ctr = 0; |
1172 | foreach my $e ( sort { $a->[0] cmp $b->[0] } $self->graph->edges ) { |
1173 | # Add an edge and fill in its relationship info. |
a30ca502 |
1174 | next unless( exists $node_hash->{$e->[0]} && exists $node_hash->{$e->[1]} ); |
c84275ff |
1175 | my $edge_el = $rgraph->addNewChild( $graphml_ns, 'edge' ); |
1176 | $edge_el->setAttribute( 'source', $node_hash->{$e->[0]} ); |
1177 | $edge_el->setAttribute( 'target', $node_hash->{$e->[1]} ); |
1178 | $edge_el->setAttribute( 'id', 'e'.$edge_ctr++ ); |
1179 | |
3ae5e2ad |
1180 | my $rel_obj = $self->get_relationship( @$e ); |
bbd064a9 |
1181 | foreach my $key ( keys %$edge_keys ) { |
1182 | my $value = $rel_obj->$key; |
1183 | _add_graphml_data( $edge_el, $edge_keys->{$key}, $value ) |
1184 | if defined $value; |
1185 | } |
c84275ff |
1186 | } |
cc31ebaa |
1187 | $rgraph->setAttribute( 'parse.edges', $edge_ctr ); |
c84275ff |
1188 | } |
1189 | |
1190 | sub _by_xmlid { |
2626f709 |
1191 | my $tmp_a = $a; |
1192 | my $tmp_b = $b; |
1193 | $tmp_a =~ s/\D//g; |
1194 | $tmp_b =~ s/\D//g; |
1195 | return $tmp_a <=> $tmp_b; |
c84275ff |
1196 | } |
1197 | |
1198 | sub _add_graphml_data { |
1199 | my( $el, $key, $value ) = @_; |
1200 | return unless defined $value; |
1201 | my $data_el = $el->addNewChild( $el->namespaceURI, 'data' ); |
1202 | $data_el->setAttribute( 'key', $key ); |
1203 | $data_el->appendText( $value ); |
83d5ac3a |
1204 | } |
1205 | |
63778331 |
1206 | sub throw { |
1207 | Text::Tradition::Error->throw( |
1208 | 'ident' => 'Relationship error', |
1209 | 'message' => $_[0], |
1210 | ); |
1211 | } |
1212 | |
22222af9 |
1213 | no Moose; |
1214 | __PACKAGE__->meta->make_immutable; |
1215 | |
1216 | 1; |