class Bio::Map::Mapping
Description¶ ↑
Creates a new Bio::Map::Mapping object, which links Bio::Map::ActsAsMap- and Bio::Map::ActsAsMarker-like objects. This class is typically not accessed directly, but through map- or marker-like objects.
Attributes
location[RW]
map[RW]
marker[RW]
Public Class Methods
new(map, marker, location = nil)
click to toggle source
Creates a new Bio::Map::Mapping object
Arguments:
-
map: a Bio::Map::SimpleMap object
-
marker: a Bio::Map::Marker object
-
location: a Bio::Locations object
# File lib/bio/map.rb, line 304 def initialize (map, marker, location = nil) @map, @marker, @location = map, marker, location end
Public Instance Methods
<=>(other)
click to toggle source
Compares the location of this mapping to another mapping.
Arguments:
-
other_mapping: Bio::Map::Mapping object
- Returns
-
1 if self < other location
-
-1 if self > other location
-
0 if both location are the same
-
nil if the argument is not a Bio::Location object
# File lib/bio/map.rb, line 318 def <=>(other) unless other.kind_of?(Bio::Map::Mapping) raise "[Error] markers are not comparable" end unless @map.equal?(other.map) raise "[Error] maps have to be the same" end return self.location[0].<=>(other.location[0]) end