Packagenet.guttershark.util
Classpublic final class MathUtils

The MathUtils class contains various math functions.



Public Methods
 MethodDefined by
  
angle2radian(a:Number):Number
Convert angle to radian.
MathUtils
  
byte2bit(n:Number):Number
Convert bytes to bits.
MathUtils
  
byte2Kilobyte(n:Number):Number
Convert bytes to killo bytes.
MathUtils
  
byte2Megabyte(n:Number):Number
Convert bytes to mega bytes
MathUtils
  
center(a:Number, b:Number, c:Number):Number
Locate and return the middle value between the three.
MathUtils
  
clamp(val:Number, min:Number, max:Number):Number
Clamp constrains a value to the defined numeric boundaries.
MathUtils
  
exabit2bit(n:Number):Number
Convert exabits to bits.
MathUtils
  
exabyte2bit(n:Number):Number
Convert exabytes to bits.
MathUtils
  
factorial(n:Number):Number
Calculate the factorial of the integer.
MathUtils
  
floor(val:Number, decimal:Number):Number
Returns the floor of a number, with optional decimal precision.
MathUtils
  
fuzzyEval(n1:Number, n2:Number, precision:int = 5):Boolean
Evaluate if two numbers are nearly equal.
MathUtils
  
getAngle(p1:Point, p2:Point):Number
Get the angle from two points.
MathUtils
  
getDivisors(n:Number):Array
Return an array of divisors of the integer.
MathUtils
  
getPointFromDistanceAndAngle(centerPoint:Point, dist:Number, angle:Number):Point
Get new point based on distance and angle from a given point.
MathUtils
  
getRadian(p1:Point, p2:Point):Number
Get the radian from two points.
MathUtils
  
getZDistance(p1:Point3D, p2:Point3D):Number
Get z distance between two Point3D instances.
MathUtils
  
[static] Singleton access.
MathUtils
  
gigabit2bit(n:Number):Number
Convert gigabit to bits.
MathUtils
  
gigabyte2bit(n:Number):Number
Convert gigabytes to bits.
MathUtils
  
isEven(n:Number):Boolean
Check if number is even (convert to Integer if necessary).
MathUtils
  
isInRange(n:Number, min:Number, max:Number, blacklist:Array = null):Boolean
Check if a number is in range.
MathUtils
  
isInteger(n:Number):Boolean
Check if number is an Integer.
MathUtils
  
isNatural(n:Number):Boolean
Check if number is Natural (positive Integer).
MathUtils
  
isNegative(n:Number):Boolean
Check if number is negative.
MathUtils
  
isOdd(n:Number):Boolean
Check if number is odd (convert to Integer if necessary).
MathUtils
  
isPositive(n:Number):Boolean
Check if number is positive (zero is positive).
MathUtils
  
isPrime(n:Number):Boolean
Check if number is Prime (divisible only by itself and one).
MathUtils
  
kilobit2bit(n:Number):Number
Convert kilobits to bits.
MathUtils
  
kilobyte2bit(n:Number):Number
Convert kilobytes to bits.
MathUtils
  
limit(val:Number, min:Number, max:Number, wrap:Boolean = false):Number
Similar to clamp & constrain but allows for limit value wrapping.
MathUtils
  
max(... args):Number
Returns the highest value of all passed arguments.
MathUtils
  
megabit2bit(n:Number):Number
Convert megabits to bits.
MathUtils
  
megabyte2bit(n:Number):Number
Convert megabytes to bits.
MathUtils
  
min(... args):Number
Returns the lowest value of all passed arguments.
MathUtils
  
parseXMLAsType(value:String):*
Parse xml string boolean values into native booleans - supports (true,false,0,1,yes,no,on,off).
MathUtils
  
percent(amount:Number, total:Number, percentRange:int = 100):Number
Return a percentage based on the numerator and denominator.
MathUtils
  
petaabit2bit(n:Number):Number
Convert petabits to bits.
MathUtils
  
petabyte2bit(n:Number):Number
Convert petabyte to bits.
MathUtils
  
pointDistance(p1:Point, p2:Point):Number
Get the distance between two points.
MathUtils
  
proportion(x1:Number, y1:Number, x2:Number, y2:Number, x:Number = 1):Number
Return the proportional value of two pairs of numbers.
MathUtils
  
radian2angle(r:Number):Number
Convert radian to angle.
MathUtils
  
randBit(chance:Number = 0.5):int
Return a "tilted" value of 1 or 0.
MathUtils
  
randBool(chance:Number = 0.5):Boolean
Return a "tilted" random Boolean value.
MathUtils
  
randFloat(min:Number, max:Number):Number
Returns a random float.
MathUtils
  
randInteger(min:Number, max:Number):int
Return a random integer.
MathUtils
  
random(start:Number, end:Number):Number
Returns a random number inside a specific range.
MathUtils
  
randRangeFloat(min:Number, max:Number):Number
Returns a random float number within a given range.
MathUtils
  
randRangeInt(min:Number, max:Number):int
Returns a random integer number within a given range.
MathUtils
  
randRangeSet(min:Number, max:Number, count:Number, unique:Boolean):Array
Returns a set of random numbers inside a specific range, optionally unique numbers only.
MathUtils
  
resolveAngle(a:Number):Number
Will always give back a positive angle between 0 and 360
MathUtils
  
rotateLeft(x:int, n:int):int
Rotates an integer left by n bits.
MathUtils
  
rotateRight(x:int, n:int):uint
Rotates an integer right by n bits.
MathUtils
  
round(val:Number, decimal:Number):Number
Round to a given amount of decimals.
MathUtils
  
sanitizeFloat(n:Number, precision:uint = 5):Number
Correct "roundoff errors" in floating point math.
MathUtils
  
sign(chance:Number = 0.5):int
Return a "tilted" value of 1 or -1.
MathUtils
  
spread(current:Number, total:Number, spreadInto:int):Number
Spreads a current value and it's total possible value, over a value that is mapped to another property, like width, height, etc.
MathUtils
  
terabit2bit(n:Number):Number
Convert terabits to bits.
MathUtils
  
terabyte2bit(n:Number):Number
Convert terabytes to bits.
MathUtils
  
toBinary(n:int):String
Convert an integer to binary string representation.
MathUtils
  
toCelsius(f:Number, p:Number = 2):Number
Convert Fahrenheit to Celsius.
MathUtils
  
toDecimal(binaryString:String):int
Convert a binary string (000001010) to an integer.
MathUtils
  
toFahrenheit(c:Number, p:Number = 2):Number
Convert Celsius to Fahrenheit.
MathUtils
  
toHex(n:int, bigEndian:Boolean = false):String
Outputs the (lowercase) hex value of a int, with optional endianness,
MathUtils
  
xyDistance(x1:Number, y1:Number, x2:Number, y2:Number):Number
Return the distance between two x,y points.
MathUtils
Protected Constants
 ConstantDefined by
  BYTE : Number = 8
Byte value.
MathUtils
  EXABIT : Number = 1.152921505e+18
Exabit value.
MathUtils
  EXABYTE : Number = 9.223372037e+18
Exabyte value.
MathUtils
  GIGABIT : Number = 1073741824
Gigabit value.
MathUtils
  GIGABYTE : Number = 8589934592
Gigabyte value.
MathUtils
  KILOBIT : Number = 1024
Kilobit value.
MathUtils
  KILOBYTE : Number = 8192
Kilobyte value.
MathUtils
  MEGABIT : Number = 1048576
Mega bit value.
MathUtils
  MEGABYTE : Number = 8388608
Megabyte value.
MathUtils
  PETABIT : Number = 1.125899907e+15
Petabit value.
MathUtils
  PETABYTE : Number = 9.007199255e+15
Petabyte value.
MathUtils
  TERABIT : Number = 1.099511628e+12
Terabit value.
MathUtils
  TERABYTE : Number = 8.796093022e+12
Terabyte value.
MathUtils
Method detail
angle2radian()method
public function angle2radian(a:Number):Number

Convert angle to radian. a The angle.

Parameters
a:Number

Returns
Number
byte2bit()method 
public function byte2bit(n:Number):Number

Convert bytes to bits.

Parameters
n:Number — The number.

Returns
Number
byte2Kilobyte()method 
public function byte2Kilobyte(n:Number):Number

Convert bytes to killo bytes.

Parameters
n:Number — The number.

Returns
Number
byte2Megabyte()method 
public function byte2Megabyte(n:Number):Number

Convert bytes to mega bytes

Parameters
n:Number — The number.

Returns
Number
center()method 
public function center(a:Number, b:Number, c:Number):Number

Locate and return the middle value between the three.

Parameters
a:Number — The first number.
 
b:Number — The second number.
 
c:Number — The second number.

Returns
Number
clamp()method 
public function clamp(val:Number, min:Number, max:Number):Number

Clamp constrains a value to the defined numeric boundaries.

Parameters
val:Number — The number.
 
min:Number — The minumum range.
 
max:Number — The maximum range.

Returns
Number

Example
  
   utils.math.clamp(20,2,5); //returns 5
   utils.math.clamp(3,2,5); //returns 3
   utils.math.clamp(3,1,5); //returns 3
   utils.math.clamp(1,10,20); //returns 10
   

exabit2bit()method 
public function exabit2bit(n:Number):Number

Convert exabits to bits.

Parameters
n:Number — The number.

Returns
Number
exabyte2bit()method 
public function exabyte2bit(n:Number):Number

Convert exabytes to bits.

Parameters
n:Number — The number.

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

Calculate the factorial of the integer.

Parameters
n:Number — The number.

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

Returns the floor of a number, with optional decimal precision.

Parameters
val:Number — The number.
 
decimal:Number — How many decimals to include.

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

Evaluate if two numbers are nearly equal.

Parameters
n1:Number — The first number.
 
n2:Number — The second number.
 
precision:int (default = 5)

Returns
Boolean
getAngle()method 
public function getAngle(p1:Point, p2:Point):Number

Get the angle from two points.

Parameters
p1:Point — The first point.
 
p2:Point — The second point.

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

Return an array of divisors of the integer.

Parameters
n:Number — The number.

Returns
Array
getPointFromDistanceAndAngle()method 
public function getPointFromDistanceAndAngle(centerPoint:Point, dist:Number, angle:Number):Point

Get new point based on distance and angle from a given point.

Parameters
centerPoint:Point — The center point.
 
dist:Number — The distance from the center point.
 
angle:Number — The angle from the center point.

Returns
Point
getRadian()method 
public function getRadian(p1:Point, p2:Point):Number

Get the radian from two points.

Parameters
p1:Point — The first point.
 
p2:Point — The second point.

Returns
Number
getZDistance()method 
public function getZDistance(p1:Point3D, p2:Point3D):Number

Get z distance between two Point3D instances.

Parameters
p1:Point3D — The first point 3d.
 
p2:Point3D — The second point 3d.

Returns
Number
gi()method 
public static function gi():MathUtils

Singleton access.

Returns
MathUtils
gigabit2bit()method 
public function gigabit2bit(n:Number):Number

Convert gigabit to bits.

Parameters
n:Number — The number.

Returns
Number
gigabyte2bit()method 
public function gigabyte2bit(n:Number):Number

Convert gigabytes to bits.

Parameters
n:Number — The number.

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

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

Parameters
n:Number — The number.

Returns
Boolean
isInRange()method 
public function isInRange(n:Number, min:Number, max:Number, blacklist:Array = null):Boolean

Check if a number is in range.

Parameters
n:Number — The number.
 
min:Number — The minimum number.
 
max:Number — The maximum number.
 
blacklist:Array (default = null) — An array of numbers that cannot be considered in range.

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

Check if number is an Integer.

Parameters
n:Number — The number.

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

Check if number is Natural (positive Integer).

Parameters
n:Number — The number.

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

Check if number is negative.

Parameters
n:Number — The number.

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

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

Parameters
n:Number — The number.

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

Check if number is positive (zero is positive).

Parameters
n:Number — The number.

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

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

Parameters
n:Number — The number.

Returns
Boolean
kilobit2bit()method 
public function kilobit2bit(n:Number):Number

Convert kilobits to bits.

Parameters
n:Number — The number.

Returns
Number
kilobyte2bit()method 
public function kilobyte2bit(n:Number):Number

Convert kilobytes to bits.

Parameters
n:Number — The number.

Returns
Number
limit()method 
public 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 — The number.
 
min:Number — The miniimum range.
 
max:Number — The maximum range.
 
wrap:Boolean (default = false)

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

Returns the highest value of all passed arguments.

Parameters
... args — Any list of numbers.

Returns
Number
megabit2bit()method 
public function megabit2bit(n:Number):Number

Convert megabits to bits.

Parameters
n:Number — The number.

Returns
Number
megabyte2bit()method 
public function megabyte2bit(n:Number):Number

Convert megabytes to bits.

Parameters
n:Number — The number.

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

Returns the lowest value of all passed arguments.

Parameters
... args — Any list of numbers.

Returns
Number
parseXMLAsType()method 
public function parseXMLAsType(value:String):*

Parse xml string boolean values into native booleans - supports (true,false,0,1,yes,no,on,off).

Parameters
value:String — The string value from XML.

Returns
*
percent()method 
public function percent(amount:Number, total:Number, percentRange:int = 100):Number

Return a percentage based on the numerator and denominator.

Parameters
amount:Number — The amount.
 
total:Number — The total
 
percentRange:int (default = 100) — The percentage range that the calculation will scale to.

Returns
Number
petaabit2bit()method 
public function petaabit2bit(n:Number):Number

Convert petabits to bits.

Parameters
n:Number — The number.

Returns
Number
petabyte2bit()method 
public function petabyte2bit(n:Number):Number

Convert petabyte to bits.

Parameters
n:Number — The number.

Returns
Number
pointDistance()method 
public function pointDistance(p1:Point, p2:Point):Number

Get the distance between two points.

Parameters
p1:Point — The first point.
 
p2:Point — The secoind point.

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

Return the proportional value of two pairs of numbers.

Parameters
x1:Number — The first x position.
 
y1:Number — The first y position.
 
x2:Number — The second x position.
 
y2:Number — The second y position. //TODO
 
x:Number (default = 1)

Returns
Number
radian2angle()method 
public function radian2angle(r:Number):Number

Convert radian to angle.

Parameters
r:Number — The radian.

Returns
Number
randBit()method 
public function randBit(chance:Number = 0.5):int

Return a "tilted" value of 1 or 0.

Parameters
chance:Number (default = 0.5) — The percentage chance that the return value will be true.

Returns
int

Example
 
   math.utils.bit(); //returns 50% chance of 1.
   math.utils.bit(.75); //returns 75% chance of 1.
   

randBool()method 
public function randBool(chance:Number = 0.5):Boolean

Return a "tilted" random Boolean value.

Parameters
chance:Number (default = 0.5) — The percentage chance that the return value will be true.

Returns
Boolean

Example
 
   math.utils.boolean(); //returns 50% chance of true.
   math.utils.boolean(.75); //returns 75% chance of true.
   

randFloat()method 
public function randFloat(min:Number, max:Number):Number

Returns a random float.

Parameters
min:Number
 
max:Number

Returns
Number

Example
 
   math.utils.randFloat(50); //returns a number between 0-50 exclusive
   math.utils.randFloat(20,50); //returns a number between 20-50 exclusive
   

randInteger()method 
public function randInteger(min:Number, max:Number):int

Return a random integer.

Parameters
min:Number — The minumum.
 
max:Number — The max.

Returns
int

Example
 
   math.utils.integer(25); //returns an integer between 0-24 inclusive.
   math.utils.integer(10,25); //returns an integer between 10-24 inclusive.
   

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

Returns a random number inside a specific range.

Parameters
start:Number — The first number.
 
end:Number — The end number.

Returns
Number
randRangeFloat()method 
public function randRangeFloat(min:Number, max:Number):Number

Returns a random float number within a given range.

Parameters
min:Number — The minimum number.
 
max:Number — The maxmimum number.

Returns
Number
randRangeInt()method 
public function randRangeInt(min:Number, max:Number):int

Returns a random integer number within a given range.

Parameters
min:Number — The minumum number.
 
max:Number — The maximum number.

Returns
int
randRangeSet()method 
public function randRangeSet(min:Number, max:Number, count:Number, unique:Boolean):Array

Returns a set of random numbers inside a specific range, optionally unique numbers only.

Parameters
min:Number — The minimum number.
 
max:Number — The maximum number.
 
count:Number — How many mubers to generate.
 
unique:Boolean — Whether or not the numbers generated must be unique.

Returns
Array
resolveAngle()method 
public function resolveAngle(a:Number):Number

Will always give back a positive angle between 0 and 360

Parameters
a:Number — The angle.

Returns
Number
rotateLeft()method 
public function rotateLeft(x:int, n:int):int

Rotates an integer left by n bits.

Parameters
x:int — The integer.
 
n:int — The number of bits to shift left.

Returns
int
rotateRight()method 
public function rotateRight(x:int, n:int):uint

Rotates an integer right by n bits.

Parameters
x:int — The integer.
 
n:int — number of bits to shift right.

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

Round to a given amount of decimals.

Parameters
val:Number — The number.
 
decimal:Number — The decimal precision.

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

Correct "roundoff errors" in floating point math.

Parameters
n:Number — The number.
 
precision:uint (default = 5) — The floating point precision.

Returns
Number
sign()method 
public function sign(chance:Number = 0.5):int

Return a "tilted" value of 1 or -1.

Parameters
chance:Number (default = 0.5) — The percentage chance that the return value will be true.

Returns
int

Example
 
   math.utils.sign(); //returns 50% chance of 1.
   math.utils.sign(.75); //returns 75% chance of 1.
   

spread()method 
public function spread(current:Number, total:Number, spreadInto:int):Number

Spreads a current value and it's total possible value, over a value that is mapped to another property, like width, height, etc.

This is probably most commonly used for bytes loaded/total, or video time.

Parameters
current:Number — The current value.
 
total:Number — The total possible value.
 
spreadInto:int — The total of another property that should be spread over.

Returns
Number

Example
 
   var current:Number = 14;
   var total:Number = 60;
   var myBar:MovieClip = new MovieClip();
   //spreads the value across 300 pixels, and gives you a value you can use for width;
   myBar.width = utils.math.spread(current,total,300); //returns 70
   

terabit2bit()method 
public function terabit2bit(n:Number):Number

Convert terabits to bits.

Parameters
n:Number — The number.

Returns
Number
terabyte2bit()method 
public function terabyte2bit(n:Number):Number

Convert terabytes to bits.

Parameters
n:Number — The number.

Returns
Number
toBinary()method 
public function toBinary(n:int):String

Convert an integer to binary string representation.

Parameters
n:int — The integer to convert.

Returns
String
toCelsius()method 
public function toCelsius(f:Number, p:Number = 2):Number

Convert Fahrenheit to Celsius.

Parameters
f:Number — The fahrenheit value.
 
p:Number (default = 2) — The number of decimals.

Returns
Number
toDecimal()method 
public function toDecimal(binaryString:String):int

Convert a binary string (000001010) to an integer.

Parameters
binaryString:String — The string to convert.

Returns
int
toFahrenheit()method 
public function toFahrenheit(c:Number, p:Number = 2):Number

Convert Celsius to Fahrenheit.

Parameters
c:Number — The celsius value.
 
p:Number (default = 2) — The number of decimals.

Returns
Number
toHex()method 
public function toHex(n:int, bigEndian:Boolean = false):String

Outputs the (lowercase) hex value of a int, with optional endianness,

Parameters
n:int — The integr value to output as hex.
 
bigEndian:Boolean (default = false) — Whether or not to convert in big endian order.

Returns
String — The hex string, not including the 0x.
xyDistance()method 
public function xyDistance(x1:Number, y1:Number, x2:Number, y2:Number):Number

Return the distance between two x,y points.

Parameters
x1:Number — The first x position.
 
y1:Number — The first y position.
 
x2:Number — The second x position.
 
y2:Number — The second y position.

Returns
Number
Constant detail
BYTEconstant
protected const BYTE:Number = 8

Byte value.

EXABITconstant 
protected const EXABIT:Number = 1.152921505e+18

Exabit value.

EXABYTEconstant 
protected const EXABYTE:Number = 9.223372037e+18

Exabyte value.

GIGABITconstant 
protected const GIGABIT:Number = 1073741824

Gigabit value.

GIGABYTEconstant 
protected const GIGABYTE:Number = 8589934592

Gigabyte value.

KILOBITconstant 
protected const KILOBIT:Number = 1024

Kilobit value.

KILOBYTEconstant 
protected const KILOBYTE:Number = 8192

Kilobyte value.

MEGABITconstant 
protected const MEGABIT:Number = 1048576

Mega bit value.

MEGABYTEconstant 
protected const MEGABYTE:Number = 8388608

Megabyte value.

PETABITconstant 
protected const PETABIT:Number = 1.125899907e+15

Petabit value.

PETABYTEconstant 
protected const PETABYTE:Number = 9.007199255e+15

Petabyte value.

TERABITconstant 
protected const TERABIT:Number = 1.099511628e+12

Terabit value.

TERABYTEconstant 
protected const TERABYTE:Number = 8.796093022e+12

Terabyte value.