Paul Miller > Statistics-Basic-1.6607 > Statistics::Basic::_OneVectorBase

Download:
Statistics-Basic-1.6607.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

Statistics::Basic::_OneVectorBase - base class objects like Mean

METHODS ^

query()

Query the value of the object. It will return the undefined value until there's something to calculate (or until the vector is full when nofill is in effect).

insert()

Insert new values into the vector.

    $object_instance->insert( 4, 3 ); # insert a 3 and a 4

This function returns the object itself, for chaining purposes.

append() ginsert()

The growing insert inserts new elements, growing the max size of the vector to accommodate the new elements (if necessary).

    $object_instance->ginsert( 4, 3 ); # append a 3 and a 4

This function returns the object itself, for chaining purposes.

query_size()

The current size of the vector -- regardless of its max size (as set by "set_size()").

query_vector()

Returns the Statistics::Basic::Vector object used by the computational object.

set_size()

Set the maximum size for the underlying Statistics::Basic::Vector object. This function requires one arguments.

Unless nofill is set, the vector will be filled with 0s (assuming the vector wouldn't otherwise be full) on the oldest side of the vector (so an insert will push off one of the filled-zeros).

This function returns the object itself, for chaining purposes.

set_vector()

Given a vector or array ref, this will set the contents (and size) of the vector used for the object computations.

This function returns the object itself, for chaining purposes.

OVERLOADS ^

This class provides overloads. If evaluated as a string, it will attempt to print a pretty value for the object (or n/a, see "query()" above). the resulting string can be tuned, in terms of precision, see ipres for further information.

If evaluated as a number, it will try to return the raw result of "query()", possibly turning the resulting undef (if applicable) into a 0 in the process -- note that Perl does this 0-izing, not the overload.

The eq and == operators are also overloaded, trying to do the right thing. Also see toler for further information.

AUTHOR ^

Paul Miller <jettero@cpan.org>

COPYRIGHT ^

Copyright 2012 Paul Miller -- Licensed under the LGPL

SEE ALSO ^

perl(1), Statistics::Basic, Statistics::Basic::Vector

syntax highlighting: