GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Statistics::Basic::Mode(3) User Contributed Perl Documentation Statistics::Basic::Mode(3)

Statistics::Basic::Mode - find the mode of a list

Invoke it this way:

    my $mode = mode(1,2,3,3);

Or this way:

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

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

    print "The mod of $v1: $mod\n";
    my $mq = $mod->query;
    my $m0 = 0+$mod; # this will croak occasionally, see below

The mode of an array is not necessarily a scalar. The mode of this vector is a vector:

    my $mod = mode(1,2,3);
    my $v2  = $mod->query;

    print "hrm, there's three elements in this mode: $mod\n"
        if $mod->is_multimodal;

Create a 20 point "moving" mode like so:

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

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

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

    while( $sth->fetch ) {
        $mod->insert( $val );
        if( defined( my $m = $mod->query ) ) {
            print "Mode: $m\n";
        }

        print "Mode: $mod\n" if $mod->query_filled;
    }

new()
The constructor takes a list of values, a single array ref, or a single Statistics::Basic::Vector as arguments. It returns a Statistics::Basic::Mode object.

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

is_multimodal()
Statistics::Basic::Mode objects sometimes return Statistics::Basic::Vector objects instead of numbers. When "is_multimodal()" is true, the mode is a vector, not a scalar.
_OVB::import()
This module also inherits all the overloads and methods from Statistics::Basic::_OneVectorBase.

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).

If evaluated as a string, Statistics::Basic::Mode will try to format a number (like any other Statistics::Basic object), but if the object "is_multimodal()", it will instead return a Statistics::Basic::Vector for stringification.

    $x = mode(1,2,3);
    $y = mode(1,2,2);

    print "$x, $y\n"; # prints: [1, 2, 3], 2

If evaluated as a number, a Statistics::Basic::Mode will raise an error when the object "is_multimodal()".

Paul Miller "<jettero@cpan.org>"

Copyright 2012 Paul Miller -- Licensed under the LGPL

perl(1), Statistics::Basic, Statistics::Basic::_OneVectorBase, Statistics::Basic::Vector
2012-01-23 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.