File: links.rb

package info (click to toggle)
ruby-rgfa 1.3.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 824 kB
  • sloc: ruby: 5,649; makefile: 9
file content (242 lines) | stat: -rw-r--r-- 9,129 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
require_relative "error"

#
# Methods for the RGFA class, which allow to handle links in the graph.
#
module RGFA::Links

  def add_link(gfa_line)
    gfa_line = gfa_line.to_rgfa_line(validate: @validate)
    gfa_line.canonicize!
    l = nil
    if segment(gfa_line.from) and segment(gfa_line.to)
      l = link_from_to(gfa_line.oriented_from,
                       gfa_line.oriented_to,
                       gfa_line.overlap)
    end
    if l.nil?
      @links << gfa_line
      [:from, :to].each do |dir|
        segment_name = gfa_line.send(dir).to_sym
        orient = gfa_line.send(:"#{dir}_orient").to_sym
        if !@segments.has_key?(segment_name)
          raise RGFA::LineMissingError if @segments_first_order
          @segments[segment_name] =
            RGFA::Line::Segment.new({:name => segment_name},
                                    virtual: true)
        end
        @segments[segment_name].links[dir][orient] << gfa_line
        gfa_line.send(:"#{dir}=", @segments[segment_name])
      end
    elsif l.virtual?
      l.real!(gfa_line)
    else
      return
    end
  end
  protected :add_link

  # Deletes a link and all paths depending on it
  #
  # @param l [RGFA::Line::Link] link instance
  # @return [RGFA] self
  def delete_link(l)
    @links.delete(l)
    segment(l.from).links[:from][l.from_orient].delete(l)
    segment(l.to).links[:to][l.to_orient].delete(l)
    l.paths.each {|pt, orient| delete_path(pt)}
  end

  # Remove all links of a segment end end except that to the other specified
  # segment end.
  # @param segment_end [RGFA::SegmentEnd] the segment end
  # @param other_end [RGFA::SegmentEnd] the other segment end
  # @param conserve_components [Boolean] <i>(defaults to: +false+)</i>
  #   Do not remove links if removing them breaks the graph into unconnected
  #   components.
  # @return [RGFA] self
  def delete_other_links(segment_end, other_end, conserve_components: false)
    other_end = other_end.to_segment_end
    links_of(segment_end).each do |l|
      if l.other_end(segment_end) != other_end
        if !conserve_components or !cut_link?(l)
          delete_link(l)
        end
      end
    end
  end

  # All links of the graph
  # @return [Array<RGFA::Line::Link>]
  def links
    @links
  end

  # Finds links of the specified end of segment.
  #
  # @param [RGFA::SegmentEnd] segment_end a segment end
  #
  # @return [Array<RGFA::Line::Link>] if segment_end[1] == :E,
  #   links from sn with from_orient + and to sn with to_orient -
  # @return [Array<RGFA::Line::Link>] if segment_end[1] == :B,
  #   links to sn with to_orient + and from sn with from_orient -
  #
  # @note to add or remove links, use the appropriate methods;
  #   adding or removing links from the returned array will not work
  def links_of(segment_end)
    segment_end = segment_end.to_segment_end
    s = segment!(segment_end.segment)
    o = segment_end.end_type == :E ? [:+,:-] : [:-,:+]
    s.links[:from][o[0]] + s.links[:to][o[1]]
  end

  # Finds segment ends connected to the specified segment end.
  #
  # @param [RGFA::SegmentEnd] segment_end a segment end
  #
  # @return [Array<RGFA::SegmentEnd>>] segment ends connected by links
  #   to +segment_end+
  def neighbours(segment_end)
    links_of(segment_end).map {|l| l.other_end(segment_end) }
  end

  # Searches all links between +segment_end1+ and +segment_end2+
  #
  # @!macro [new] two_segment_ends
  #   @param segment_end1 [RGFA::SegmentEnd] a segment end
  #   @param segment_end2 [RGFA::SegmentEnd] a segment end
  # @return [Array<RGFA::Line::Link>] (possibly empty)
  def links_between(segment_end1, segment_end2)
    segment_end1 = segment_end1.to_segment_end
    segment_end2 = segment_end2.to_segment_end
    links_of(segment_end1).select do |l|
      l.other_end(segment_end1) == segment_end2
    end
  end

  # @!macro [new] link
  #   Searches a link between +segment_end1+ and +segment_end2+
  #   @!macro two_segment_ends
  #   @return [RGFA::Line::Link] the first link found
  # @return [nil] if no link is found.
  def link(segment_end1, segment_end2)
    segment_end1 = segment_end1.to_segment_end
    segment_end2 = segment_end2.to_segment_end
    links_of(segment_end1).each do |l|
      return l if l.other_end(segment_end1) == segment_end2
    end
    return nil
  end

  # @!macro link
  # @raise [RGFA::LineMissingError] if no link is found.
  def link!(segment_end1, segment_end2)
    l = link(segment_end1, segment_end2)
    raise RGFA::LineMissingError,
      "No link was found: "+
          "#{segment_end1.to_s} -- "+
          "#{segment_end2.to_s}" if l.nil?
    l
  end

  # Find links from the segment in the specified orientation
  # (or the equivalent links, i.e. to the segment in opposite orientation).
  #
  # @param [RGFA::OrientedSegment] oriented_segment a segment with orientation
  # @param equivalent [Boolean] return also equivalent links.
  # @return [Array<RGFA::Line::Link>]
  # @note to add or remove links, use the appropriate methods;
  #   adding or removing links from the returned array will not work
  def links_from(oriented_segment, equivalent = true)
    oriented_segment = oriented_segment.to_oriented_segment
    s = segment!(oriented_segment.segment)
    retval = s.links[:from][oriented_segment.orient]
    if equivalent
      retval + s.links[:to][oriented_segment.orient_inverted]
    else
      retval
    end
  end

  # Find links to the segment in the specified orientation
  # (or the equivalent links, i.e. from the segment in opposite orientation).
  #
  # @param [RGFA::OrientedSegment] oriented_segment a segment with orientation
  # @param equivalent [Boolean] return also equivalent links.
  # @return [Array<RGFA::Line::Link>]
  # @note to add or remove links, use the appropriate methods;
  #   adding or removing links from the returned array will not work
  def links_to(oriented_segment, equivalent = true)
    oriented_segment = oriented_segment.to_oriented_segment
    s = segment!(oriented_segment.segment)
    retval = s.links[:to][oriented_segment.orient]
    if equivalent
      retval + s.links[:from][oriented_segment.orient_inverted]
    else
      retval
    end
  end

  # Search all links from a segment S1 in a given orientation
  # to another segment S2 in a given, or the equivalent
  # links from S2 to S1 with inverted orientations.
  #
  # @param [RGFA::OrientedSegment] oriented_segment1 a segment with orientation
  # @param [RGFA::OrientedSegment] oriented_segment2 a segment with orientation
  # @param [RGFA::CIGAR] cigar shall match if not empty/undef
  # @param equivalent [Boolean] return also equivalent links.
  # @return [Array<RGFA::Line::Link>]
  # @note to add or remove links, use the appropriate methods;
  #   adding or removing links from the returned array will not work
  def links_from_to(oriented_segment1, oriented_segment2,
                    cigar = [], equivalent = true)
    oriented_segment1 = oriented_segment1.to_oriented_segment
    oriented_segment2 = oriented_segment2.to_oriented_segment
    links_from(oriented_segment1, equivalent).select do |l|
      l.compatible?(oriented_segment1, oriented_segment2, cigar, equivalent)
    end
  end

  # Search the link from a segment S1 in a given orientation
  # to another segment S2 in a given, or the equivalent
  # link from S2 to S1 with inverted orientations.
  #
  # @param [RGFA::OrientedSegment] oriented_segment1 a segment with orientation
  # @param [RGFA::OrientedSegment] oriented_segment2 a segment with orientation
  # @param [RGFA::CIGAR] cigar shall match if not empty/undef
  # @param equivalent [Boolean] return also equivalent links.
  # @return [RGFA::Line::Link] the first link found
  # @return [nil] if no link is found.
  def link_from_to(oriented_segment1, oriented_segment2,
                   cigar = [], equivalent = true)
    oriented_segment1 = oriented_segment1.to_oriented_segment
    oriented_segment2 = oriented_segment2.to_oriented_segment
    links_from(oriented_segment1, equivalent).select do |l|
      return l if l.compatible?(oriented_segment1, oriented_segment2,
                                cigar, equivalent)
    end
    return nil
  end

  # Search the link from a segment S1 in a given orientation
  # to another segment S2 in a given, or the equivalent
  # link from S2 to S1 with inverted orientations.
  #
  # @param [RGFA::OrientedSegment] oriented_segment1 a segment with orientation
  # @param [RGFA::OrientedSegment] oriented_segment2 a segment with orientation
  # @param [RGFA::CIGAR] cigar shall match if not empty/undef
  # @param equivalent [Boolean] return also equivalent links.
  # @return [RGFA::Line::Link] the first link found
  # @raise [RGFA::LineMissingError] if no link is found.
  def link_from_to!(oriented_segment1, oriented_segment2,
                    cigar = [], equivalent = true)
    l = link_from_to(oriented_segment1, oriented_segment2,
                     cigar, equivalent)
    raise RGFA::LineMissingError,
      "No link was found: "+
          "#{oriented_segment1.join(":")} -> "+
          "#{oriented_segment2.join(":")}" if l.nil?
    l
  end

end