.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Statistics::Basic::_TwoVectorBase 3pm" .TH Statistics::Basic::_TwoVectorBase 3pm "2012-01-23" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Statistics::Basic::_TwoVectorBase \- base class objects like Correlation .SH "METHODS" .IX Header "METHODS" .IP "\fB\f(BIquery()\fB\fR" 4 .IX Item "query()" Query the value of the object. It will return the undefined value until there's something to calculate. .IP "\fB\f(BIinsert()\fB\fR" 4 .IX Item "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. .Sp .Vb 2 \& # insert a 4 in one vector and a 3 in the other \& $object_instance\->insert( 4, 3 ); .Ve .IP "\fB\f(BIappend()\fB\fR \fB\f(BIginsert()\fB\fR" 4 .IX Item "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. .Sp .Vb 2 \& # append a 4 in one vector and a 3 in the other \& $object_instance\->ginsert( 4, 3 ); .Ve .IP "\fB\f(BIquery_size()\fB\fR" 4 .IX Item "query_size()" The current size of the vectors \*(-- regardless of their max size (as set by \&\*(L"\fIset_size()\fR\*(R"). This function returns a list, i.e.: .Sp .Vb 2 \& my @s = $obj\->query_size; # two values \& my $s = $obj\->query_size; # the right hand value of the list .Ve .IP "\fB\f(BIset_size()\fB\fR" 4 .IX Item "set_size()" Set the maximum size for the underlying Statistics::Basic::Vector objects. This function requires two arguments. .IP "\fB\f(BIset_vector()\fB\fR" 4 .IX Item "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. .Sp .Vb 3 \& my $v1 = vector \& my $v2 = $v1\->copy; \& $example_correlation\->set_vector($v1, $v2); .Ve .SH "OVERLOADS" .IX Header "OVERLOADS" This class provides overloads. If evaluated as a string, it will attempt to print a pretty value for the object (or \f(CW\*(C`n/a\*(C'\fR, see \*(L"\fIquery()\fR\*(R" above). the resulting string can be tuned, in terms of precision, see ipres for further information. .PP If evaluated as a number, it will try to return the raw result of \*(L"\fIquery()\fR\*(R", possibly turning the resulting \f(CW\*(C`undef\*(C'\fR (if applicable) into a \f(CW0\fR in the process \*(-- note that Perl does this \f(CW0\fR\-izing, not the overload. .PP The \f(CW\*(C`eq\*(C'\fR and \f(CW\*(C`==\*(C'\fR operators are also overloaded, trying to do the right thing. Also see toler for further information. .SH "AUTHOR" .IX Header "AUTHOR" Paul Miller \f(CW\*(C`\*(C'\fR .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2012 Paul Miller \*(-- Licensed under the \s-1LGPL\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIperl\fR\|(1), Statistics::Basic, Statistics::Basic::Vector