François Fauteux > Seeder-0.01 > Seeder::Index

Download:
Seeder-0.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Seeder::Index - Index object

VERSION ^

Version 0.01

DESCRIPTION ^

This module provides the get_index method.

SYNOPSIS ^

    use Seeder::Index;
    my $index = Seeder::Index->new(
        seed_width    => "6",
        out_file     => "6.index",
    );
    $index -> get_index;

EXPORT ^

None by default

FUNCTIONS ^

new

 Title   : new
 Usage   : my $index = Seeder::Index->new(%args);
 Function: constructor for the Seeder::Index object
 Returns : new Seeder::Index object
 Args    :
    seed_width       # Seed width
    out_file         # Output file

get_index

 Title   : get_background
 Usage   : $background -> get_background;
 Function: coordination of the collection of index values
 Args    : none

_generate_index

 Title   : _generate_index
 Usage   : $self->_generate_index;
 Function: generate an index of neighbors for Hamming distances in the range
           from 0 to 3
 Returns : reference to a 2D array of indices
 Args    : none

_output_index

 Title   : _output_index
 Usage   : $self->_output_index;
 Function: writes index to output file
 Args    : none

AUTHOR ^

François Fauteux, <ffauteux at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-motif at rt.cpan.org, or at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Seeder. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Seeder

You can also look for information at:

ACKNOWLEDGEMENTS ^

This algorithm was developed by François Fauteux, Mathieu Blanchette and Martina Strömvik. We thank the Perl Monks <http://www.perlmonks.org/> for their support.

COPYRIGHT & LICENSE ^

Copyright 2008 François Fauteux, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: