Data::Object::Number - A Number Object for Perl 5
version 0.13
use Data::Object::Number; my $number = Data::Object::Number->new(1_000_000);
Data::Object::Number provides common methods for operating on Perl 5 numeric data. Number methods work on data that meets the criteria for being a number. A number holds and manipulates an arbitrary sequence of bytes, typically representing numberic characters (0-9). Users of numbers should be aware of the methods that modify the number itself as opposed to returning a new number. Unless stated, it may be safe to assume that the following methods copy, modify and return new numbers based on their function.
# given 12 $number->abs; # 12 $number = -12; $number->abs; # 12
The abs method returns the absolute value of the number. This method returns a Data::Object::Number object.
# 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 Data::Object::Float object.
# given 12 $number->cos; # 0.843853958732492
The cos method computes the cosine of the number (expressed in radians). This method returns a Data::Object::Float object.
# 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.
# given 0 $number->exp; # 1 $number = 1; $number->exp; # 2.71828182845905 $number = 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 Data::Object::Float object.
# given 175 $number->hex; # 0xaf
The hex method returns a hex string representing the value of the number. This method returns a Data::Object::String object.
# 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.
# 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 Data::Object::Number object.
# given 12345 $number->log; # 9.42100640177928
The log method returns the natural logarithm (base e) of the number. This method returns a Data::Object::Float object.
# 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 Data::Object::Number object.
# given 12345 $number->neg; # -12345
The neg method returns a negative version of the number. This method returns a Data::Object::Integer object.
# 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 Data::Object::Number object.
# 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.
# 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.
Data::Object::Array
Data::Object::Code
Data::Object::Float
Data::Object::Hash
Data::Object::Integer
Data::Object::Number
Data::Object::Scalar
Data::Object::String
Data::Object::Undef
Data::Object::Universal
Data::Object::Autobox
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.