iPE::Util::BoundaryCoordinate(3)

NAME
iPE::Util::BoundaryCoordinate - The class for a boundary-relative coordinate.

DESCRIPTION
Many things in iPE are described relative to the two boundaries of an undetermined group of items, be it bases or features.

An example of this is the exon feature which occurs for all CDS features between the initial exon and the terminal exon. The description (in a 0-based index) of this with boundary-relative coordinates is (1, N-2).

FUNCTIONS

new (coordinate, letter)
    Pass in the coordinate as well as the letter which describes the coordinate as being relative to the end (usually "N" or "L").

clone ()
    Return a copy of the calling object

format ()
    Format a BoundaryCoordinate for outputting (returns a string).

coord ()
    Returns the coordinate as passed into the constructor.

numeral ()
    Returns the number without the letter in the coordinate.

letter ()
    Returns the letter representing the high end boundary of the set as passed into the constructor (usually "N" or "L").

isEnd ()
    Returns 1 if the coordinate is relative to the end-boundary.

translate (low, high)
    Translates a boundary coordinate given a low and high boundary of a real interval. If it is relative to the end boundary, the coordinate is translated by the end boundary, and if it is relative to the begin boundary, the coordinate is translated by the begin boundary.

cmp (a, b)
    Compares two boundary coordinates. Useful for sorting.

SEE ALSO
iPE::Interval

AUTHOR
Bob Zimmermann (rpz@cse.wustl.edu)

(and he just keeps getting better.)