is new.
java.lang.Objectjava.lang.Math
The class Math contains methods for performing basic numeric operations such as the elementary exponential, logarithm, square root, and trigonometric functions.
Unlike some of the numeric methods of class StrictMath, all implementations of the equivalent functions of class Math are not defined to return the bit-for-bit same results. This relaxation permits better-performing implementations where strict reproducibility is not required.
By default many of the Math methods simply call the equivalent method in StrictMath for their implementation. Code generators are encouraged to use platform-specific native libraries or microprocessor instructions, where available, to provide higher-performance implementations of Math methods. Such higher-performance implementations still must conform to the specification for Math.
The quality of implementation specifications concern two properties, accuracy of the returned result and monotonicity of the method. Accuracy of the floating-point Math methods is measured in terms of
ulps
, units in the last place. For a given floating-point format, an ulp of a specific real number value is the
distance
difference
between the two floating-point values
bracketing
closest to
that numerical value. When discussing the accuracy of a method as a whole rather than at a specific argument, the number of ulps cited is for the worst-case error at any argument. If a method always has an error less than 0.5 ulps, the method always returns the floating-point number nearest the exact result; such a method is
correctly rounded
. A correctly rounded method is generally the best a floating-point approximation can be; however, it is impractical for many floating-point methods to be correctly rounded. Instead, for the Math class, a larger error bound of 1 or 2 ulps is allowed for certain methods. Informally, with a 1 ulp error bound, when the exact result is a representable
number,
number
the exact result should be
returned as the computed result;
returned;
otherwise, either of the two floating-point
values which bracket
numbers closest to
the exact result may be returned.
For exact results large in magnitude, one of the endpoints of the bracket may be infinite.
Besides accuracy at individual arguments, maintaining proper relations between the method at different arguments is also important. Therefore,
most
methods with more than 0.5 ulp errors are required to be
semi-monotonic
: whenever the mathematical function is non-decreasing, so is the floating-point approximation, likewise, whenever the mathematical function is non-increasing, so is the floating-point approximation. Not all approximations that have 1 ulp accuracy will automatically meet the monotonicity requirements.
| Field Summary | |
|---|---|
| static double |
E
The double value that is closer than any other to e , the base of the natural logarithms. |
| static double |
PI
The double value that is closer than any other to pi , the ratio of the circumference of a circle to its diameter. |
| Method Summary | |
|---|---|
| static double |
abs
(double a) Returns the absolute value of a double value. |
| static float |
abs
(float a) Returns the absolute value of a float value. |
| static int |
abs
(int a) Returns the absolute value of an int value. |
| static long |
abs
(long a) Returns the absolute value of a long value. |
| static double |
acos
(double a) Returns the arc cosine of an angle, in the range of 0.0 through pi . |
| static double |
asin
(double a) Returns the arc sine of an angle, in the range of - pi /2 through pi /2. |
| static double |
atan
(double a) Returns the arc tangent of an angle, in the range of - pi /2 through pi /2. |
| static double |
atan2
(double y, double x) Converts rectangular coordinates (x, y) to polar (r, theta ). |
| static double |
cbrt
Returns the
cube root of
double value.
|
static double
|
ceil
(double a)
Returns the largest (closest to positive infinity) double value that is not greater than the argument and is equal to a mathematical integer.
|
| static double |
cos
(double a) Returns the trigonometric cosine of an angle. |
static double
|
cosh
(double x)
Returns the hyperbolic cosine of a double value.
|
| static double |
exp
(double a) Returns Euler's number e raised to the power of a double value. |
static double
|
expm1
(double x)
Returns
e
x
-1.
|
| static double |
floor
(double a) Returns the largest (closest to positive infinity) double value that is not greater than the argument and is equal to a mathematical integer. |
static double
|
hypot
(double x, double y)
Returns sqrt(
x
2
+
y
2
) without intermediate overflow or underflow.
|
| static double |
IEEEremainder
(double f1, double f2) Computes the remainder operation on two arguments as prescribed by the IEEE 754 standard. |
| static double |
log
(double a) Returns the natural logarithm (base e ) of a double value. |
static double
|
log10
(double a)
Returns the base 10 logarithm of a double value.
|
static double
|
log1p
(double x)
Returns the natural logarithm of the sum of the argument and 1.
|
| static double |
max
(double a, double b) Returns the greater of two double values. |
| static float |
max
(float a, float b) Returns the greater of two float values. |
| static int |
max
(int a, int b) Returns the greater of two int values. |
| static long |
max
(long a, long b) Returns the greater of two long values. |
| static double |
min
(double a, double b) Returns the smaller of two double values. |
| static float |
min
(float a, float b) Returns the smaller of two float values. |
| static int |
min
(int a, int b) Returns the smaller of two int values. |
| static long |
min
(long a, long b) Returns the smaller of two long values. |
| static double |
pow
(double a, double b) Returns the value of the first argument raised to the power of the second argument. |
| static double |
random
() Returns a double value with a positive sign, greater than or equal to 0.0 and less than 1.0. |
| static double |
rint
(double a) Returns the double value that is closest in value to the argument and is equal to a mathematical integer. |
| static long |
round
(double a) Returns the closest long to the argument. |
| static int |
round
(float a) Returns the closest int to the argument. |
static double
|
signum
(double d)
Returns the signum function of the argument; zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
|
static float
|
signum
(float f)
Returns the signum function of the argument; zero if the argument is zero, 1.0f if the argument is greater than zero, -1.0f if the argument is less than zero.
|
| static double |
sin
(double a) Returns the trigonometric sine of an angle. |
static double
|
sinh
(double x)
Returns the hyperbolic sine of a double value.
|
| static double |
sqrt
(double a) Returns the correctly rounded positive square root of a double value. |
| static double |
tan
(double a) Returns the trigonometric tangent of an angle. |
static double
|
tanh
(double x)
Returns the hyperbolic tangent of a double value.
|
| static double |
toDegrees
(double angrad) Converts an angle measured in radians to an approximately equivalent angle measured in degrees. |
| static double |
toRadians
(double angdeg) Converts an angle measured in degrees to an approximately equivalent angle measured in radians. |
static double
|
ulp
(double d)
Returns the size of an ulp of the argument.
|
static float
|
ulp
(float f)
Returns the size of an ulp of the argument.
|
| Methods inherited from class java.lang. Object |
|---|
| clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
| Field Detail |
|---|
public static final double E
public static final double PI
| Method Detail |
|---|
public static double sin(double a)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static double cos(double a)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static double tan(double a)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static double asin(double a)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static double acos(double a)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static double atan(double a)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static double toRadians(double angdeg)
public static double toDegrees(double angrad)
public static double exp(double a)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static double log(double a)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
value
log10
public static double
log10
(double a)
Returns the base 10 logarithm of a double value. Special cases:
If the argument is NaN or less than zero, then the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is positive zero or negative zero, then the result is negative infinity.
If the argument is equal to 10
n
for integer
n
, then the result is
n
.
The computed result must be within 1 ulp of the exact result. Results must be semi-monotonic.
Parameters:
a - a value
Returns:
the base 10 logarithm of a.
Since:
1.5
public static double sqrt(double a)
cbrt
public static double
cbrt
(double a)
Returns the cube root of a double value. For positive finite x, cbrt(-x) == -cbrt(x); that is, the cube root of a negative value is the negative of the cube root of that value's magnitude. Special cases:
If the argument is NaN, then the result is NaN.
If the argument is infinite, then the result is an infinity with the same sign as the argument.
If the argument is zero, then the result is a zero with the same sign as the argument.
The computed result must be within 1 ulp of the exact result.
Parameters:
a - a value.
Returns:
the cube root of a.
Since:
1.5
public static double IEEEremainder(double f1,
double f2)
public static double ceil(double a)
largest
positive
greater
largest
positive
greater
public static double floor(double a)
smallest
negative
less
public static double rint(double a)
public static double atan2(double y,
double x)
The computed
A
result must be within 2 ulps of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static double pow(double a,
double b)
(In the foregoing descriptions, a floating-point value is considered to be an integer if and only if it is finite and a fixed point of the method ceil or, equivalently, a fixed point of the method floor . A value is a fixed point of a one-argument method if and only if the result of applying the method to the value is equal to the value.)
The computed
A
result must be within 1 ulp of the
exact
correctly rounded
result. Results must be semi-monotonic.
public static int round(float a)
(int)Math.floor(a + 0.5f)
Special cases:
public static long round(double a)
(long)Math.floor(a + 0.5d)
Special cases:
public static double random()
When this method is first called, it creates a single new pseudorandom-number generator, exactly as if by the expression
This new pseudorandom-number generator is used thereafter for all calls to this method and is used nowhere else.new java.util.Random
This method is properly synchronized to allow correct use by more than one thread. However, if many threads need to generate pseudorandom numbers at a great rate, it may reduce contention for each thread to have its own pseudorandom-number generator.
public static int abs(int a)
Note that if the argument is equal to the value of Integer.MIN_VALUE, the most negative representable int value, the result is that same value, which is negative.
public static long abs(long a)
Note that if the argument is equal to the value of Long.MIN_VALUE, the most negative representable long value, the result is that same value, which is negative.
public static float abs(float a)
Float.intBitsToFloat(0x7fffffff & Float.floatToIntBits(a))
public static double abs(double a)
Double.longBitsToDouble((Double.doubleToLongBits(a)<<1)>>>1)
public static int max(int a,
int b)
public static long max(long a,
long b)
public static float max(float a,
float b)
public static double max(double a,
double b)
public static int min(int a,
int b)
public static long min(long a,
long b)
public static float min(float a,
float b)
public static double min(double a,
double b)
ulp
public static double
ulp
(double d)
Returns the size of an ulp of the argument. An ulp of a double value is the positive distance between this floating-point value and the double value next larger in magnitude. Note that for non-NaN
x
, ulp(-
x
) == ulp(
x
).
If the argument is NaN, then the result is NaN.
If the argument is positive or negative infinity, then the result is positive infinity.
If the argument is positive or negative zero, then the result is Double.MIN_VALUE.
If the argument is ±Double.MAX_VALUE, then the result is equal to 2
971
.
Parameters:
d - the floating-point value whose ulp is to be returned
Returns:
the size of an ulp of the argument
Since:
1.5
ulp
public static float
ulp
(float f)
Returns the size of an ulp of the argument. An ulp of a float value is the positive distance between this floating-point value and the float value next larger in magnitude. Note that for non-NaN
x
, ulp(-
x
) == ulp(
x
).
If the argument is NaN, then the result is NaN.
If the argument is positive or negative infinity, then the result is positive infinity.
If the argument is positive or negative zero, then the result is Float.MIN_VALUE.
If the argument is ±Float.MAX_VALUE, then the result is equal to 2
104
.
Parameters:
f - the floating-point value whose ulp is to be returned
Returns:
the size of an ulp of the argument
Since:
1.5
signum
public static double
signum
(double d)
Returns the signum function of the argument; zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
If the argument is NaN, then the result is NaN.
If the argument is positive zero or negative zero, then the result is the same as the argument.
Parameters:
d - the floating-point value whose signum is to be returned
Returns:
the signum function of the argument
Since:
1.5
signum
public static float
signum
(float f)
Returns the signum function of the argument; zero if the argument is zero, 1.0f if the argument is greater than zero, -1.0f if the argument is less than zero.
If the argument is NaN, then the result is NaN.
If the argument is positive zero or negative zero, then the result is the same as the argument.
Parameters:
f - the floating-point value whose signum is to be returned
Returns:
the signum function of the argument
Since:
1.5
sinh
public static double
sinh
(double x)
Returns the hyperbolic sine of a double value. The hyperbolic sine of
x
is defined to be (
e
x
- e
-x
)/2 where
e
is
Euler's number
.
If the argument is NaN, then the result is NaN.
If the argument is infinite, then the result is an infinity with the same sign as the argument.
If the argument is zero, then the result is a zero with the same sign as the argument.
The computed result must be within 2.5 ulps of the exact result.
Parameters:
x - The number whose hyperbolic sine is to be returned.
Returns:
The hyperbolic sine of x.
Since:
1.5
cosh
public static double
cosh
(double x)
Returns the hyperbolic cosine of a double value. The hyperbolic cosine of
x
is defined to be (
e
x
+ e
-x
)/2 where
e
is
Euler's number
.
If the argument is NaN, then the result is NaN.
If the argument is infinite, then the result is positive infinity.
If the argument is zero, then the result is 1.0.
The computed result must be within 2.5 ulps of the exact result.
Parameters:
x - The number whose hyperbolic cosine is to be returned.
Returns:
The hyperbolic cosine of x.
Since:
1.5
tanh
public static double
tanh
(double x)
Returns the hyperbolic tangent of a double value. The hyperbolic tangent of
x
is defined to be (
e
x
- e
-x
)/(
e
x
+ e
-x
), in other words,
sinh(
x
)
/
cosh(
x
)
. Note that the absolute value of the exact tanh is always less than 1.
If the argument is NaN, then the result is NaN.
If the argument is zero, then the result is a zero with the same sign as the argument.
If the argument is positive infinity, then the result is +1.0.
If the argument is negative infinity, then the result is -1.0.
The computed result must be within 2.5 ulps of the exact result. The result of tanh for any finite input must have an absolute value less than or equal to 1. Note that once the exact result of tanh is within 1/2 of an ulp of the limit value of ±1, correctly signed ±1.0 should be returned.
Parameters:
x - The number whose hyperbolic tangent is to be returned.
Returns:
The hyperbolic tangent of x.
Since:
1.5
hypot
public static double
hypot
(double x, double y)
Returns sqrt(
x
2
+
y
2
) without intermediate overflow or underflow.
If either argument is infinite, then the result is positive infinity.
If either argument is NaN and neither argument is infinite, then the result is NaN.
The computed result must be within 1 ulp of the exact result. If one parameter is held constant, the results must be semi-monotonic in the other parameter.
Parameters:
x - a value
y - a value
Returns:
sqrt(
x
2
+
y
2
) without intermediate overflow or underflow
Since:
1.5
expm1
public static double
expm1
(double x)
Returns
e
x
-1. Note that for values of
x
near 0, the exact sum of expm1(x) + 1 is much closer to the true result of
e
x
than exp(x).
If the argument is NaN, the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is negative infinity, then the result is -1.0.
If the argument is zero, then the result is a zero with the same sign as the argument.
The computed result must be within 1 ulp of the exact result. Results must be semi-monotonic. The result of expm1 for any finite input must be greater than or equal to -1.0. Note that once the exact result of
e
x
- 1 is within 1/2 ulp of the limit value -1, -1.0 should be returned.
Parameters:
x - the exponent to raise
e
to in the computation of
e
x
-1.
Returns:
the value
e
x
- 1.
log1p
public static double
log1p
(double x)
Returns the natural logarithm of the sum of the argument and 1. Note that for small values x, the result of log1p(x) is much closer to the true result of ln(1 + x) than the floating-point evaulation of log(1.0+x).
If the argument is NaN or less than -1, then the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is negative one, then the result is negative infinity.
If the argument is zero, then the result is a zero with the same sign as the argument.
The computed result must be within 1 ulp of the exact result. Results must be semi-monotonic.
Parameters:
x - a value
Returns:
the value ln(x + 1), the natural log of x + 1