class Bio::FlatFileIndex::Results

Results stores search results created by Bio::FlatFileIndex methods.

Currently, this class inherits Hash, but internal structure of this class may be changed anytime. Only using methods described below are strongly recomended.

Public Instance Methods

*(a) click to toggle source

Returns set intersection of results. “a * b” means “a AND b”.

  • Example

    # I want to search 'HIS_KIN' AND 'human'
    db = Bio::FlatFIleIndex.new(location)
    hk = db.search('HIS_KIN')
    hu = db.search('human')
    # hk and hu are Bio::FlatFileIndex::Results objects.
    print hk * hu
    
# File lib/bio/io/flatfile/index.rb, line 351
def *(a)
  raise 'argument must be Results class' unless a.is_a?(self.class)
  res = self.class.new
  a.each_key { |x| res.store(x, a[x]) if self[x] }
  res
end
+(a) click to toggle source

Add search results. “a + b” means “a OR b”.

  • Example

    # I want to search 'ADH_IRON_1' OR 'ADH_IRON_2'
    db = Bio::FlatFIleIndex.new(location)
    a1 = db.search('ADH_IRON_1')
    a2 = db.search('ADH_IRON_2')
    # a1 and a2 are Bio::FlatFileIndex::Results objects.
    print a1 + a2
    
# File lib/bio/io/flatfile/index.rb, line 334
def +(a)
  raise 'argument must be Results class' unless a.is_a?(self.class)
  res = self.dup
  res.update(a)
  res
end
each() { |str| ... } click to toggle source

Iterates over each result (string). Same as to_a.each.

# File lib/bio/io/flatfile/index.rb, line 374
def each(&x) #:yields: str
  each_value(&x)
end
size() click to toggle source

Returns number of results. Same as to_a.size.

# File lib/bio/io/flatfile/index.rb, line 392
def size; end
to_a() click to toggle source

Returns an array of strings. If no search results are exist, returns an empty array.

# File lib/bio/io/flatfile/index.rb, line 388
def to_a; values; end
to_s() click to toggle source

Returns a string. (concatinated if multiple results exists). Same as to_a.join('').

# File lib/bio/io/flatfile/index.rb, line 361
def to_s
  self.values.join
end