NAME

Data::Object::Float

ABSTRACT

Float Class for Perl 5

SYNOPSIS

  package main;

  use Data::Object::Float;

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

DESCRIPTION

This package provides methods for manipulating float data.

INHERITS

This package inherits behaviors from:

Data::Object::Kind

INTEGRATES

This package integrates behaviors from:

Data::Object::Role::Dumpable

Data::Object::Role::Proxyable

Data::Object::Role::Throwable

LIBRARIES

This package uses type constraints from:

Data::Object::Types

METHODS

This package implements the following methods:

defined

  defined() : Num

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

defined example #1

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

  $float->defined; # 1

downto

  downto(Int $arg1) : ArrayRef

The downto method returns an array reference containing integer decreasing values down to and including the limit.

downto example #1

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

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

eq

  eq(Any $arg1) : Num

The eq method performs a numeric equality operation.

eq example #1

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

  $float->eq(1); # 0

ge

  ge(Any $arg1) : Num

The ge method returns true if the argument provided is greater-than or equal-to the value represented by the object.

ge example #1

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

  $float->ge(1); # 1

gt

  gt(Any $arg1) : Num

The gt method performs a numeric greater-than comparison.

gt example #1

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

  $float->gt(1); # 1

le

  le(Any $arg1) : Num

The le method returns true if the argument provided is less-than or equal-to the value represented by the object.

le example #1

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

  $float->le(1); # 0

lt

  lt(Any $arg1) : Num

The lt method performs a numeric less-than comparison.

lt example #1

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

  $float->lt(1.24); # 1

ne

  ne(Any $arg1) : Num

The ne method performs a numeric equality operation.

ne example #1

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

  $float->ne(1); # 1

to

  to(Int $arg1) : ArrayRef

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.

to example #1

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

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

to example #2

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

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

upto example #1

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

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

AUTHOR

Al Newkirk, "awncorp@cpan.org"

LICENSE

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 in the "license file" <https://github.com/iamalnewkirk/data-object/blob/master/LICENSE>.

PROJECT

Wiki <https://github.com/iamalnewkirk/data-object/wiki>

Project <https://github.com/iamalnewkirk/data-object>

Initiatives <https://github.com/iamalnewkirk/data-object/projects>

Milestones <https://github.com/iamalnewkirk/data-object/milestones>

Contributing <https://github.com/iamalnewkirk/data-object/blob/master/CONTRIBUTE.md>

Issues <https://github.com/iamalnewkirk/data-object/issues>