Package com.prineside.luaj.lib.jse

Class JseMathLib

java.lang.Object

com.prineside.luaj.Varargs

com.prineside.luaj.LuaValue

com.prineside.luaj.LuaFunction

com.prineside.luaj.lib.LibFunction

com.prineside.luaj.lib.TwoArgFunction

com.prineside.luaj.lib.MathLib

com.prineside.luaj.lib.jse.JseMathLib

All Implemented Interfaces:

com.esotericsoftware.kryo.KryoSerializable

public final class JseMathLib
extends MathLib

Subclass of LibFunction which implements the lua standard math library.

It contains all lua math functions, including those not available on the JME platform.

Typically, this library is included as part of a call to

 
 Globals globals = JsePlatform.standardGlobals();
 System.out.println( globals.get("math").get("sqrt").call( LuaValue.valueOf(2) ) );
  

For special cases where the smallest possible footprint is desired, a minimal set of libraries could be loaded directly via LuaValue.load(LuaValue) using code such as:

 
 Globals globals = new Globals();
 globals.load(new JseBaseLib());
 globals.load(new PackageLib());
 globals.load(new JseMathLib());
 System.out.println( globals.get("math").get("sqrt").call( LuaValue.valueOf(2) ) );
  

However, other libraries such as CoroutineLib are not loaded in this case.

This has been implemented to match as closely as possible the behavior in the corresponding library in C.

See Also:

• LibFunction
• Lua 5.2 Math Lib Reference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JseMathLib.acos
static final class	JseMathLib.asin
static final class	JseMathLib.atan2
static final class	JseMathLib.cosh
static final class	JseMathLib.exp
static final class	JseMathLib.log
static final class	JseMathLib.pow
static final class	JseMathLib.sinh
static final class	JseMathLib.tanh

Nested classes/interfaces inherited from class com.prineside.luaj.lib.MathLib

MathLib.abs, MathLib.ceil, MathLib.cos, MathLib.deg, MathLib.floor, MathLib.fmod, MathLib.frexp, MathLib.ldexp, MathLib.max, MathLib.min, MathLib.modf, MathLib.rad, MathLib.random, MathLib.randomseed, MathLib.sin, MathLib.sqrt, MathLib.tan

Nested classes/interfaces inherited from class com.prineside.luaj.LuaValue

LuaValue.NillableSerializer, LuaValue.None

Nested classes/interfaces inherited from class com.prineside.luaj.Varargs

Varargs.ArrayVarargs

Field Summary

Fields inherited from class com.prineside.luaj.lib.MathLib

MATHLIB

Fields inherited from class com.prineside.luaj.LuaFunction

s_metatable

Fields inherited from class com.prineside.luaj.LuaValue

ADD, CALL, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, INDEX, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, NILLABLE_SERIALIZER, NILS, NONE, NOVALS, ONE, POW, SUB, TBOOLEAN, TFUNCTION, TINT, TLIGHTUSERDATA, TNIL, TNONE, TNUMBER, TOSTRING, TRUE, TSTRING, TTABLE, TTHREAD, TUSERDATA, TVALUE, TYPE_NAMES, UNM, ZERO

Constructor Summary

Constructors

Constructor	Description
JseMathLib()

Method Summary

Modifier and Type	Method	Description
LuaValue	call(LuaValue modname, LuaValue env)	Perform one-time initialization on the library by creating a table containing the library functions, adding that table to the supplied environment, adding the table to package.loaded, and returning table as the return value.
double	dpow_lib(double a, double b)	Faster, better version of pow() used by arithmetic operator ^

Methods inherited from class com.prineside.luaj.lib.MathLib

dpow, dpow_d

Methods inherited from class com.prineside.luaj.lib.TwoArgFunction

call, call, call, invoke

Methods inherited from class com.prineside.luaj.lib.LibFunction

call, read, tojstring, write

Methods inherited from class com.prineside.luaj.LuaFunction

checkfunction, classnamestub, getmetatable, isfunction, name, optfunction, strvalue, type, typename

Methods inherited from class com.prineside.luaj.LuaValue

add, add, add, and, arg, arg1, argerror, assert_, buffer, call, cBool, cDouble, cFloat, checkboolean, checkclosure, checkdouble, checkglobals, checkint, checkjstring, checklong, checknotnil, checknumber, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, cInt, cNcDouble, cNcFloat, cNcInt, cObject, comparemt, concat, concat, concatmt, concatTo, concatTo, concatTo, cRegObject, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, div, div, div, divInto, eq, eq_b, eqmtcall, equals, error, get, get, get, gt, gt, gt, gt_b, gt_b, gt_b, gteq, gteq, gteq, gteq_b, gteq_b, gteq_b, inext, initupvalue1, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isclosure, isint, isinttype, islong, isnil, isnumber, isRegObject, isstring, istable, isthread, isuserdata, isuserdata, isvalidkey, len, length, listOf, listOf, load, lt, lt, lt, lt_b, lt_b, lt_b, lteq, lteq, lteq, lteq_b, lteq_b, lteq_b, markAsConst, metatag, method, method, method, method, method, method, mod, mod, mod, modFrom, mul, mul, mul, narg, neg, neq, neq_b, next, not, onInvoke, optboolean, optclosure, optdouble, optint, optjstring, optlong, optnumber, optstring, opttable, optthread, optuserdata, optuserdata, optvalue, or, pow, pow, pow, powWith, powWith, presize, raweq, raweq, raweq, raweq, raweq, rawget, rawget, rawget, rawlen, rawset, rawset, rawset, rawset, rawset, rawset, rawset, rawsetlist, set, set, set, set, set, set, set, setmetatable, strcmp, strcmp, strongvalue, sub, sub, sub, subargs, subFrom, subFrom, tableOf, tableOf, tableOf, tableOf, tableOf, tableOf, tailcallOf, testfor_b, toboolean, tobyte, tochar, todouble, tofloat, toint, tolong, tonumber, toshort, tostring, toString, touserdata, touserdata, userdataOf, userdataOf, valueOf, valueOf, valueOf, valueOf, valueOf, valueOf

Methods inherited from class com.prineside.luaj.Varargs

argcheck, checkboolean, checkclosure, checkdouble, checkfunction, checkint, checkjstring, checklong, checknotnil, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, checkvalue, dealias, eval, isfunction, isnil, isnoneornil, isnumber, isstring, istable, isTailcall, isthread, isuserdata, isvalue, optboolean, optclosure, optdouble, optfunction, optint, optjstring, optlong, optnumber, optstring, opttable, optthread, optuserdata, optuserdata, optvalue, toboolean, tobyte, tochar, todouble, tofloat, toint, tojstring, tolong, toshort, touserdata, touserdata, type

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JseMathLib

public JseMathLib()

Method Details

call

public LuaValue call(LuaValue modname,
 LuaValue env)

Perform one-time initialization on the library by creating a table containing the library functions, adding that table to the supplied environment, adding the table to package.loaded, and returning table as the return value.

Specifically, adds all library functions that can be implemented directly in JSE but not JME: acos, asin, atan, atan2, cosh, exp, log, pow, sinh, and tanh.

Overrides:

call in class MathLib

Parameters:

modname - the module name supplied if this is loaded via 'require'.

env - the environment to load into, which must be a Globals instance.

Returns:

First return value (this(arg1,arg2)), or LuaValue.NIL if there were none.

See Also:

• LuaValue.call()
• LuaValue.call(LuaValue)
• LuaValue.call(LuaValue, LuaValue, LuaValue)
• LuaValue.invoke(LuaValue, Varargs)
• LuaValue.method(String,LuaValue,LuaValue)
• LuaValue.method(LuaValue,LuaValue,LuaValue)

dpow_lib

public double dpow_lib(double a,
 double b)

Faster, better version of pow() used by arithmetic operator ^

Overrides:

dpow_lib in class MathLib