Class: Bio::Blast::Report::Iteration

Inherits:
Object
  • Object
show all
Defined in:
lib/bio/appl/blast/report.rb

Overview

Bio::Blast::Report::Iteration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeIteration

Returns a new instance of Iteration.



180
181
182
183
184
185
# File 'lib/bio/appl/blast/report.rb', line 180

def initialize
  @message = nil
  @statistics = {}
  @num = 1
  @hits = []
end

Instance Attribute Details

#hitsObject (readonly)

Returns an Array of Bio::Blast::Report::Hit objects.



187
188
189
# File 'lib/bio/appl/blast/report.rb', line 187

def hits
  @hits
end

#messageObject

Returns a String (or nil) containing execution message (typically “CONVERGED”).



199
200
201
# File 'lib/bio/appl/blast/report.rb', line 199

def message
  @message
end

#numObject

Returns the number of iteration counts.



195
196
197
# File 'lib/bio/appl/blast/report.rb', line 195

def num
  @num
end

#statisticsObject (readonly)

Returns a Hash containing execution statistics. Valid keys are: ‘db-len’, ‘db-num’, ‘eff-space’, ‘entropy’, ‘hsp-len’, ‘kappa’, ‘lambda’



192
193
194
# File 'lib/bio/appl/blast/report.rb', line 192

def statistics
  @statistics
end

Instance Method Details

#eachObject

Iterates on each Bio::Blast::Report::Hit object.



202
203
204
205
206
# File 'lib/bio/appl/blast/report.rb', line 202

def each
  @hits.each do |x|
    yield x
  end
end