NAME

Data::Object::Float - A Float Object for Perl 5

VERSION

version 0.16

SYNOPSIS

    use Data::Object::Float;

    my $float = Data::Object::Float->new(9.9999);

DESCRIPTION

Data::Object::Float provides common methods for operating on Perl 5 floating-point data. Float methods work on data that meets the criteria for being a floating-point number. A float holds and manipulates an arbitrary sequence of bytes, typically representing numberic characters with decimals. Users of floats should be aware of the methods that modify the float itself as opposed to returning a new float. Unless stated, it may be safe to assume that the following methods copy, modify and return new floats based on their function.

COMPOSITION

This class inherits all functionality from the Data::Object::Role::Float role and implements proxy methods as documented herewith.

METHODS

downto

    # given 1.23

    $float->downto(0); # [1,0]

The downto method returns an array reference containing integer decreasing values down to and including the limit. This method returns a Data::Object::Array object.

eq

    # given 1.23

    $float->eq(1); # 0

The eq method performs a numeric equality operation. This method returns a Data::Object::Number object representing a boolean.

gt

    # given 1.23

    $float->gt(1); # 1

The gt method performs a numeric greater-than comparison. This method returns a Data::Object::Number object representing a boolean.

gte

    # given 1.23

    $float->gte(1.23); # 1

The gte method performs a numeric greater-than-or-equal-to comparison. This method returns a Data::Object::Number object representing a boolean.

lt

    # given 1.23

    $float->lt(1.24); # 1

The lt method performs a numeric less-than comparison. This method returns a Data::Object::Number object representing a boolean.

lte

    # given 1.23

    $float->lte(1.23); # 1

The lte method performs a numeric less-than-or-equal-to comparison. This method returns a Data::Object::Number object representing a boolean.

ne

    # given 1.23

    $float->ne(1); # 1

The ne method performs a numeric equality operation. This method returns a Data::Object::Number object representing a boolean.

to

    # given 1.23

    $float->to(2); # [1,2]
    $float->to(0); # [1,0]

The to method returns an array reference containing integer increasing or decreasing values to and including the limit in ascending or descending order based on the value of the floating-point object. This method returns a Data::Object::Array object.

upto

    # given 1.23

    $float->upto(2); # [1,2]

The upto method returns an array reference containing integer increasing values up to and including the limit. This method returns a Data::Object::Array object.

OPERATORS

This class overloads the following operators for your convenience.

bool

    !!$float

    # equivilent to

    $float->data

string

    "$float"

    # equivilent to

    $float->data

smartmatch

    $value ~~ $float

    # equivilent to

    $float->data

SEE ALSO

• Data::Object::Array

• Data::Object::Code

• Data::Object::Float

• Data::Object::Hash

• Data::Object::Integer

• Data::Object::Number

• Data::Object::Regexp

• Data::Object::Scalar

• Data::Object::String

• Data::Object::Undef

• Data::Object::Universal

• Data::Object::Autobox

AUTHOR

Al Newkirk <anewkirk@ana.io>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 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.

cpanm Data::Object

perl -MCPAN -e shell
install Data::Object