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