NAME

Math::NumSeq -- number sequences

SYNOPSIS

# only a base class, use one of the actual classes such as
use Math::NumSeq::Squares;
my $seq = Math::NumSeq::Squares->new;
my ($i, $value) = $seq->next;

DESCRIPTION

This is a base class for number sequences. Sequence objects can iterate through values, and some sequences have random access and predicate.

The idea is to generate things like squares or primes in a generic way. Some sequences, like squares, are so easy there's no need for this except for the genericness. Other sequences are trickier and an iterator is a good way to go through the values.

The intention is that all modules Math::NumSeq::Foo are sequence classes, and that supporting things are deeper, such as under Math::NumSeq::Something::Helper or Math::NumSeq::Base::SharedStuff.

FUNCTIONS

In the following "Foo" is one of the subclass names.

$seq = Math::NumSeq::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()

Rewind the sequence to its starting point.

$i = $seq->i_start()

Return the first index $i in the sequence. This is the position rewind() returns to.

$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 or infinity.

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

Return something if the sequence has a $key (a string) characteristic, or undef if not. This is intended as a loose set of features or properties a sequence might have.

digits            integer or undef, the radix if seq is digits
count             boolean, true if values are counts of something
smaller           boolean, true if v[i] < i, in general
integer           boolean, true if all values are integers

increasing        boolean, true if v[i+1] > v[i] always
non_decreasing    boolean, true if v[i+1] >= v[i] always
increasing_from_i     integer, i for which v[i+1] > v[i]
non_decreasing_from_i integer, i for which v[i+1] >= v[i]

$str = $seq->oeis_anum()

Return the A-number (a string) for Sloane's Online Encyclopedia of Integer Sequences of $seq, or return undef if not in the OEIS or not known. For example

my $seq = Math::NumSeq::Squares->new;
my $anum = $seq->oeis_anum;
# gives $anum eq "A000290"

The web page for that is then

http://oeis.org/A000290

Sometimes the OEIS has duplicates, ie. two A-numbers which are the same sequence. $seq->oeis_anum() is generally the primary one in cases where the duplication is accidental or historical.

$aref = Math::NumSeq::Foo->parameter_info_array()

@list = Math::NumSeq::Foo->parameter_info_list()

Return an arrayref of list describing the parameters taken by a given class. This meant to help making widgets etc for user interaction in a GUI. Each element is a hashref

{
  name        =>    parameter key arg for new()
  share_key   =>    string, or undef
  description =>    human readable string
  type        =>    string "integer","boolean","enum" etc
  default     =>    value
  minimum     =>    number, or undef
  maximum     =>    number, or undef
  width       =>    integer, suggested display size
  choices     =>    for enum, an arrayref     
}

type is a string, one of

"integer"
"enum"
"boolean"
"string"
"filename"

"filename" is separate from "string" since it might require subtly different handling to ensure it reaches Perl as a byte string, whereas a "string" type might in principle take Perl wide chars.

For "enum" the choices field is the possible values, such as

{ name => "flavour",
  type => "enum",
  choices => ["strawberry","chocolate"],
}

minimum and maximum are omitted (or undef) if there's no hard limit on the parameter.

share_key is designed to indicate when parameters from different NumSeq classes can be a single control widget in a GUI etc. Normally the name is enough, but when the same name has slightly different meanings in different classes a share_key allows the same meanings to be matched up.

Optional Methods

The following methods are only implemented for some sequences, since it's sometimes difficult to generate an arbitrary numbered element etc. Check with $seq->can('ith') etc before using.

$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 square or false if not.
$i = $seq->value_to_i_floor($value): Return the index i of $value, or if $value doesn't occur in the sequence then the i of the next lower value which does. This method only exists for non-decreasing sequences.
$i = $seq->value_to_i_estimate($value): Return an estimate of the i value corresponding to $value. This method only exists for non-decreasing sequences, and the accuracy of the estimate is unspecified, but when available it can at least hint at the growth rate.

HOME PAGE

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

LICENSE

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

To install Math::NumSeq, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Math::NumSeq

CPAN shell

perl -MCPAN -e shell
install Math::NumSeq

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

FUNCTIONS

Optional Methods

SEE ALSO

Other Modules Etc

HOME PAGE

LICENSE

NAME

SYNOPSIS

DESCRIPTION

FUNCTIONS

Optional Methods

SEE ALSO

Other Modules Etc

HOME PAGE

LICENSE

Module Install Instructions