Bio::FastParsers::Blast::Xml::Iteration - NCBI BLAST DTD-derived internal class
version 0.173450
# TODO
ArrayRef of Bio::FastParsers::Blast::Xml::Hit
Bio::FastParsers::Blast::Xml::Statistics composed object
Returns the number of Hits of the Iteration.
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration my $count = $iteration->count_hits;
This method does not accept any arguments.
Returns all the Hits of the Iteration (not an array reference).
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration my @hits = $iteration->all_hits;
Returns one Hit of the Iteration by its index. You can also use negative index numbers, just as with Perl's core array handling. If the specified Hit does not exist, this method will return undef.
undef
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration my $hit = $iteration->get_hit($index); croak "Hit $index not found!" unless defined $hit;
This method accepts just one argument (and not an array slice).
Shifts the first Hit of the array off and returns it, shortening the array by 1 and moving everything down. If there are no more Hits in the array, returns undef.
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration while (my $hit = $iteration->next_hit) { # process $hit # ... }
Returns the value of the element <Iteration_iter-num>.
<Iteration_iter-num
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration my $iter_num = $iteration->iter_num;
Returns the value of the element <Iteration_message>.
<Iteration_message
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration my $message = $iteration->message;
Returns the value of the element <Iteration_query-def>.
<Iteration_query-def
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration my $query_def = $iteration->query_def;
Returns the value of the element <Iteration_query-ID>.
<Iteration_query-ID
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration my $query_id = $iteration->query_id;
Returns the value of the element <Iteration_query-len>.
<Iteration_query-len
# $iteration is a Bio::FastParsers::Blast::Xml::Iteration my $query_len = $iteration->query_len;
Alias for stat method. For API consistency.
stat
Alias for iter_num method. For API consistency.
iter_num
Denis BAURAIN <denis.baurain@uliege.be>
This software is copyright (c) 2013 by University of Liege / Unit of Eukaryotic Phylogenomics / Denis BAURAIN.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Bio::FastParsers, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Bio::FastParsers
CPAN shell
perl -MCPAN -e shell install Bio::FastParsers
For more information on module installation, please visit the detailed CPAN module installation guide.