1Statistics::Basic::_TwoUVseecrtoCroBnatsrei(b3u)ted PerlStDaotciusmteinctsa:t:iBoansic::_TwoVectorBase(3)
2
3
4

NAME

6       Statistics::Basic::_TwoVectorBase - base class objects like Correlation
7

METHODS

9       query()
10           Query the value of the object.  It will return the undefined value
11           until there's something to calculate.
12
13       insert()
14           Insert two new new values into the vectors.  This function must be
15           given precisely two arguments and probably shouldn't be undefined
16           values in most cases.
17
18               # insert a 4 in one vector and a 3 in the other
19               $object_instance->insert( 4, 3 );
20
21       append() ginsert()
22           The growing insert inserts new elements, growing the max size of
23           the vector to accommodate the new elements (if necessary).  This
24           function must be given precisely two arguments and probably
25           shouldn't be undefined values in most cases.
26
27               # append a 4 in one vector and a 3 in the other
28               $object_instance->ginsert( 4, 3 );
29
30       query_size()
31           The current size of the vectors -- regardless of their max size (as
32           set by "set_size()").  This function returns a list, i.e.:
33
34               my @s = $obj->query_size; # two values
35               my $s = $obj->query_size; # the right hand value of the list
36
37       set_size()
38           Set the maximum size for the underlying Statistics::Basic::Vector
39           objects.  This function requires two arguments.
40
41       set_vector()
42           Set the vector objects used to calculate the object's value.  This
43           function takes two arguments -- which can either be arrayrefs or
44           Statistics::Basic::Vector objects.  They must have the same number
45           of elements.
46
47               my $v1 = vector
48               my $v2 = $v1->copy;
49               $example_correlation->set_vector($v1, $v2);
50

OVERLOADS

52       This class provides overloads.  If evaluated as a string, it will
53       attempt to print a pretty value for the object (or "n/a", see "query()"
54       above).  the resulting string can be tuned, in terms of precision, see
55       ipres for further information.
56
57       If evaluated as a number, it will try to return the raw result of
58       "query()", possibly turning the resulting "undef" (if applicable) into
59       a 0 in the process -- note that Perl does this 0-izing, not the
60       overload.
61
62       The "eq" and "==" operators are also overloaded, trying to do the right
63       thing.  Also see toler for further information.
64

AUTHOR

66       Paul Miller "<jettero@cpan.org>"
67

69       Copyright 2009 Paul Miller -- Licensed under the LGPL
70

SEE ALSO

72       perl(1), Statistics::Basic, Statistics::Basic::Vector
73
74
75
76perl v5.12.3                      2009-06-2S8tatistics::Basic::_TwoVectorBase(3)
Impressum