GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DATA::OBJECT::FLOAT (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

version 0.59

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.

COMPOSITION

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

METHODS

    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.

    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.

    detract



    # given $float

    $float->detract; # original value



The detract method returns the original and underlying value contained by the 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.

    dump



    # given 1.23

    $float->dump; # 1.23



The dump method returns returns a string representation of the object. This method returns a Data::Object::String 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.

    methods



    # given $float

    $float->methods;



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

    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.

    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.

    print



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

    roles



    # given $float

    $float->roles;



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

    say



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

    throw



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

    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.

    type



    # given $float

    $float->type; # FLOAT



The type method returns a string representing the internal data type object name. This method returns a Data::Object::String 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 is comprised of the following roles.
o Data::Object::Role::Comparison
o Data::Object::Role::Defined
o Data::Object::Role::Detract
o Data::Object::Role::Dumper
o Data::Object::Role::Item
o Data::Object::Role::Numeric
o Data::Object::Role::Output
o Data::Object::Role::Throwable
o Data::Object::Role::Type
o Data::Object::Role::Value

SEE ALSO

o Data::Object::Array
o Data::Object::Class
o Data::Object::Class::Syntax
o Data::Object::Code
o Data::Object::Float
o Data::Object::Hash
o Data::Object::Integer
o Data::Object::Number
o Data::Object::Role
o Data::Object::Role::Syntax
o Data::Object::Regexp
o Data::Object::Scalar
o Data::Object::String
o Data::Object::Undef
o Data::Object::Universal
o Data::Object::Autobox
o Data::Object::Immutable
o Data::Object::Library
o Data::Object::Prototype
o Data::Object::Signatures

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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 DATA::OBJECT::FLOAT (3) 2015-11-29

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.