Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Statistics::Basic::_TwUsertContributed PerStatistics::Basic::_TwoVectorBase(3)

NAME
       Statistics::Basic::_TwoVectorBase - base	class objects like Correlation

METHODS
       query()
	   Query the value of the object.  It will return the undefined	value
	   until there's something to calculate.

       insert()
	   Insert two new new values into the vectors.	This function must be
	   given precisely two arguments and probably shouldn't	be undefined
	   values in most cases.

	       # insert	a 4 in one vector and a	3 in the other
	       $object_instance->insert( 4, 3 );

       append()	ginsert()
	   The growing insert inserts new elements, growing the	max size of
	   the vector to accommodate the new elements (if necessary).  This
	   function must be given precisely two	arguments and probably
	   shouldn't be	undefined values in most cases.

	       # append	a 4 in one vector and a	3 in the other
	       $object_instance->ginsert( 4, 3 );

       query_size()
	   The current size of the vectors -- regardless of their max size (as
	   set by "set_size()").  This function	returns	a list,	i.e.:

	       my @s = $obj->query_size; # two values
	       my $s = $obj->query_size; # the right hand value	of the list

       set_size()
	   Set the maximum size	for the	underlying Statistics::Basic::Vector
	   objects.  This function requires two	arguments.

       set_vector()
	   Set the vector objects used to calculate the	object's value.	 This
	   function takes two arguments	-- which can either be arrayrefs or
	   Statistics::Basic::Vector objects.  They must have the same number
	   of elements.

	       my $v1 =	vector
	       my $v2 =	$v1->copy;
	       $example_correlation->set_vector($v1, $v2);

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.24.1			  2012-01-Statistics::Basic::_TwoVectorBase(3)

NAME | METHODS | OVERLOADS | AUTHOR | COPYRIGHT | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Statistics::Basic::_TwoVectorBase&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help