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


Math-Interpolator documentation Contained in the Math-Interpolator distribution.

Index


Code Index:

NAME

Top

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

SYNOPSIS

Top

	use Math::Interpolator::Knot;

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

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

	$role = $pt->role;

DESCRIPTION

Top

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

Top

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

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

METHODS

Top

$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

Top

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

Top

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

AUTHOR

Top

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

COPYRIGHT

Top

LICENSE

Top

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


Math-Interpolator documentation Contained in the Math-Interpolator distribution.
package Math::Interpolator::Knot;

{ use 5.006; }
use warnings;
use strict;

our $VERSION = "0.004";

sub new { bless({ x => $_[1], y => $_[2] }, $_[0]) }

sub x { $_[0]->{x} }

sub y { $_[0]->{y} }

sub role { "KNOT" }

1;