/ 
Do-1.88
River stage zero No dependents
/ Data::Object::Float

NAME

Data::Object::Float

ABSTRACT

Data-Object Float Class

SYNOPSIS

use Data::Object::Float;

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

DESCRIPTION

This package provides routines for operating on Perl 5 floating-point data.

INHERITANCE

This package inherits behaviors from:

Data::Object::Float::Base

INTEGRATIONS

This package integrates behaviors from:

Data::Object::Role::Dumpable

Data::Object::Role::Functable

Data::Object::Role::Throwable

LIBRARIES

This package uses type constraints defined by:

Data::Object::Library

METHODS

This package implements the following methods.

defined

defined() : NumObject

The defined method returns true if the object represents a value that meets the criteria for being defined, otherwise it returns false. This method returns a Data::Object::Number object.

defined example
# given $float

$float->defined; # 1

downto

downto(Int $arg1) : ArrayObject

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.

downto example
# given 1.23

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

eq

eq(Any $arg1) : NumObject

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

eq example
# given 1.23

$float->eq(1); # 0

ge

ge(Any $arg1) : NumObject

The ge method returns true if the argument provided is greater-than or equal-to the value represented by the object. This method returns a Data::Object::Number object.

ge example
# given 1.23

$float->ge(1); # 1

gt

gt(Any $arg1) : NumObject

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

gt example
# given 1.23

$float->gt(1); # 1

le

le(Any $arg1) : NumObject

The le method returns true if the argument provided is less-than or equal-to the value represented by the object. This method returns a Data::Object::Number object.

le example
# given 1.23

$float->le(1); # 0

lt

lt(Any $arg1) : NumObject

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

lt example
# given 1.23

$float->lt(1.24); # 1

ne

ne(Any $arg1) : NumObject

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

ne example
# given 1.23

$float->ne(1); # 1

to

to(Int $arg1) : ArrayObject

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.

to example
# given 1.23

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

upto

upto(Int $arg1) : Any

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.

upto example
# given 1.23

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

CREDITS

Al Newkirk, +319

Anthony Brummett, +10

Adam Hopkins, +2

José Joaquín Atria, +1

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

Copyright (C) 2011-2019, Al Newkirk, et al.

This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated here, https://github.com/iamalnewkirk/do/blob/master/LICENSE.

PROJECT

Wiki

Project

Initiatives

Milestones

Contributing

Issues

SEE ALSO

To get the most out of this distribution, consider reading the following:

Do

Data::Object

Data::Object::Class

Data::Object::ClassHas

Data::Object::Role

Data::Object::RoleHas

Data::Object::Library