MathUtils

Kind of class:public class
Package:com.trycatch.utils
Inherits from:Object
Classpath:com.trycatch.utils.MathUtils
File last modified:Tuesday, 09 June 2009, 09:13:08
A class to help you with your math homework ;)
MathUtils is also great for optimization, as it stores commonly used values like π/180 as precalculated values

Summary


Constructor
Class properties
  • PI : Number
    • The pre-calcuated value of Math.PI
  • PI_OVER_180 : Number
    • The pre-calcuated value of (Math.PI/180)
  • CLASS_PATH : String
    • The class path of the class
Class methods
  • isPositive (_num:Number) : Boolean
    • Determines whether or not the supplied number is positive
  • isNegative (_num:Number) : Boolean
    • Determines whether or not the supplied number is negative
  • isEven (_num:Number) : Boolean
    • Determines whether or not the supplied number is even
  • isOdd (_num:Number) : Boolean
    • Determines whether or not the supplied number is odd
  • isWholeNumber (_num:Number) : Boolean
    • Determines whether or not the supplied number is a whole number
  • isDecimalNumber (_num:Number) : Boolean
    • Determines whether or not the supplied number is a decimal
  • isPrimeNumber (_num:Number) : Boolean
    • Determines whether or not the supplied number is a prime number.
  • getEvenNumbersWithinRange (_min:int, _max:int) : Array
    • Returns an Array of even numbers within the supplied range
  • getOddNumbersWithinRange (_min:int, _max:int) : Array
    • Returns an Array of odd numbers within the supplied range
  • getPrimeNumbersWithinRange (_min:int, _max:int) : Array
    • Returns an Array of prime numbers within the supplied range
  • degreesToRadians (_degrees:Number) : Number
    • Converts the supplied degrees to radians
  • radiansToDegrees (_radians:Number) : Number
    • Converts the supplied radians represented as degrees
  • simplifyAngle (_angle:Number) : Number
    • Simplifys the supplied angle to its simpliest representation
  • roundDecimalPrecission (_num:Number, _decPrec:Number = 2) : Number
    • Rounds the supplied number to the requested decimal precission
  • magneticModulo (_value:Number, _dist:Number) : Number
    • Determines and returns which interval distance the value is closer to
  • generateTruelyUniqueInt : Number
    • Generates and returns a truely unique (not random) integer casted as a Number.
  • chance (_odds:Number) : Boolean
    • Returns true if ciel of the supplied oods ratio is 1
  • randomRange (min:Number, max:Number) : Number
    • Returns a random number between min and max

Constructor

MathUtils

public function MathUtils (
)

Class properties

CLASS_PATH

public static CLASS_PATH:String = "com.nemo.utils.MathUtils"
(read,write)

The class path of the class

PI

public static PI:Number = 3.141592653589793
(read,write)

The pre-calcuated value of Math.PI

PI_OVER_180

public static PI_OVER_180:Number = 0.017453292519943295
(read,write)

The pre-calcuated value of (Math.PI/180)

Class methods

chance

public static function chance (
_odds:Number) : Boolean

Returns true if ciel of the supplied oods ratio is 1
Parameters:
_odds:
A decimal between 0 and 1

degreesToRadians

public static function degreesToRadians (
_degrees:Number) : Number

Converts the supplied degrees to radians
Parameters:
_degrees:
The degrees to be converted to radians
Returns:
  • The supplied degrees converted to radians

generateTruelyUniqueInt

public static function generateTruelyUniqueInt (
) : Number

Generates and returns a truely unique (not random) integer casted as a Number.
int.MAX_VALUE is the largest representable 32-bit signed integer, which is 2,147,483,647 ((2^31) - 1)
Casting the return value as an int will result in an incorrect value, because its such a large number
Returns:
  • A unique integer, creates a new Date instance and returns its time property
See also:
Example:
  • var _n:Number = MathUtils.generateUniqueInt(); // correct value, 1230707045775
var _i:int = _n; // incorrect value, -1948568177

getEvenNumbersWithinRange

public static function getEvenNumbersWithinRange (
_min:int, _max:int) : Array

Returns an Array of even numbers within the supplied range
Parameters:
_min:
The minimum range, if a decimal is passed the floor is used
_max:
The maximum range, if a decimal is passed the floor is used
Returns:
  • Array of even numbers within the supplied range

getOddNumbersWithinRange

public static function getOddNumbersWithinRange (
_min:int, _max:int) : Array

Returns an Array of odd numbers within the supplied range
Parameters:
_min:
The minimum range, if a decimal is passed the floor is used
_max:
The maximum range, if a decimal is passed the floor is used
Returns:
  • Array of odd numbers within the supplied range

getPrimeNumbersWithinRange

public static function getPrimeNumbersWithinRange (
_min:int, _max:int) : Array

Returns an Array of prime numbers within the supplied range
Parameters:
_min:
The minimum range, if a decimal is passed the floor is used
_max:
The maximum range, if a decimal is passed the floor is used
Returns:
  • Array of primes within the supplied range

isDecimalNumber

public static function isDecimalNumber (
_num:Number) : Boolean

Determines whether or not the supplied number is a decimal
Parameters:
_num:
The number to be evaluated
Returns:
  • True if _num is a decimal
Example:
  • trace(MathUtils.isDecimalNumber(1.1)); // true
trace(MathUtils.isDecimalNumber(0.3)); // true
trace(MathUtils.isDecimalNumber(5)); // false

isEven

public static function isEven (
_num:Number) : Boolean

Determines whether or not the supplied number is even
Parameters:
_num:
The number to evaluated
Returns:
  • True if _num is an even number

isNegative

public static function isNegative (
_num:Number) : Boolean

Determines whether or not the supplied number is negative
Parameters:
_num:
The number to evaluate
Returns:
  • Whether or not the supplied number is negative

isOdd

public static function isOdd (
_num:Number) : Boolean

Determines whether or not the supplied number is odd
Parameters:
_num:
The number to evaluated
Returns:
  • True if _num is an odd number

isPositive

public static function isPositive (
_num:Number) : Boolean

Determines whether or not the supplied number is positive
Parameters:
_num:
The number to evaluate
Returns:
  • Whether or not the supplied number is positive

isPrimeNumber

public static function isPrimeNumber (
_num:Number) : Boolean

Determines whether or not the supplied number is a prime number. NOTE only natural numbers are evaluated, decimal and negative numbers are not considered prime numbers even if they have more than two divisors.
Parameters:
_num:
The number to be evalulated
Returns:
  • True if _num is a prime number
See also:

isWholeNumber

public static function isWholeNumber (
_num:Number) : Boolean

Determines whether or not the supplied number is a whole number
Parameters:
_num:
The number to be evaluated
Returns:
  • True if _num is a whole number

magneticModulo

public static function magneticModulo (
_value:Number, _dist:Number) : Number

Determines and returns which interval distance the value is closer to
Parameters:
_value:
The value to evaluate
_dist :
The interval distance
Returns:
  • Which evenly divisble distance the value is closer to
Example:
  • MathUtils.magneticModulo(23, 10); // returns 20
MathUtils.magneticModulo(27, 10); // returns 30

radiansToDegrees

public static function radiansToDegrees (
_radians:Number) : Number

Converts the supplied radians represented as degrees
Parameters:
_radians:
The radians to be converted to degrees
Returns:
  • The radians converted to degrees

randomRange

public static function randomRange (
min:Number, max:Number) : Number

Returns a random number between min and max
Parameters:
min:
The minimum range
max:
The maximum range
Returns:
  • A random number between min and max

roundDecimalPrecission

public static function roundDecimalPrecission (
_num:Number, _decPrec:Number = 2) : Number

Rounds the supplied number to the requested decimal precission
Parameters:
_num :
The number to round
_decPrec:
The decimal precission to round to
Returns:
  • The supplied number rounded to the supplied decimal precission
Example:
  • var _decRound:Number = MathUtils.roundDecimalPrecission(3.141592653589793, 4); // returns 3.1415;

simplifyAngle

public static function simplifyAngle (
_angle:Number) : Number

Simplifys the supplied angle to its simpliest representation
Parameters:
_angle:
The angle to simplify
Returns:
  • The supplied angle simplified
Example:
  • var _simpAngle:Number = MathUtils.simplifyAngle(725); // returns 5
var _simpAngle2:Number = MathUtils.simplifyAngle(-725); // returns -5
  • © Rainbows4Dinos
  • Created with VisDoc