NAME

Math::NumSeq::PlanePathCoord -- sequence of coordinate values from a PlanePath module

SYNOPSIS

use Math::NumSeq::PlanePathCoord;
my $seq = Math::NumSeq::PlanePathCoord->new (planepath => 'SquareSpiral',
                                             coordinate_type => 'X');
my ($i, $value) = $seq->next;

DESCRIPTION

This is a tie-in to present coordinates from a Math::PlanePath module as a NumSeq sequence.

FUNCTIONS

$seq = Math::NumSeq::PlanePathCoord->new (planepath => $name, coordinate_type => 'X')

Create and return a new sequence object. The planepath option is the name of one of the Math::PlanePath modules.

coordinate_type (a string) is what coordinate from the path is wanted. The choices are

"X"          X coordinate
"Y"          Y coordinate
"Sum"        X+Y sum
"Radius"     sqrt(X^2+Y^2) radius 
"RSquared"   X^2+Y^2 radius squared

$value = $seq->ith($i)

Return the coordinate at N=$i in the PlanePath.

SEE ALSO

Math::NumSeq

HOME PAGE

http://user42.tuxfamily.org/math-planepath/index.html

LICENSE

Copyright 2011 Kevin Ryde

This file is part of Math-PlanePath.

Math-PlanePath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Math-PlanePath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Math-PlanePath. If not, see <http://www.gnu.org/licenses/>.