NAME

Math::NumSeq::PlanePathN -- sequence of N values from PlanePath module

SYNOPSIS

use Math::NumSeq::PlanePathN;
my $seq = Math::NumSeq::PlanePathN->new (planepath => 'SquareSpiral',
                                         line_type => 'X_axis');
my ($i, $value) = $seq->next;

DESCRIPTION

This module presents N values from a Math::PlanePath as a sequence. The default is the X axis, or the line_type parameter (a string) can choose among

"X_axis"        X axis
"Y_axis"        Y axis
"Diagonal"      leading diagonal X=Y

For example the SquareSpiral X axis starts i=0 with values 1, 2, 11, 28, 53, 86, etc.

The behaviour on paths which don't cover all points on the respective axis is unspecified as yet.

FUNCTIONS

$seq = Math::NumSeq::PlanePathN->new (key=>value,...)

Create and return a new sequence object. The options are

planepath          string, name of a PlanePath module
planepath_object   PlanePath object
line_type          string, as described above

planepath can be just the module part such as "SquareSpiral" or a full class name "Math::PlanePath::SquareSpiral".

SEE ALSO

Math::NumSeq, Math::NumSeq::PlanePathCoord, Math::NumSeq::PlanePathDelta

HOME PAGE

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

LICENSE

Copyright 2011, 2012 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/>.