The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Data-Object-0.90
River stage one • 1 direct dependent • 1 total dependent
13 ++
/ 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

Data::Object::Float provides routines 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.

METHODS

This package implements the following methods.

new

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

roles

  # given $float

  $float->roles;

The roles method returns the list of roles attached to object. This method returns a Data::Object::Array object.

rules

  my $rules = $float->rules();

The rules method returns consumed rules.

defined

  # 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 Data::Object::Number object.

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.

ge

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

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.

le

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

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.

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.

ROLES

This package inherits all behavior from the folowing role(s):

RULES

This package adheres to the requirements in the folowing rule(s):