Packagesekati.math
Classpublic class MathBase

MathBase provides a common math API.



Public Methods
 MethodDefined by
  
MathBase Static Constructor
MathBase
  
clamp(val:Number, min:Number, max:Number):Number
[static] Clamp constrains a value to the defined numeric boundaries.
MathBase
  
constrain(val:Number, min:Number, max:Number):Number
[static] Constrain a value to the defined numeric boundaries.
MathBase
  
distance(x1:Number, x2:Number, y1:Number, y2:Number):Number
[static] Return the distance between two points.
MathBase
  
factorial(n:Number):Number
[static] Calculate the factorial of the integer.
MathBase
  
floor(val:Number, decimal:Number):Number
[static] Same as Math.floor( ) with extra argument to specify number of decimals.
MathBase
  
fuzzyEval(n1:Number, n2:Number, precision:int = 5):Boolean
[static] Evaluate if two numbers are nearly equal.
MathBase
  
getDivisors(n:Number):Array
[static] Return an array of divisors of the integer.
MathBase
  
isEven(n:Number):Boolean
[static] Check if number is Even (convert to Integer if necessary).
MathBase
  
isInteger(n:Number):Boolean
[static] Check if number is an Integer.
MathBase
  
isNatural(n:Number):Boolean
[static] Check if number is Natural (positive Integer).
MathBase
  
isNegative(n:Number):Boolean
[static] Check if number is negative.
MathBase
  
isOdd(n:Number):Boolean
[static] Check if number is Odd (convert to Integer if necessary).
MathBase
  
isPositive(n:Number):Boolean
[static] Check if number is positive (zero is considered positive).
MathBase
  
isPrime(n:Number):Boolean
[static] Check if number is Prime (divisible only itself and one).
MathBase
  
limit(val:Number, min:Number, max:Number, wrap:Boolean = false):Number
[static] Similar to clamp & constrain but allows for limit value wrapping.
MathBase
  
max(... args):Number
[static] Returns the highest value of all passed arguments like Math.max( ) but supports any number of args passed to it.
MathBase
  
maxArray(a:Array):Number
[static] Returns the highest value of all items in array like Math.max( ) but supports any number of items.
MathBase
  
min(... args):Number
[static] Returns the lowest value of all passed arguments like Math.min( ) but supports any number of args passed to it.
MathBase
  
minArray(a:Array):Number
[static] Returns the lowest value of all items in array like Math.min() but supports any number of items.
MathBase
  
percent(amount:Number, total:Number):Number
[static] Return a percentage based on the numerator and denominator.
MathBase
  
proportion(x1:Number, x2:Number, y1:Number, y2:Number, x:Number = 1):Number
[static] Return the proportional value of two pairs of numbers.
MathBase
  
random(start:Number, end:Number):Number
[static] Returns a random number inside a specific range.
MathBase
  
round(val:Number, decimal:Number):Number
[static] Round to a given amount of decimals.
MathBase
  
sanitizeFloat(n:Number, precision:uint = 5):Number
[static] Correct "roundoff errors" in floating point math.
MathBase
Constructor detail
MathBase()constructor
public function MathBase()

MathBase Static Constructor

Method detail
clamp()method
public static function clamp(val:Number, min:Number, max:Number):Number

Clamp constrains a value to the defined numeric boundaries.

Parameters
val:Number
 
min:Number
 
max:Number

Returns
Number

Example
   val: 20, 2 to 5    this will give back 5 since 5 is the top boundary
   val: 3, 2 to 5     this will give back 3
   

constrain()method 
public static function constrain(val:Number, min:Number, max:Number):Number

Constrain a value to the defined numeric boundaries. Deprecated: Use MathBase.clamp() instead.

Parameters
val:Number
 
min:Number
 
max:Number

Returns
Number

See also

distance()method 
public static function distance(x1:Number, x2:Number, y1:Number, y2:Number):Number

Return the distance between two points.

Parameters
x1:Number
 
x2:Number
 
y1:Number
 
y2:Number

Returns
Number
factorial()method 
public static function factorial(n:Number):Number

Calculate the factorial of the integer.

Parameters
n:Number

Returns
Number
floor()method 
public static function floor(val:Number, decimal:Number):Number

Same as Math.floor( ) with extra argument to specify number of decimals.

Parameters
val:Number
 
decimal:Number

Returns
Number
fuzzyEval()method 
public static function fuzzyEval(n1:Number, n2:Number, precision:int = 5):Boolean

Evaluate if two numbers are nearly equal.

Parameters
n1:Number
 
n2:Number
 
precision:int (default = 5)

Returns
Boolean

See also

getDivisors()method 
public static function getDivisors(n:Number):Array

Return an array of divisors of the integer.

Parameters
n:Number

Returns
Array
isEven()method 
public static function isEven(n:Number):Boolean

Check if number is Even (convert to Integer if necessary).

Parameters
n:Number

Returns
Boolean
isInteger()method 
public static function isInteger(n:Number):Boolean

Check if number is an Integer.

Parameters
n:Number

Returns
Boolean
isNatural()method 
public static function isNatural(n:Number):Boolean

Check if number is Natural (positive Integer).

Parameters
n:Number

Returns
Boolean
isNegative()method 
public static function isNegative(n:Number):Boolean

Check if number is negative.

Parameters
n:Number

Returns
Boolean
isOdd()method 
public static function isOdd(n:Number):Boolean

Check if number is Odd (convert to Integer if necessary).

Parameters
n:Number

Returns
Boolean
isPositive()method 
public static function isPositive(n:Number):Boolean

Check if number is positive (zero is considered positive).

Parameters
n:Number

Returns
Boolean
isPrime()method 
public static function isPrime(n:Number):Boolean

Check if number is Prime (divisible only itself and one).

Parameters
n:Number

Returns
Boolean
limit()method 
public static function limit(val:Number, min:Number, max:Number, wrap:Boolean = false):Number

Similar to clamp & constrain but allows for limit value wrapping.

Parameters
val:Number
 
min:Number
 
max:Number
 
wrap:Boolean (default = false)

Returns
Number

See also

max()method 
public static function max(... args):Number

Returns the highest value of all passed arguments like Math.max( ) but supports any number of args passed to it.

Parameters
... args

Returns
Number
maxArray()method 
public static function maxArray(a:Array):Number

Returns the highest value of all items in array like Math.max( ) but supports any number of items.

Parameters
a:Array

Returns
Number
min()method 
public static function min(... args):Number

Returns the lowest value of all passed arguments like Math.min( ) but supports any number of args passed to it.

Parameters
... args

Returns
Number
minArray()method 
public static function minArray(a:Array):Number

Returns the lowest value of all items in array like Math.min() but supports any number of items.

Parameters
a:Array

Returns
Number
percent()method 
public static function percent(amount:Number, total:Number):Number

Return a percentage based on the numerator and denominator.

Parameters
amount:Number
 
total:Number

Returns
Number
proportion()method 
public static function proportion(x1:Number, x2:Number, y1:Number, y2:Number, x:Number = 1):Number

Return the proportional value of two pairs of numbers.

Parameters
x1:Number
 
x2:Number
 
y1:Number
 
y2:Number
 
x:Number (default = 1)

Returns
Number
random()method 
public static function random(start:Number, end:Number):Number

Returns a random number inside a specific range.

Parameters
start:Number
 
end:Number

Returns
Number
round()method 
public static function round(val:Number, decimal:Number):Number

Round to a given amount of decimals.

Parameters
val:Number
 
decimal:Number

Returns
Number
sanitizeFloat()method 
public static function sanitizeFloat(n:Number, precision:uint = 5):Number

Correct "roundoff errors" in floating point math.

Parameters
n:Number
 
precision:uint (default = 5)

Returns
Number

See also