| 1 |
package TFBS::Tools::SetOperations; |
| 2 |
use strict; |
| 3 |
|
| 4 |
use Bio::Root::Root; |
| 5 |
use vars qw'@ISA'; |
| 6 |
@ISA = qw'Bio::Root::Root'; |
| 7 |
|
| 8 |
|
| 9 |
sub new { |
| 10 |
my ($caller, @args) = @_; |
| 11 |
my $self = bless {}, ref $caller || $caller; |
| 12 |
my ($index_by, $strict, $output_type, $pairs) = |
| 13 |
$self->_rearrange([qw'INDEX_BY STRICT OUTPUT_TYPE PAIRS'], @args); |
| 14 |
$self->index_by($index_by); |
| 15 |
$self->strict($strict); |
| 16 |
$self->output_type($output_type); |
| 17 |
$self->pairs($pairs); |
| 18 |
return $self; |
| 19 |
} |
| 20 |
|
| 21 |
|
| 22 |
sub union { |
| 23 |
my ($self, @sets) = @_; |
| 24 |
my %union_index = |
| 25 |
map {$self->_index($_)} $self->_sets_to_arrayrefs(@sets); |
| 26 |
$self->_output(\%union_index); |
| 27 |
} |
| 28 |
|
| 29 |
|
| 30 |
sub intersection { |
| 31 |
my ($self, @sets) = @_; |
| 32 |
|
| 33 |
my @set_arrayrefs = $self->_sets_to_arrayrefs(@sets); |
| 34 |
#this would be faster, but we might want to retain the exact objects |
| 35 |
# that were present in |
| 36 |
#my @set_arrayrefs = sort {@$a <=> @$b} $self->_sets_to_arrayrefs(@sets); |
| 37 |
|
| 38 |
my %intersection_index = $self->_index(shift @set_arrayrefs); |
| 39 |
foreach my $set_arrayref (@set_arrayrefs) { |
| 40 |
my %curr_set_index = $self->_index($set_arrayref); |
| 41 |
my @help_array = %curr_set_index; |
| 42 |
|
| 43 |
foreach my $key (keys %intersection_index) { |
| 44 |
|
| 45 |
if (!exists $curr_set_index{$key}) { |
| 46 |
delete $intersection_index{$key} ; |
| 47 |
} |
| 48 |
} |
| 49 |
} |
| 50 |
$self->_output(\%intersection_index); |
| 51 |
} |
| 52 |
|
| 53 |
|
| 54 |
sub difference { |
| 55 |
# pairs only for now |
| 56 |
my ($self, @sets) = @_; |
| 57 |
my ($set1, $set2) = $self->_sets_to_arrayrefs(@sets); |
| 58 |
if (!defined $set2) { |
| 59 |
$self->throw ("'difference' needs exactly two sets as arguments"); |
| 60 |
} |
| 61 |
my %diff_index1 = $self->_index($set1); |
| 62 |
my %diff_index2 = $self->_index($set2); |
| 63 |
foreach my $key (keys %diff_index1) { |
| 64 |
if (exists $diff_index2{$key}) { |
| 65 |
delete $diff_index1{$key}; |
| 66 |
delete $diff_index2{$key}; |
| 67 |
} |
| 68 |
} |
| 69 |
wantarray ? ($self->_output(\%diff_index1), $self->_output(\%diff_index2)) |
| 70 |
: $self->_output(\%diff_index1); |
| 71 |
} |
| 72 |
|
| 73 |
|
| 74 |
sub index_by { |
| 75 |
my $self = shift; |
| 76 |
|
| 77 |
# By default, we are dealing with Bio::SeqFeatureI objects |
| 78 |
my @DEFAULTS = qw(primary_tag source_tag start end score strand); |
| 79 |
if (@_) { |
| 80 |
if(!defined $_[0]) { |
| 81 |
$self->{_index_by} = \@DEFAULTS; |
| 82 |
} |
| 83 |
elsif (ref($_[0]) eq "ARRAY") { |
| 84 |
$self->{_index_by} = $_[0]; |
| 85 |
} |
| 86 |
else { |
| 87 |
$self->{_index_by} = [@_]; |
| 88 |
} |
| 89 |
} |
| 90 |
return @{$self->{_index_by}}; |
| 91 |
} |
| 92 |
|
| 93 |
|
| 94 |
sub strict { |
| 95 |
my $self = shift; |
| 96 |
if (@_) { |
| 97 |
if ($self->{_strict} = shift) { |
| 98 |
$self->{_index_fn} = \&_index_strict; |
| 99 |
} |
| 100 |
else { |
| 101 |
$self->{_index_fn} = \&_index_by_annotation; |
| 102 |
} |
| 103 |
} |
| 104 |
return $self->{_strict}; |
| 105 |
} |
| 106 |
|
| 107 |
|
| 108 |
sub output_type { |
| 109 |
my $self = shift; |
| 110 |
if (@_) { |
| 111 |
unless ($self->{_output_type} = shift) { |
| 112 |
$self->{_output_type} = "arrayref" |
| 113 |
} |
| 114 |
} |
| 115 |
return $self->{_output_type}; |
| 116 |
} |
| 117 |
|
| 118 |
sub pairs { |
| 119 |
my $self = shift; |
| 120 |
if (@_) { |
| 121 |
if ($self->{_pairs} = shift and !$self->strict) { |
| 122 |
$self->{_index_fn} = \&_index_by_pair_annotation; |
| 123 |
} |
| 124 |
} |
| 125 |
return $self->{_pairs}; |
| 126 |
} |
| 127 |
|
| 128 |
sub _index { |
| 129 |
my ($self) = @_; |
| 130 |
$self->{_index_fn}->(@_); |
| 131 |
} |
| 132 |
|
| 133 |
|
| 134 |
sub _index_strict { |
| 135 |
my ($self, $set_arrayref) = @_; |
| 136 |
my %index_hash = (map {$_, $_} @$set_arrayref); |
| 137 |
return %index_hash; |
| 138 |
} |
| 139 |
|
| 140 |
|
| 141 |
sub _index_by_pair_annotation { |
| 142 |
my ($self, $set_arrayref) = @_; |
| 143 |
my %index_hash; |
| 144 |
foreach my $member (@$set_arrayref) { |
| 145 |
my @index_elements = ($self->_get_index_elements($member->feature1), |
| 146 |
$self->_get_index_elements($member->feature2)); |
| 147 |
$index_hash{join("::", @index_elements)} = $member; |
| 148 |
} |
| 149 |
return %index_hash; |
| 150 |
} |
| 151 |
|
| 152 |
|
| 153 |
sub _index_by_annotation { |
| 154 |
my ($self, $set_arrayref) = @_; |
| 155 |
my %index_hash; |
| 156 |
foreach my $member (@$set_arrayref) { |
| 157 |
my @index_elements = $self->_get_index_elements($member); |
| 158 |
$index_hash{join("::", @index_elements)} = $member; |
| 159 |
} |
| 160 |
return %index_hash; |
| 161 |
} |
| 162 |
|
| 163 |
sub _get_index_elements { |
| 164 |
my ($self, $set_member) = @_; |
| 165 |
my @index_elements; |
| 166 |
foreach my $method ($self->index_by) { |
| 167 |
if (ref($method) eq 'CODE') { |
| 168 |
push @index_elements, $method->($set_member); |
| 169 |
} |
| 170 |
else { |
| 171 |
eval { push @index_elements, $set_member->$method; }; |
| 172 |
if ($@) { |
| 173 |
$self->throw(sprintf("Could not use '%s' for indexing a %s object. The original error was:\n", |
| 174 |
$method, ref($set_member)).$@) |
| 175 |
} |
| 176 |
} |
| 177 |
} |
| 178 |
return @index_elements; |
| 179 |
} |
| 180 |
|
| 181 |
|
| 182 |
sub _sets_to_arrayrefs { |
| 183 |
my ($self, @sets) = @_; |
| 184 |
my @set_arrayrefs; |
| 185 |
foreach my $set (@sets) { |
| 186 |
if (ref($set) eq "ARRAY") { |
| 187 |
push @set_arrayrefs, $set; |
| 188 |
} |
| 189 |
elsif(ref($set) and $set->can("Iterator")) { |
| 190 |
my @set_elements; |
| 191 |
my $it = $set->Iterator; |
| 192 |
while (my $set_el = $it->next) { push @set_elements, $set_el } |
| 193 |
push @set_arrayrefs, \@set_elements; |
| 194 |
} |
| 195 |
else { |
| 196 |
$self->throw("Set must be an aray reference or have an ". |
| 197 |
"Iterator method. Got ".(ref($set or $set)). "instead."); |
| 198 |
} |
| 199 |
} |
| 200 |
return @set_arrayrefs; |
| 201 |
} |
| 202 |
|
| 203 |
sub _output { |
| 204 |
my ($self, $hashref) = @_; |
| 205 |
if ($self->output_type eq "arrayref") { |
| 206 |
return [values %$hashref]; |
| 207 |
} |
| 208 |
elsif ($self->output_type eq "array") { |
| 209 |
return %$hashref; |
| 210 |
} |
| 211 |
elsif ($self->output_type eq "matrix_set") { |
| 212 |
my $setobj = TFBS::MatrixSet->new; |
| 213 |
$setobj->add_Matrix(values %$hashref); |
| 214 |
return $setobj; |
| 215 |
} |
| 216 |
elsif ($self->output_type eq "site_set") { |
| 217 |
my $setobj = TFBS::SiteSet->new; |
| 218 |
$setobj->add_site(values %$hashref); |
| 219 |
return $setobj; |
| 220 |
} |
| 221 |
else { |
| 222 |
$self->throw($self->output_type." is not a supported output type"); |
| 223 |
} |
| 224 |
|
| 225 |
} |
| 226 |
1; |