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::ROLE::NUMBER (3)

.ds Aq ’

NAME

Data::Object::Role::Number - Number Object Role for Perl 5

CONTENTS

VERSION

version 0.59

SYNOPSIS



    use Data::Object::Class;

    with Data::Object::Role::Number;



DESCRIPTION

Data::Object::Role::Number provides routines for operating on Perl 5 numeric data.

METHODS

    abs



    # given 12

    $number->abs; # 12

    # given -12

    $number->abs; # 12



The abs method returns the absolute value of the number. This method returns a number object.

    atan2



    # given 1

    $number->atan2(1); # 0.785398163397448



The atan2 method returns the arctangent of Y/X in the range -PI to PI This method returns a float value.

    cos



    # given 12

    $number->cos; # 0.843853958732492



The cos method computes the cosine of the number (expressed in radians). This method returns a float value.

    data



    # given $number

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

    decr



    # given 123456789

    $number->decr; # 123456788



The decr method returns the numeric number decremented by 1. This method returns a data type object to be determined after execution.

    defined



    # given $number

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

    detract



    # given $number

    $number->detract; # original value



The detract method returns the original and underlying value contained by the object.

    downto



    # given 10

    $number->downto(5); # [10,9,8,7,6,5]



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

    dump



    # given 12345

    $number->dump; # 12345



The dump method returns returns a string representation of the object. This method returns a string value.

    eq



    # given 12345

    $number->eq(12346); # 0



The eq method performs a numeric equality operation. This method returns a number object representing a boolean.

    exp



    # given 0

    $number->exp; # 1

    # given 1

    $number->exp; # 2.71828182845905

    # given 1.5

    $number->exp; # 4.48168907033806



The exp method returns e (the natural logarithm base) to the power of the number. This method returns a float value.

    ge



    # given 0

    $number->ge(0); # 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 99

    $number->gt(50); # 1



The gt method performs a numeric greater-than comparison. This method returns a number object representing a boolean.

    hex



    # given 175

    $number->hex; # 0xaf



The hex method returns a hex string representing the value of the number. This method returns a string value.

    incr



    # given 123456789

    $number->incr; # 123456790



The incr method returns the numeric number incremented by 1. This method returns a data type object to be determined after execution.

    int



    # given 12.5

    $number->int; # 12



The int method returns the integer portion of the number. Do not use this method for rounding. This method returns a number value.

    le



    # given 0

    $number->le; # 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.

    log



    # given 12345

    $number->log; # 9.42100640177928



The log method returns the natural logarithm (base e) of the number. This method returns a float value.

    lt



    # given 86

    $number->lt(88); # 1



The lt method performs a numeric less-than comparison. This method returns a number object representing a boolean.

    methods



    # given $number

    $number->methods;



The methods method returns the list of methods attached to object. This method returns an array value.

    mod



    # given 12

    $number->mod(1); # 0
    $number->mod(2); # 0
    $number->mod(3); # 0
    $number->mod(4); # 0
    $number->mod(5); # 2



The mod method returns the division remainder of the number divided by the argment. This method returns a number value.

    ne



    # given -100

    $number->ne(100); # 1



The ne method performs a numeric equality operation. This method returns a number object representing a boolean.

    neg



    # given 12345

    $number->neg; # -12345



The neg method returns a negative version of the number. This method returns a integer object.

    new



    # given 1_000_000

    my $number = Data::Object::Number->new(1_000_000);



The new method expects a number and returns a new class instance.

    pow



    # given 12345

    $number->pow(3); # 1881365963625



The pow method returns a number, the result of a math operation, which is the number to the power of the argument. This method returns a number object.

    print



    # given 12345

    $number->print; # 12345



The print method outputs the value represented by the object to STDOUT and returns true. This method returns a number value.

    roles



    # given $number

    $number->roles;



The roles method returns the list of roles attached to object. This method returns an array value.

    say



    # given 12345

    $number->say; # 12345\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.

    sin



    # given 12345

    $number->sin; # -0.993771636455681



The sin method returns the sine of the number (expressed in radians). This method returns a data type object to be determined after execution.

    sqrt



    # given 12345

    $number->sqrt; # 111.108055513541



The sqrt method returns the positive square root of the number. This method returns a data type object to be determined after execution.

    throw



    # given $number

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

    to



    # given 5

    $number->to(9); # [5,6,7,8,9]
    $number->to(1); # [5,4,3,2,1]



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.

    type



    # given $number

    $number->type; # NUMBER



The type method returns a string representing the internal data type object name. This method returns a string value.

    upto



    # given 23

    $number->upto(25); # [23,24,25]



The upto method returns an array reference containing integer increasing values up to and including the limit. This method returns a 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::ROLE::NUMBER (3) 2015-11-29

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