File: rgl.rb

package info (click to toggle)
ruby-rgfa 1.3.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 820 kB
  • sloc: ruby: 5,649; makefile: 9
file content (194 lines) | stat: -rw-r--r-- 5,920 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
begin
  require "rgl/adjacency"
  require "rgl/implicit"
  require_relative "error"

  #
  # Conversion to RGL graphs
  #
  module RGFA::RGL

    # Creates an RGL graph.
    #
    # @param oriented [Boolean] (defaults to: <i>+true+</i>) may the graph
    #   contain links of segments in different orientation?
    # @return [RGL::ImplicitGraph] an rgl implicit directed graph
    def to_rgl(oriented: true)
      if oriented
        to_rgl_oriented
      else
        to_rgl_unoriented
      end
    end

    # Creates an RGL graph, including links orientations.
    #
    # @return [RGL::ImplicitGraph] an rgl implicit directed graph;
    #   where vertices are [RGFA::Segment, orientation] pairs
    #   (instances of the RGFA::OrientedSegment subclass of Array)
    def to_rgl_oriented
      RGL::ImplicitGraph.new do |g|
        g.vertex_iterator do |block|
          self.each_segment do |segment|
            [:+, :-].each do |orient|
              block.call([segment, orient].to_oriented_segment)
            end
          end
        end
        g.adjacent_iterator do |oriented_segment, block|
          s = segment(oriented_segment.segment)
          o = oriented_segment.orient
          s.links[:from][o].each do |l|
            os = [segment(l.to), l.to_orient].to_oriented_segment
            block.call(os)
          end
          o = oriented_segment.invert_orient
          s.links[:to][o].each do |l|
            os = [segment(l.from), l.from_orient].to_oriented_segment
            block.call(os.invert_orient)
          end
        end
        g.directed = true
      end
    end

    # Creates an RGL graph, assuming that all links orientations
    # are "+".
    #
    # @raise [RGFA::RGL::ValueError] if the graph contains any link where
    #   from_orient or to_orient is :-
    # @return [RGL::ImplicitGraph] an rgl implicit directed graph;
    #   where vertices are RGFA::Segment objects
    def to_rgl_unoriented
      RGL::ImplicitGraph.new do |g|
        g.vertex_iterator {|block| self.each_segment {|s| block.call(s)}}
        g.adjacent_iterator do |s, bl|
          s = segment(s)
          s.links[:from][:+].each do |l|
            if l.to_orient == :-
              raise RGFA::RGL::ValueError,
                "Graph contains links with segments in reverse orientations"
            end
            bl.call(segment(l.to))
          end
          if s.links[:from][:-].size > 0
            raise RGFA::RGL::ValueError,
              "Graph contains links with segments in reverse orientations"
          end
        end
        g.directed = true
      end
    end

    def self.included(base)
      base.extend(ClassMethods)
    end

    module ClassMethods

      # @param g [RGL::ImplicitGraph, RGL::DirectedAdjacencyGraph] an RGL graph.
      #
      # @!macro[new] from_rgl
      #   <b>Accepted vertex formats</b>:
      #
      #   - RGFA::OrientedSegment, or Array which can be converted to it;
      #     where the first element is a <i>segment specifier</i> (see below)
      #   - <i>segment specifier</i> alone: the orientation is assumed to be :+
      #
      #   The <i>segment specifier</i> can be:
      #   - RGFA::Segment instance
      #   - String, segment representation (e.g. "S\tsegment\t*")
      #   - String, valid segment name (e.g. "segment")
      #
      #   @raise [RGFA::RGL::InvalidFormatError] if the graph cannot be
      #     converted
      #
      #   @return [RGFA] a new RGFA instance
      def from_rgl(g)
        gfa = RGFA.new
        if not (g.respond_to?(:each_vertex) and
                g.respond_to?(:each_edge))
          raise RGFA::RGL::InvalidFormatError,
            "#{g} is not a valid RGL graph"
        end
        if not g.directed?
          raise RGFA::RGL::InvalidFormatError,
            "#{g} is not a directed graph"
        end
        g.each_vertex {|v| add_segment_if_new(gfa, v)}
        g.each_edge do |s, t|
          gfa << RGFA::Line::Link.new(segment_name_and_orient(s) +
                                      segment_name_and_orient(t) +
                                      ["*"])
        end
        gfa
      end

      private

      def add_segment_if_new(gfa, v)
        # RGFA::OrientedSegment or GFA::GraphVertex
        v = v.segment if v.respond_to?(:segment)
        if v.kind_of?(Symbol)
          # segment name as symbol
          return if gfa.segment_names.include?(v)
          v = RGFA::Line::Segment.new([v.to_s, "*"])
        elsif v.kind_of?(String)
          a = v.split("\t")
          if a[0] == "S"
            # string representation of segment
            return if gfa.segment_names.include?(a[1].to_sym)
            v = RGFA::Line::Segment.new(a[1..-1])
          else
            # segment name as string
            return if gfa.segment_names.include?(v.to_sym)
            v = RGFA::Line::Segment.new([v, "*"])
          end
        end
        return if gfa.segment_names.include?(v.name)
        gfa << v
      end

      def segment_name_and_orient(s)
        # default orientation
        o = s.respond_to?(:orient) ? s.orient.to_s : "+"
        # RGFA::Line::Segment (also embedded in RGFA::OrientedSegment)
        if s.respond_to?(:name)
          s = s.name.to_s
        elsif s.respond_to?(:segment)
          # GFA::GraphVertex
          s = s.segment.to_s
        elsif s.respond_to?(:split)
          a = s.split("\t")
          s = a[1] if a[0] == "S"
        else
          s = s.to_s
        end
        return s, o
      end

    end

  end

  module RGL::Graph

    # @!macro from_rgl
    def to_rgfa
      RGFA.from_rgl(self)
    end

  end

  # Exception raised if conversion is impossible due to unexpected values
  class RGFA::RGL::ValueError < RGFA::Error; end

  # Exception raised if conversion is impossible due to general format problems
  class RGFA::RGL::InvalidFormatError < RGFA::Error; end

rescue LoadError

  module RGFA::RGL
  end

end