LuaSearch - Navigate Lua Module Documentation


NAME

math - mathematical functions (standard library)


OVERVIEW

This library is an interface to the standard C math library. It provides all its functions inside the table math.


REFERENCE

math.abs

  math.abs (x)

Returns the absolute value of x.

math.acos

  math.acos (x)

Returns the arc cosine of x (in radians).

math.asin

  math.asin (x)

Returns the arc sine of x (in radians).

math.atan

  math.atan (x)

Returns the arc tangent of x (in radians).

math.atan2

  math.atan2 (x, y)

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

math.ceil

  math.ceil (x)

Returns the smallest integer larger than or equal to x.

math.cos

  math.cos (x)

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

math.cosh

  math.cosh (x)

Returns the hyperbolic cosine of x.

math.deg math.deg (x)

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

math.exp

  math.exp (x)

Returns the the value e^x.

math.floor

  math.floor (x)

Returns the largest integer smaller than or equal to x.

math.fmod

math.fmod (x, y)

Returns the remainder of the division of x by y.

math.frexp

math.frexp (x)

Returns m and e such that x = m2^e, e is an integer and the absolute value of m is in the range [0.5, 1) (or zero when x is zero).

math.huge

  math.huge

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

math.ldexp

  math.ldexp (m, e)

Returns m2^e (e should be an integer).

math.log

  math.log (x)

Returns the natural logarithm of x.

  math.log10 (x)

Returns the base-10 logarithm of x.

math.max

  math.max (x, ...)

Returns the maximum value among its arguments.

math.min

  math.min (x, ...)

Returns the minimum value among its arguments.

math.modf

  math.modf (x)

Returns two numbers, the integral part of x and the fractional part of x.

math.pi

  math.pi

The value PI.

math.pow

  math.pow (x, y)

Returns x^y. (You can also use the expression x^y to compute this value.)

math.rad

  math.rad (x)

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

math.random

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

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

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

math.randomseed

  math.randomseed (x)

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

math.sin

  math.sin (x)

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

math.sinh

  math.sinh (x)

Returns the hyperbolic sine of x.

math.sqrt

  math.sqrt (x)

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

math.tan

  math.tan (x)

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

math.tanh

  math.tanh (x)

Returns the hyperbolic tangent of x.


VERSION

This is Lua version 5.1.1.


CREDITS

Lua is developed at Lua.org, a laboratory of the Department of Computer Science of PUC-Rio (the Pontifical Catholic University of Rio de Janeiro in Brazil). For more information about the authors, see http://www.lua.org/authors.html .


LICENSE

Lua is licensed under the terms of the MIT license reproduced below. This means that Lua is free software and can be used for both academic and commercial purposes at absolutely no cost.

For details and rationale, see http://www.lua.org/license.html .

~~~~~

Copyright (C) 1994-2006 Lua.org, PUC-Rio.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ``Software''), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

~~~~~