1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/* __ *\
** ________ ___ / / ___ Scala API **
** / __/ __// _ | / / / _ | (c) 2003-2013, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
package scala
/** The package object `scala.math` contains methods for performing basic
* numeric operations such as elementary exponential, logarithmic, root and
* trigonometric functions.
*
* All methods forward to [[java.lang.Math]] unless otherwise noted.
*
* @see [[java.lang.Math]]
*
* @groupname math-const Mathematical Constants
* @groupprio math-const 10
*
* @groupname minmax Minimum and Maximum
* @groupdesc minmax Find the min or max of two numbers. Note: [[scala.collection.TraversableOnce]] has
* min and max methods which determine the min or max of a collection.
* @groupprio minmax 20
*
* @groupname rounding Rounding
* @groupprio rounding 30
*
* @groupname explog Exponential and Logarithmic
* @groupprio explog 40
*
* @groupname trig Trigonometric
* @groupdesc trig Arguments in radians
* @groupprio trig 50
*
* @groupname angle-conversion Angular Measurement Conversion
* @groupprio angle-conversion 60
*
* @groupname hyperbolic Hyperbolic
* @groupprio hyperbolic 70
*
* @groupname abs Absolute Values
* @groupdesc abs Determine the magnitude of a value by discarding the sign. Results are >= 0.
* @groupprio abs 80
*
* @groupname signum Signs
* @groupdesc signum Extract the sign of a value. Results are -1, 0 or 1.
* Note that these are not pure forwarders to the java versions.
* In particular, the return type of java.lang.Long.signum is Int,
* but here it is widened to Long so that each overloaded variant
* will return the same numeric type it is passed.
* @groupprio signum 90
*
* @groupname root-extraction Root Extraction
* @groupprio root-extraction 100
*
* @groupname polar-coords Polar Coordinates
* @groupprio polar-coords 110
*
* @groupname ulp Unit of Least Precision
* @groupprio ulp 120
*
* @groupname randomisation Pseudo Random Number Generation
* @groupprio randomisation 130
*/
package object math {
/** The `Double` value that is closer than any other to `e`, the base of
* the natural logarithms.
* @group math-const
*/
@inline final val E = java.lang.Math.E
/** The `Double` value that is closer than any other to `pi`, the ratio of
* the circumference of a circle to its diameter.
* @group math-const
*/
@inline final val Pi = java.lang.Math.PI
/** Returns a `Double` value with a positive sign, greater than or equal
* to `0.0` and less than `1.0`.
*
* @group randomisation
*/
def random(): Double = java.lang.Math.random()
/** @group trig */
def sin(x: Double): Double = java.lang.Math.sin(x)
/** @group trig */
def cos(x: Double): Double = java.lang.Math.cos(x)
/** @group trig */
def tan(x: Double): Double = java.lang.Math.tan(x)
/** @group trig */
def asin(x: Double): Double = java.lang.Math.asin(x)
/** @group trig */
def acos(x: Double): Double = java.lang.Math.acos(x)
/** @group trig */
def atan(x: Double): Double = java.lang.Math.atan(x)
/** Converts an angle measured in degrees to an approximately equivalent
* angle measured in radians.
*
* @param x an angle, in degrees
* @return the measurement of the angle `x` in radians.
* @group angle-conversion
*/
def toRadians(x: Double): Double = java.lang.Math.toRadians(x)
/** Converts an angle measured in radians to an approximately equivalent
* angle measured in degrees.
*
* @param x angle, in radians
* @return the measurement of the angle `x` in degrees.
* @group angle-conversion
*/
def toDegrees(x: Double): Double = java.lang.Math.toDegrees(x)
/** Converts rectangular coordinates `(x, y)` to polar `(r, theta)`.
*
* @param x the ordinate coordinate
* @param y the abscissa coordinate
* @return the ''theta'' component of the point `(r, theta)` in polar
* coordinates that corresponds to the point `(x, y)` in
* Cartesian coordinates.
* @group polar-coords
*/
def atan2(y: Double, x: Double): Double = java.lang.Math.atan2(y, x)
/** Returns the square root of the sum of the squares of both given `Double`
* values without intermediate underflow or overflow.
*
* The ''r'' component of the point `(r, theta)` in polar
* coordinates that corresponds to the point `(x, y)` in
* Cartesian coordinates.
* @group polar-coords
*/
def hypot(x: Double, y: Double): Double = java.lang.Math.hypot(x, y)
// -----------------------------------------------------------------------
// rounding functions
// -----------------------------------------------------------------------
/** @group rounding */
def ceil(x: Double): Double = java.lang.Math.ceil(x)
/** @group rounding */
def floor(x: Double): Double = java.lang.Math.floor(x)
/** Returns the `Double` value that is closest in value to the
* argument and is equal to a mathematical integer.
*
* @param x a `Double` value
* @return the closest floating-point value to a that is equal to a
* mathematical integer.
* @group rounding
*/
def rint(x: Double): Double = java.lang.Math.rint(x)
/** There is no reason to round a `Long`, but this method prevents unintended conversion to `Float` followed by rounding to `Int`.
*
* @note Does not forward to [[java.lang.Math]]
* @group rounding
*/
@deprecated("This is an integer type; there is no reason to round it. Perhaps you meant to call this with a floating-point value?", "2.11.0")
def round(x: Long): Long = x
/** Returns the closest `Int` to the argument.
*
* @param x a floating-point value to be rounded to a `Int`.
* @return the value of the argument rounded to the nearest `Int` value.
* @group rounding
*/
def round(x: Float): Int = java.lang.Math.round(x)
/** Returns the closest `Long` to the argument.
*
* @param x a floating-point value to be rounded to a `Long`.
* @return the value of the argument rounded to the nearest`long` value.
* @group rounding
*/
def round(x: Double): Long = java.lang.Math.round(x)
/** @group abs */
def abs(x: Int): Int = java.lang.Math.abs(x)
/** @group abs */
def abs(x: Long): Long = java.lang.Math.abs(x)
/** @group abs */
def abs(x: Float): Float = java.lang.Math.abs(x)
/** @group abs */
def abs(x: Double): Double = java.lang.Math.abs(x)
/** @group minmax */
def max(x: Int, y: Int): Int = java.lang.Math.max(x, y)
/** @group minmax */
def max(x: Long, y: Long): Long = java.lang.Math.max(x, y)
/** @group minmax */
def max(x: Float, y: Float): Float = java.lang.Math.max(x, y)
/** @group minmax */
def max(x: Double, y: Double): Double = java.lang.Math.max(x, y)
/** @group minmax */
def min(x: Int, y: Int): Int = java.lang.Math.min(x, y)
/** @group minmax */
def min(x: Long, y: Long): Long = java.lang.Math.min(x, y)
/** @group minmax */
def min(x: Float, y: Float): Float = java.lang.Math.min(x, y)
/** @group minmax */
def min(x: Double, y: Double): Double = java.lang.Math.min(x, y)
/** @group signum
* @note Forwards to [[java.lang.Integer]]
*/
def signum(x: Int): Int = java.lang.Integer.signum(x)
/** @group signum
* @note Forwards to [[java.lang.Long]]
*/
def signum(x: Long): Long = java.lang.Long.signum(x)
/** @group signum */
def signum(x: Float): Float = java.lang.Math.signum(x)
/** @group signum */
def signum(x: Double): Double = java.lang.Math.signum(x)
// -----------------------------------------------------------------------
// root functions
// -----------------------------------------------------------------------
/** Returns the square root of a `Double` value.
*
* @param x the number to take the square root of
* @return the value √x
* @group root-extraction
*/
def sqrt(x: Double): Double = java.lang.Math.sqrt(x)
/** Returns the cube root of the given `Double` value.
*
* @param x the number to take the cube root of
* @return the value ∛x
* @group root-extraction
*/
def cbrt(x: Double): Double = java.lang.Math.cbrt(x)
// -----------------------------------------------------------------------
// exponential functions
// -----------------------------------------------------------------------
/** Returns the value of the first argument raised to the power of the
* second argument.
*
* @param x the base.
* @param y the exponent.
* @return the value `x^y^`.
* @group explog
*/
def pow(x: Double, y: Double): Double = java.lang.Math.pow(x, y)
/** Returns Euler's number `e` raised to the power of a `Double` value.
*
* @param x the exponent to raise `e` to.
* @return the value `e^a^`, where `e` is the base of the natural
* logarithms.
* @group explog
*/
def exp(x: Double): Double = java.lang.Math.exp(x)
/** Returns `exp(x) - 1`.
* @group explog
*/
def expm1(x: Double): Double = java.lang.Math.expm1(x)
// -----------------------------------------------------------------------
// logarithmic functions
// -----------------------------------------------------------------------
/** Returns the natural logarithm of a `Double` value.
*
* @param x the number to take the natural logarithm of
* @return the value `logₑ(x)` where `e` is Eulers number
* @group explog
*/
def log(x: Double): Double = java.lang.Math.log(x)
/** Returns the natural logarithm of the sum of the given `Double` value and 1.
* @group explog
*/
def log1p(x: Double): Double = java.lang.Math.log1p(x)
/** Returns the base 10 logarithm of the given `Double` value.
* @group explog
*/
def log10(x: Double): Double = java.lang.Math.log10(x)
// -----------------------------------------------------------------------
// trigonometric functions
// -----------------------------------------------------------------------
/** Returns the hyperbolic sine of the given `Double` value.
* @group hyperbolic
*/
def sinh(x: Double): Double = java.lang.Math.sinh(x)
/** Returns the hyperbolic cosine of the given `Double` value.
* @group hyperbolic
*/
def cosh(x: Double): Double = java.lang.Math.cosh(x)
/** Returns the hyperbolic tangent of the given `Double` value.
* @group hyperbolic
*/
def tanh(x: Double):Double = java.lang.Math.tanh(x)
// -----------------------------------------------------------------------
// miscellaneous functions
// -----------------------------------------------------------------------
/** Returns the size of an ulp of the given `Double` value.
* @group ulp
*/
def ulp(x: Double): Double = java.lang.Math.ulp(x)
/** Returns the size of an ulp of the given `Float` value.
* @group ulp
*/
def ulp(x: Float): Float = java.lang.Math.ulp(x)
/** @group rounding */
def IEEEremainder(x: Double, y: Double): Double = java.lang.Math.IEEEremainder(x, y)
}
|
