org.classdump.luna.lib

Class MathLib

java.lang.Object

org.classdump.luna.lib.MathLib

public final class MathLib
extends Object

This library provides basic mathematical functions. It provides all its functions and constants inside the table math. Functions with the annotation "integer/float" give integer results for integer arguments and float results for float (or mixed) arguments. Rounding functions (math.ceil, math.floor, and math.modf) return an integer when the result fits in the range of an integer, or a float otherwise.

Field Summary

Fields

Modifier and Type	Field and Description
static Double	HUGE math.huge
static Long	MAXINTEGER An integer with the maximum value for an integer.
static Long	MININTEGER An integer with the minimum value for an integer.
static Double	PI math.pi

Method Summary

Modifier and Type	Method and Description
static org.classdump.luna.runtime.LuaFunction	abs() Returns the function math.abs.
static org.classdump.luna.runtime.LuaFunction	acos() Returns the function math.acos.
static org.classdump.luna.runtime.LuaFunction	asin() Returns the function math.asin.
static org.classdump.luna.runtime.LuaFunction	atan() Returns the function math.atan.
static org.classdump.luna.runtime.LuaFunction	ceil() Returns the function math.ceil.
static org.classdump.luna.runtime.LuaFunction	cos() Returns the function math.cos.
static org.classdump.luna.runtime.LuaFunction	deg() Returns the function math.deg.
static org.classdump.luna.runtime.LuaFunction	exp() Returns the function math.exp.
static org.classdump.luna.runtime.LuaFunction	floor() Returns the function math.floor.
static org.classdump.luna.runtime.LuaFunction	fmod() Returns the function math.fmod.
static void	installInto(org.classdump.luna.StateContext context, org.classdump.luna.Table env) Installs the math library to the global environment env in the state context context, with a new random number generator of class Random.
static void	installInto(org.classdump.luna.StateContext context, org.classdump.luna.Table env, Random random) Installs the math library to the global environment env in the state context context, with the random number generator random.
static org.classdump.luna.runtime.LuaFunction	log() Returns the function math.log.
static org.classdump.luna.runtime.LuaFunction	max() Returns the function math.max.
static org.classdump.luna.runtime.LuaFunction	min() Returns the function math.min.
static org.classdump.luna.runtime.LuaFunction	modf() Returns the function math.modf.
static org.classdump.luna.runtime.LuaFunction	rad() Returns the function math.rad.
static org.classdump.luna.runtime.LuaFunction	random(Random random) Returns a function math.random that uses the argument random as a random number generator.
static org.classdump.luna.runtime.LuaFunction	randomseed(Random random) Returns a function math.randomseed that sets the seed of the random generator random.
static org.classdump.luna.runtime.LuaFunction	sin() Returns the function math.sin.
static org.classdump.luna.runtime.LuaFunction	sqrt() Returns the function math.sqrt.
static org.classdump.luna.runtime.LuaFunction	tan() Returns the function math.tan.
static org.classdump.luna.runtime.LuaFunction	tointeger() Returns the function math.tointeger.
static org.classdump.luna.runtime.LuaFunction	type() Returns the function math.type.
static org.classdump.luna.runtime.LuaFunction	ult() Returns the function math.ult.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HUGE

public static final Double HUGE

math.huge

The value HUGE_VAL, a value larger than or equal to any other numerical value.

MAXINTEGER

public static final Long MAXINTEGER

An integer with the maximum value for an integer.

MININTEGER

public static final Long MININTEGER

An integer with the minimum value for an integer.

PI

public static final Double PI

math.pi

The value of π.

Method Detail

abs

public static org.classdump.luna.runtime.LuaFunction abs()

Returns the function math.abs.

The following is the corresponding entry from the Lua Reference Manual:

math.abs (x)

Returns the absolute value of x. (integer/float)

Returns:

the math.abs function

See Also:

the Lua 5.3 Reference Manual entry for math.abs

acos

public static org.classdump.luna.runtime.LuaFunction acos()

Returns the function math.acos.

The following is the corresponding entry from the Lua Reference Manual:

math.acos (x)

Returns the arc cosine of x (in radians).

Returns:

the math.acos function

See Also:

the Lua 5.3 Reference Manual entry for math.acos

asin

public static org.classdump.luna.runtime.LuaFunction asin()

Returns the function math.asin.

The following is the corresponding entry from the Lua Reference Manual:

math.asin (x)

Returns the arc sine of x (in radians).

Returns:

the math.asin function

See Also:

the Lua 5.3 Reference Manual entry for math.asin

atan

public static org.classdump.luna.runtime.LuaFunction atan()

Returns the function math.atan.

The following is the corresponding entry from the Lua Reference Manual:

math.atan (x)

Returns the arc tangent of y/x (in radians), but uses the signs of both parameters to find the quadrant of the result. (It also handles correctly the case of x being zero.)

The default value for x is 1, so that the call math.atan(y) returns the arc tangent of y.

Returns:

the math.atan function

See Also:

the Lua 5.3 Reference Manual entry for math.atan

ceil

public static org.classdump.luna.runtime.LuaFunction ceil()

Returns the function math.ceil.

The following is the corresponding entry from the Lua Reference Manual:

math.ceil (x)

Returns the smallest integer larger than or equal to x.

Returns:

the math.ceil function

See Also:

the Lua 5.3 Reference Manual entry for math.ceil

cos

public static org.classdump.luna.runtime.LuaFunction cos()

Returns the function math.cos.

The following is the corresponding entry from the Lua Reference Manual:

math.cos (x)

Returns the cosine of x (assumed to be in radians).

Returns:

the math.cos function

See Also:

the Lua 5.3 Reference Manual entry for math.cos

deg

public static org.classdump.luna.runtime.LuaFunction deg()

Returns the function math.deg.

The following is the corresponding entry from the Lua Reference Manual:

math.deg (x)

Returns the angle x (given in radians) in degrees.

Returns:

the math.deg function

See Also:

the Lua 5.3 Reference Manual entry for math.deg

exp

public static org.classdump.luna.runtime.LuaFunction exp()

Returns the function math.exp.

The following is the corresponding entry from the Lua Reference Manual:

math.exp (x)

Returns the value e^x (where e is the base of natural logarithms).

Returns:

the math.exp function

See Also:

the Lua 5.3 Reference Manual entry for math.exp

floor

public static org.classdump.luna.runtime.LuaFunction floor()

Returns the function math.floor.

The following is the corresponding entry from the Lua Reference Manual:

math.floor (x)

Returns the largest integral value smaller than or equal to x.

Returns:

the math.floor function

See Also:

the Lua 5.3 Reference Manual entry for math.floor

fmod

public static org.classdump.luna.runtime.LuaFunction fmod()

Returns the function math.fmod.

The following is the corresponding entry from the Lua Reference Manual:

math.fmod (x, y)

Returns the remainder of the division of x by y that rounds the quotient towards zero. (integer/float)

Returns:

the math.fmod function

See Also:

the Lua 5.3 Reference Manual entry for math.fmod

log

public static org.classdump.luna.runtime.LuaFunction log()

Returns the function math.log.

The following is the corresponding entry from the Lua Reference Manual:

math.log (x [, base])

Returns the logarithm of x in the given base. The default for base is e (so that the function returns the natural logarithm of x).

Returns:

the math.log function

See Also:

the Lua 5.3 Reference Manual entry for math.log

max

public static org.classdump.luna.runtime.LuaFunction max()

Returns the function math.max.

The following is the corresponding entry from the Lua Reference Manual:

math.max (x, ···)

Returns the argument with the maximum value, according to the Lua operator <. (integer/float)

Returns:

the math.max function

See Also:

the Lua 5.3 Reference Manual entry for math.max

min

public static org.classdump.luna.runtime.LuaFunction min()

Returns the function math.min.

The following is the corresponding entry from the Lua Reference Manual:

math.min (x, ···)

Returns the argument with the minimum value, according to the Lua operator <. (integer/float)

Returns:

the math.min function

See Also:

the Lua 5.3 Reference Manual entry for math.min

modf

public static org.classdump.luna.runtime.LuaFunction modf()

Returns the function math.modf.

The following is the corresponding entry from the Lua Reference Manual:

math.modf (x)

Returns the integral part of x and the fractional part of x. Its second result is always a float.

Returns:

the math.modf function

See Also:

the Lua 5.3 Reference Manual entry for math.modf

rad

public static org.classdump.luna.runtime.LuaFunction rad()

Returns the function math.rad.

The following is the corresponding entry from the Lua Reference Manual:

math.rad (x)

Returns the angle x (given in degrees) in radians.

Returns:

the math.rad function

See Also:

the Lua 5.3 Reference Manual entry for math.rad

random

public static org.classdump.luna.runtime.LuaFunction random(Random random)

Returns a function math.random that uses the argument random as a random number generator.

The following is the corresponding entry from the Lua Reference Manual:

math.random ([m [, n]])

When called without arguments, returns a uniform pseudo-random real number in the range [0,1). When called with an integer number m, math.random returns a uniform pseudo-random integer in the range [1, m]. When called with two integer numbers m and n, math.random returns a uniform pseudo-random integer in the range [m, n].

This function is an interface to the simple pseudo-random generator function rand provided by Standard C. (No guarantees can be given for its statistical properties.)

Parameters:

random - the random number generator, must not be null

Returns:

the math.random function

Throws:

NullPointerException - if random is null

See Also:

the Lua 5.3 Reference Manual entry for math.random

randomseed

public static org.classdump.luna.runtime.LuaFunction randomseed(Random random)

Returns a function math.randomseed that sets the seed of the random generator random.

The following is the corresponding entry from the Lua Reference Manual:

math.randomseed (x)

Sets x as the "seed" for the pseudo-random generator: equal seeds produce equal sequences of numbers.

Parameters:

random - the random number generator, must not be null

Returns:

the math.randomseed function

Throws:

NullPointerException - if random is null

See Also:

the Lua 5.3 Reference Manual entry for math.randomseed

sin

public static org.classdump.luna.runtime.LuaFunction sin()

Returns the function math.sin.

The following is the corresponding entry from the Lua Reference Manual:

math.sin (x)

Returns the sine of x (assumed to be in radians).

Returns:

the math.sin function

See Also:

the Lua 5.3 Reference Manual entry for math.sin

sqrt

public static org.classdump.luna.runtime.LuaFunction sqrt()

Returns the function math.sqrt.

The following is the corresponding entry from the Lua Reference Manual:

math.sqrt (x)

Returns the square root of x. (You can also use the expression x^0.5 to compute this value.)

Returns:

the math.sqrt function

See Also:

the Lua 5.3 Reference Manual entry for math.sqrt

tan

public static org.classdump.luna.runtime.LuaFunction tan()

Returns the function math.tan.

The following is the corresponding entry from the Lua Reference Manual:

math.tan (x)

Returns the tangent of x (assumed to be in radians).

Returns:

the math.tan function

See Also:

the Lua 5.3 Reference Manual entry for math.tan

tointeger

public static org.classdump.luna.runtime.LuaFunction tointeger()

Returns the function math.tointeger.

The following is the corresponding entry from the Lua Reference Manual:

math.tointeger (x)

If the value x is convertible to an integer, returns that integer. Otherwise, returns nil.

Returns:

the math.tointeger function

See Also:

the Lua 5.3 Reference Manual entry for math.tointeger

type

public static org.classdump.luna.runtime.LuaFunction type()

Returns the function math.type.

The following is the corresponding entry from the Lua Reference Manual:

math.type (x)

Returns "integer" if x is an integer, "float" if it is a float, or nil if x is not a number.

Returns:

the math.type function

See Also:

the Lua 5.3 Reference Manual entry for math.type

ult

public static org.classdump.luna.runtime.LuaFunction ult()

Returns the function math.ult.

The following is the corresponding entry from the Lua Reference Manual:

math.ult (m, n)

Returns a boolean, true if integer m is below integer n when they are compared as unsigned integers.

Returns:

the math.ult function

See Also:

the Lua 5.3 Reference Manual entry for math.ult

installInto

public static void installInto(org.classdump.luna.StateContext context,
                               org.classdump.luna.Table env,
                               Random random)

Installs the math library to the global environment env in the state context context, with the random number generator random.

random may be null, in which case the functions random and randomseed will not be installed.

If env.package.loaded is a table, adds the library table to it with the key "math", using raw access.

Parameters:

context - the state context, must not be null

env - the global environment, must not be null

random - the random number generator, may be null

Throws:

NullPointerException - if context or env is null

installInto

public static void installInto(org.classdump.luna.StateContext context,
                               org.classdump.luna.Table env)

Installs the math library to the global environment env in the state context context, with a new random number generator of class Random.

To specify the random number generator or exclude random-related functions, use installInto(StateContext, Table, Random).

Parameters:

context - the state context, must not be null

env - the global environment, must not be null

Throws:

NullPointerException - if context or env is null