/*
This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2010 Servoy BV
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your option) any
later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along
with this program; if not, see http://www.gnu.org/licenses or write to the Free
Software Foundation,Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
*/
package com.servoy.j2db.documentation.scripting.docs;
import com.servoy.base.scripting.annotations.ServoyClientSupport;
import com.servoy.j2db.documentation.ServoyDocumented;
/**
* Dummy class for listing methods for JavaScript types in a manner that
* suits our documentation generator.
*
* @author gerzse
*/
@ServoyDocumented(category = ServoyDocumented.JSLIB, publicName = "Math", scriptingName = "Math")
@ServoyClientSupport(mc = true, wc = true, sc = true)
public class Math
{
/**
* Euler's constant and the base of natural logarithms. Approximately 2.718.
*
* @sample Math.E
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/E
*/
public Number js_getsamecase_E()
{
return null;
}
public void js_setsamecase_E(Number e)
{
}
/**
* Natural logarithm of 10. Approximately 2.302.
*
* @sample Math.LN10
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/LN10
*/
public Number js_getLN10()
{
return null;
}
public void js_setLN10(Number lN10)
{
}
/**
* Natural logarithm of 2. Approximately 0.693.
*
* @sample Math.LN2
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/LN2
*/
public Number js_getLN2()
{
return null;
}
public void js_setLN2(Number lN2)
{
}
/**
* Base 10 logarithm of E. Approximately 0.434.
*
* @sample Math.LOG10E
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/LOG10E
*/
public Number js_getLOG10E()
{
return null;
}
public void js_setLOG10E(Number lOG10E)
{
}
/**
* Base 2 logarithm of E. Approximately 1.442.
*
* @sample Math.LOG2E
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/LOG2E
*/
public Number js_getLOG2E()
{
return null;
}
public void js_setLOG2E(Number lOG2E)
{
}
/**
* Ratio of the circumference of a circle to its diameter. Approximately 3.14159.
*
* @sample Math.PI
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/PI
*/
public Number js_getPI()
{
return null;
}
public void js_setPI(Number pI)
{
}
/**
* Square root of 1/2. Equivalently, 1 over the square root of 2, approximately 0.707.
*
* @sample Math.SQRT1_2
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/SQRT1_2
*/
public Number js_getSQRT1_2()
{
return null;
}
public void js_setSQRT1_2(Number sQRT1_2)
{
}
/**
* Square root of 2. Approximately 1.414.
*
* @sample Math.SQRT2
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/SQRT2
*/
public Number js_getSQRT2()
{
return null;
}
public void js_setSQRT2(Number sQRT2)
{
}
/**
* Returns the absolute value of a number.
*
* @sample Math.abs(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/abs
*/
public Number js_abs(Number x)
{
return null;
}
/**
* Returns the arccosine (in radians) of a number.
*
* @sample Math.acos(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/acos
*/
public Number js_acos(Number x)
{
return null;
}
/**
* Returns the arcsine (in radians) of a number.
*
* @sample Math.asin(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/asin
*/
public Number js_asin(Number x)
{
return null;
}
/**
* Returns the arctangent (in radians) of a number.
*
* @sample Math.atan(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/atan
*/
public Number js_atan(Number x)
{
return null;
}
/**
* Returns the arctangent of the quotient of its arguments.
*
* @sample Math.atan2(number,number)
*
* @param y
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/atan2
*/
public Number js_atan2(Number y, Number x)
{
return null;
}
/**
* Returns the smallest integer greater than or equal to a number.
*
* @sample Math.ceil(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/ceil
*/
public Number js_ceil(Number x)
{
return null;
}
/**
* Returns the cosine of a number.
*
* @sample Math.cos(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/cos
*/
public Number js_cos(Number x)
{
return null;
}
/**
* Returns Enumber, where number is the argument, and E is Euler's constant, the base of the natural logarithms.
*
* @sample Math.exp(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/exp
*/
public Number js_exp(Number x)
{
return null;
}
/**
* Returns the largest integer less than or equal to a number.
*
* @sample Math.floor(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/floor
*/
public Number js_floor(Number x)
{
return null;
}
/**
* Returns the natural logarithm (base E) of a number.
*
* @sample Math.log(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/log
*/
public Number js_log(Number x)
{
return null;
}
/**
* Returns the greater of two (or more) numbers.
*
* @sample Math.max(number,number,number)
*
* @param value
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/max
*/
public Number js_max(Number... value)
{
return null;
}
/**
* Returns the lesser of two (or more) numbers.
*
* @sample Math.min(number,number,number)
*
* @param value
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/min
*/
public Number js_min(Number... value)
{
return null;
}
/**
* Returns base to the exponent power, that is, base exponent.
*
* @sample Math.pow(number,number)
*
* @param base
* @param exponent
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/pow
*/
public Number js_pow(Number base, Number exponent)
{
return null;
}
/**
* Returns a pseudo-random number between 0 and 1.
*
* @sample Math.random()
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/random
*/
public void js_random()
{
}
/**
* Returns the value of a number rounded to the nearest integer.
*
* @sample Math.round(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/round
*/
public void js_round(Number x)
{
}
/**
* Returns the sine of a number.
*
* @sample Math.sin(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/sin
*/
public void js_sin(Number x)
{
}
/**
* Returns the square root of a number.
*
* @sample Math.sqrt(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/sqrt
*/
public void js_sqrt(Number x)
{
}
/**
* Returns the tangent of a number.
*
* @sample Math.tan(number)
*
* @param x
*
* @link https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/tan
*/
public void js_tan(Number x)
{
}
}