Andrew Main (Zefram) > Math-Interpolator > Math::Interpolator::Knot

Download:
Math-Interpolator-0.005.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.005   Source  

NAME ^

Math::Interpolator::Knot - x/y point for use in interpolation

SYNOPSIS ^

        use Math::Interpolator::Knot;

        $pt = Math::Interpolator::Knot->new($x, $y);

        $x = $pt->x;
        $y = $pt->y;

        $role = $pt->role;

DESCRIPTION ^

An object of this type represents a single known point on a one-dimensional curve. It is intended for use with Math::Interpolator, which will interpolate a curve between known points. These points are known as "knots".

CONSTRUCTOR ^

Math::Interpolator::Knot->new(X, Y)

Creates and returns a new knot object with the specified x and y coordinates.

METHODS ^

$pt->x

Returns the x coordinate of the knot.

$pt->y

Returns the y coordinate of the knot.

$pt->role

Returns the string "KNOT". This is used to distinguish knots from other types of entity that could appear in an interpolator's point list.

SUBCLASSING ^

The interpolator uses only this public interface, so it is acceptable to substitute any other class that implements this interface. This may be done by subclassing this class, or by reimplementing all three methods independently. This is useful, for example, if the exact coordinates are expensive to calculate and it is desired to perform lazy evaluation with memoisation.

SEE ALSO ^

Math::Interpolator, Math::Interpolator::Source

AUTHOR ^

Andrew Main (Zefram) <zefram@fysh.org>

COPYRIGHT ^

Copyright (C) 2006, 2007, 2009, 2010, 2012 Andrew Main (Zefram) <zefram@fysh.org>

LICENSE ^

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

syntax highlighting: