The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Bubblegum-0.45
River stage zero No dependents
1 ++
/ Bubblegum::Object::Integer

NAME

Bubblegum::Object::Integer - Common Methods for Operating on Integers

VERSION

version 0.45

SYNOPSIS

    use Bubblegum;

    my $int = 10;
    say $int->downto(0); # [10,9,8,7,6,5,4,3,2,1,0]

DESCRIPTION

Integer methods work on data that meets the criteria for being an integer. An integer holds and manipulates an arbitrary sequence of bytes, typically representing numeric characters. Users of integers should be aware of the methods that modify the integer itself as opposed to returning a new integer. Unless stated, it may be safe to assume that the following methods copy, modify and return new integers based on their subjects. It is not necessary to use this module as it is loaded automatically by the Bubblegum class.

METHODS

downto

    my $int = 10;
    $int->downto(0); # [10,9,8,7,6,5,4,3,2,1,0]

The downto method returns an array reference containing a range of integers from the subject to the argument. Assumes the subject is greater than the argument.

eq

    my $int = 98765;
    $int->eq(98765); # true
    $int->eq('98765'); # true
    $int->eq(987650); # false

The eq method returns true if the argument matches the subject, otherwise returns false.

eqtv

    my $int = 123;
    $int->eqtv('123'); # 0; false
    $int->eqtv(123); # 1; true

The eqtv method returns true if the argument matches the subject's type and value, otherwise returns false. This function is akin to the strict-comparison operator in other languages.

format

    my $int = 500;
    $int->format('%.2f'); # 500.00

The format method returns an integer formatted using the argument as a template and the subject as a variable using the same conventions as the 'sprintf' function.

gt

    my $int = 1;
    $int->gt(0); # 1; true
    $int->gt(1); # 0; false

The gt method performs binary "greater than" and returns true if the subject is numerically greater than the argument. Note, this operation expects the argument to be numeric.

gte

    my $int = 1;
    $int->gte(0); # 1; true
    $int->gte(1); # 1; true
    $int->gte(2); # 0; false

The gte method performs binary "greater than or equal to" and returns true if the subject is numerically greater than or equal to the argument. Note, this operation expects the argument to be numeric.

lt

    my $int = 1;
    $int->lt(2); # 1; true
    $int->lt(1); # 0; false

The lt method performs binary "less than" and returns true if the subject is numerically less than the argument. Note, this operation expects the argument to be numeric.

lte

    my $int = 1;
    $int->lte(1); # 1; true
    $int->lte(2); # 1; true
    $int->lte(0); # 0; false

The lte method performs binary "less than or equal to" and returns true if the subject is numerically less than or equal to the argument. Note, this operation expects the argument to be numeric.

ne

    my $int = 1;
    $int->ne(2); # 1; true
    $int->ne(1); # 0; false

The ne method returns true if the argument does not match the subject, otherwise returns false.

to

    my $int = 5;
    $int->to(10); # [5,6,7,8,9,10]
    $int->to(0); # [5,4,3,2,1,0]

The to method returns an array reference containing a range of integers from the subject to the argument. If the subject is greater than the argument, the range generated will be from greastest to least, however, if the subject is less than the argument, the range generated will be from least to greatest.

upto

    my $int = 0;
    $int->upto(10); # [0,1,2,3,4,5,6,7,8,9,10]

The upto method returns an array reference containing a range of integers from the subject to the argument. Assumes the subject is lesser than the argument.

SEE ALSO

AUTHOR

Al Newkirk <anewkirk@ana.io>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Al Newkirk.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.