Data::Object::Role::Float - Float Object Role for Perl 5
version 0.59
use Data::Object::Class; with 'Data::Object::Role::Float';
Data::Object::Role::Float provides routines for operating on Perl 5 floating-point data.
# given $float $float->data; # original value
The data method returns the original and underlying value contained by the object. This method is an alias to the detract method.
# given $float $float->defined; # 1
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 number object.
# given $float $float->detract; # original value
The detract method returns the original and underlying value contained by the object.
# 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 array object.
# given 1.23 $float->dump; # '1.23'
The dump method returns returns a string representation of the object. This method returns a string value.
# given 1.23 $float->eq(1); # 0
The eq method performs a numeric equality operation. This method returns a number object representing a boolean.
# given 1.23 $float->ge(1); # 1
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.
# given 1.23 $float->gt(1); # 1
The gt method performs a numeric greater-than comparison. This method returns a number object representing a boolean.
# given 1.23 $float->le(1); # 0
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.
# given 1.23 $float->lt(1.24); # 1
The lt method performs a numeric less-than comparison. This method returns a number object representing a boolean.
# given $float $float->methods;
The methods method returns the list of methods attached to object. This method returns an array value.
# given 1.23 $float->ne(1); # 1
The ne method performs a numeric equality operation. This method returns a number object representing a boolean.
# given 9.9999 my $float = Data::Object::Float->new(9.9999);
The new method expects a floating-point number and returns a new class instance.
# given 1.23 $float->print; # '1.23'
The print method outputs the value represented by the object to STDOUT and returns true. This method returns a number value.
# given $float $float->roles;
The roles method returns the list of roles attached to object. This method returns an array value.
# given 1.23 $float->say; # '1.23\n'
The say method outputs the value represented by the object appended with a newline to STDOUT and returns true. This method returns a Data::Object::Number object.
# given $float $float->throw;
The throw method terminates the program using the core die keyword, passing the object to the Data::Object::Exception class as the named parameter object. If captured this method returns an exception value.
object
# 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 array object.
# given $float $float->type; # FLOAT
The type method returns a string representing the internal data type object name. This method returns a string value.
# 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 array object.
This package is comprised of the following roles.
Data::Object::Role::Comparison
Data::Object::Role::Defined
Data::Object::Role::Detract
Data::Object::Role::Dumper
Data::Object::Role::Item
Data::Object::Role::Numeric
Data::Object::Role::Output
Data::Object::Role::Throwable
Data::Object::Role::Type
Data::Object::Role::Value
Data::Object::Array
Data::Object::Class
Data::Object::Class::Syntax
Data::Object::Code
Data::Object::Float
Data::Object::Hash
Data::Object::Integer
Data::Object::Number
Data::Object::Role
Data::Object::Role::Syntax
Data::Object::Regexp
Data::Object::Scalar
Data::Object::String
Data::Object::Undef
Data::Object::Universal
Data::Object::Autobox
Data::Object::Immutable
Data::Object::Library
Data::Object::Prototype
Data::Object::Signatures
Al Newkirk <anewkirk@ana.io>
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.
To install Data::Object, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Object
CPAN shell
perl -MCPAN -e shell install Data::Object
For more information on module installation, please visit the detailed CPAN module installation guide.