Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

statistics::basic::_onevectorbase(3pm) [debian man page]

Statistics::Basic::_OneVectorBase(3pm)			User Contributed Perl Documentation		    Statistics::Basic::_OneVectorBase(3pm)

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

perl v5.14.2							    2012-01-23				    Statistics::Basic::_OneVectorBase(3pm)

Check Out this Related Man Page

Statistics::Basic::Mean(3pm)				User Contributed Perl Documentation			      Statistics::Basic::Mean(3pm)

NAME

       Statistics::Basic::Mean - find the mean of a list

SYNOPSIS

       Invoke it this way:

	   my $avg = mean(1,2,3);

       Or this way:

	   my $v1  = vector(1,2,3);
	   my $avg = avg($v1);

       And then either query the values or print them like so:

	   print "The mean of $v1: $avg
";
	   my $mq = $avg->query;
	   my $m0 = 0+$avg;

       Create a 20 point moving average like so:

	   use Statistics::Basic qw(:all nofill);

	   my $sth = $dbh->prepare("select col1 from data where something");
	   my $len = 20;
	   my $avg = mean()->set_size($len);

	   $sth->execute or die $dbh->errstr;
	   $sth->bind_columns( my $val ) or die $dbh->errstr;

	   while( $sth->fetch ) {
	       $avg->insert( $val );
	       if( defined( my $m = $avg->query ) ) {
		   print "Mean: $m
";
	       }

	       # This would also work:
	       # print "Mean: $avg
" if $avg->query_filled;
	   }

METHODS

       new()
	   The constructor takes a single array ref or a single Statistics::Basic::Vector as arguments.  It returns a Statistics::Basic::Mean
	   object.

	   Note: normally you'd use the mean() constructor, rather than building these by hand using "new()".

       _OVB::import()
	   This module also inherits all the overloads and methods from Statistics::Basic::_OneVectorBase.

OVERLOADS

       This object is overloaded.  It tries to return an appropriate string for the calculation or the value of the computation in numeric
       context.

       In boolean context, this object is always true (even when empty).

AUTHOR

       Paul Miller "<jettero@cpan.org>"

COPYRIGHT

       Copyright 2012 Paul Miller -- Licensed under the LGPL

SEE ALSO

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

perl v5.14.2							    2012-01-23					      Statistics::Basic::Mean(3pm)
Man Page