NAME

App::MathImage::NumSeq::Sequence -- base class for number sequences

SYNOPSIS

 # only a base class, use one of the actual classes such as

 use App::MathImage::NumSeq::Sequence::Squares;
 my $seq = App::MathImage::NumSeq::Sequence::Squares->new;
 my ($i, $square) = $seq->next;

DESCRIPTION

This is a base class for number sequences.

FUNCTIONS

The following is a

$seq = App::MathImage::NumSeq::Sequence::Foo->new (key=>value,...)

Create and return a new sequence object.

($i, $value) = $seq->next()

Return the next index and value in the sequence.

$seq->rewind()

Return the sequence to its starting point.

$str = $seq->description()

A human-readable description of the sequence.

$value = $seq->values_min()

$value = $seq->values_max()

Return the minimum or maximum value taken by values in the sequence, or undef if unknown. Currently if the maximum is infinity then the return is undef too, but perhaps it should be a floating point infinity, if there is one.

$ret = $seq->characteristic($type)

Return true if the sequence is of the given $type (a string). This is intended as a loose set of types or properties a sequence might have. The following types exist currently,

    count   sequence is a count of something
    pn1     sequence is values +1, -1, 0
    digits  sequence is digits in a given radix

@infos = $seq->parameter_list()

Optional Methods

The following methods are only implemented for some sequences.

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

Return the $i'th value in the sequence. Only some sequence classes implement this method.

$bool = $seq->pred($value)

Return true if $value occurs in the sequence. For example for the squares this would return true if $value is a perfect square or false if not.

SEE ALSO

Math::Sequence and Math::Series, symbolic recursive definitions like Fibonacci

math-image

HOME PAGE

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

LICENSE

Copyright 2010, 2011 Kevin Ryde

Math-Image 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-Image 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-Image. If not, see <http://www.gnu.org/licenses/>.