← Back to branch summary

~ubuntu-branches/ubuntu/utopic/bioperl/utopic-proposed

« back to all changes in this revision

Viewing changes to Bio/Coordinate/MapperI.pm

  • Committer: Package Import Robot
  • Author(s): Charles Plessy
  • Date: 2014-07-13 19:16:01 UTC
  • mfrom: (1.2.9)
  • Revision ID: package-import@ubuntu.com-20140713191601-19sihuch2onuvbjg
Tags: 1.6.924-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Bio/Coordinate/MapperI.pm
1
 
#
2
 
# bioperl module for Bio::Coordinate::MapperI
3
 
#
4
 
# Please direct questions and support issues to <bioperl-l@bioperl.org> 
5
 
#
6
 
# Cared for by Heikki Lehvaslaiho <heikki-at-bioperl-dot-org>
7
 
#
8
 
# Copyright Heikki Lehvaslaiho
9
 
#
10
 
# You may distribute this module under the same terms as perl itself
11
 
 
12
 
# POD documentation - main docs before the code
13
 
 
14
 
=head1 NAME
15
 
 
16
 
Bio::Coordinate::MapperI - Interface describing coordinate mappers
 
1
package Bio::Coordinate::MapperI;
 
2
use utf8;
 
3
use strict;
 
4
use warnings;
 
5
use parent qw(Bio::Root::RootI);
 
6
 
 
7
# ABSTRACT: Interface describing coordinate mappers.
 
8
# AUTHOR:   Heikki Lehvaslaiho <heikki@bioperl.org>
 
9
# OWNER:    Heikki Lehvaslaiho
 
10
# LICENSE:  Perl_5
17
11
 
18
12
=head1 SYNOPSIS
19
13
 
24
18
MapperI defines methods for classes capable for mapping locations
25
19
between coordinate systems.
26
20
 
27
 
=head1 FEEDBACK
28
 
 
29
 
=head2 Mailing Lists
30
 
 
31
 
User feedback is an integral part of the evolution of this and other
32
 
Bioperl modules. Send your comments and suggestions preferably to the
33
 
Bioperl mailing lists  Your participation is much appreciated.
34
 
 
35
 
  bioperl-l@bioperl.org                  - General discussion
36
 
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
37
 
 
38
 
=head2 Support 
39
 
 
40
 
Please direct usage questions or support issues to the mailing list:
41
 
 
42
 
I<bioperl-l@bioperl.org>
43
 
 
44
 
rather than to the module maintainer directly. Many experienced and 
45
 
reponsive experts will be able look at the problem and quickly 
46
 
address it. Please include a thorough description of the problem 
47
 
with code and data examples if at all possible.
48
 
 
49
 
=head2 Reporting Bugs
50
 
 
51
 
report bugs to the Bioperl bug tracking system to help us keep track
52
 
the bugs and their resolution.  Bug reports can be submitted via the
53
 
web:
54
 
 
55
 
  https://redmine.open-bio.org/projects/bioperl/
56
 
 
57
 
=head1 AUTHOR - Heikki Lehvaslaiho
58
 
 
59
 
Email:  heikki-at-bioperl-dot-org
60
 
 
61
 
=head1 APPENDIX
62
 
 
63
 
The rest of the documentation details each of the object
64
 
methods. Internal methods are usually preceded with a _
65
 
 
66
21
=cut
67
22
 
68
 
 
69
 
# Let the code begin...
70
 
 
71
 
package Bio::Coordinate::MapperI;
72
 
use strict;
73
 
 
74
 
# Object preamble - inherits from Bio::Root::RootI
75
 
 
76
 
use base qw(Bio::Root::RootI);
77
 
 
78
 
 
79
 
 
80
23
=head2 in
81
24
 
82
25
 Title   : in
95
38
 
96
39
}
97
40
 
98
 
 
99
41
=head2 out
100
42
 
101
43
 Title   : out
120
62
 Function: Swap the direction of mapping: input <-> output)
121
63
 Example :
122
64
 Returns : 1
123
 
 Args    : 
 
65
 Args    :
124
66
 
125
67
=cut
126
68
 
148
90
   $self->throw_not_implemented();
149
91
}
150
92
 
151
 
 
152
93
=head2 map
153
94
 
154
95
 Title   : map
190
131
}
191
132
 
192
133
1;
193