You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by gu...@apache.org on 2018/03/05 14:46:46 UTC
spark git commit: [SPARK-23329][SQL] Fix documentation of
trigonometric functions
Repository: spark
Updated Branches:
refs/heads/master 5ff72ffcf -> a366b950b
[SPARK-23329][SQL] Fix documentation of trigonometric functions
## What changes were proposed in this pull request?
Provide more details in trigonometric function documentations. Referenced `java.lang.Math` for further details in the descriptions.
## How was this patch tested?
Ran full build, checked generated documentation manually
Author: Mihaly Toth <mi...@gmail.com>
Closes #20618 from misutoth/trigonometric-doc.
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/a366b950
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/a366b950
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/a366b950
Branch: refs/heads/master
Commit: a366b950b90650693ad0eb1e5b9a988ad028d845
Parents: 5ff72ff
Author: Mihaly Toth <mi...@gmail.com>
Authored: Mon Mar 5 23:46:40 2018 +0900
Committer: hyukjinkwon <gu...@gmail.com>
Committed: Mon Mar 5 23:46:40 2018 +0900
----------------------------------------------------------------------
R/pkg/R/functions.R | 34 ++--
python/pyspark/sql/functions.py | 62 ++++---
.../catalyst/expressions/mathExpressions.scala | 99 +++++++++---
.../scala/org/apache/spark/sql/functions.scala | 160 +++++++++++++------
4 files changed, 248 insertions(+), 107 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/spark/blob/a366b950/R/pkg/R/functions.R
----------------------------------------------------------------------
diff --git a/R/pkg/R/functions.R b/R/pkg/R/functions.R
index 9f7c631..29ee146 100644
--- a/R/pkg/R/functions.R
+++ b/R/pkg/R/functions.R
@@ -278,8 +278,8 @@ setMethod("abs",
})
#' @details
-#' \code{acos}: Computes the cosine inverse of the given value; the returned angle is in
-#' the range 0.0 through pi.
+#' \code{acos}: Returns the inverse cosine of the given value,
+#' as if computed by \code{java.lang.Math.acos()}
#'
#' @rdname column_math_functions
#' @export
@@ -334,8 +334,8 @@ setMethod("ascii",
})
#' @details
-#' \code{asin}: Computes the sine inverse of the given value; the returned angle is in
-#' the range -pi/2 through pi/2.
+#' \code{asin}: Returns the inverse sine of the given value,
+#' as if computed by \code{java.lang.Math.asin()}
#'
#' @rdname column_math_functions
#' @export
@@ -349,8 +349,8 @@ setMethod("asin",
})
#' @details
-#' \code{atan}: Computes the tangent inverse of the given value; the returned angle is in the range
-#' -pi/2 through pi/2.
+#' \code{atan}: Returns the inverse tangent of the given value,
+#' as if computed by \code{java.lang.Math.atan()}
#'
#' @rdname column_math_functions
#' @export
@@ -613,7 +613,8 @@ setMethod("covar_pop", signature(col1 = "characterOrColumn", col2 = "characterOr
})
#' @details
-#' \code{cos}: Computes the cosine of the given value. Units in radians.
+#' \code{cos}: Returns the cosine of the given value,
+#' as if computed by \code{java.lang.Math.cos()}. Units in radians.
#'
#' @rdname column_math_functions
#' @aliases cos cos,Column-method
@@ -627,7 +628,8 @@ setMethod("cos",
})
#' @details
-#' \code{cosh}: Computes the hyperbolic cosine of the given value.
+#' \code{cosh}: Returns the hyperbolic cosine of the given value,
+#' as if computed by \code{java.lang.Math.cosh()}.
#'
#' @rdname column_math_functions
#' @aliases cosh cosh,Column-method
@@ -1463,7 +1465,8 @@ setMethod("sign", signature(x = "Column"),
})
#' @details
-#' \code{sin}: Computes the sine of the given value. Units in radians.
+#' \code{sin}: Returns the sine of the given value,
+#' as if computed by \code{java.lang.Math.sin()}. Units in radians.
#'
#' @rdname column_math_functions
#' @aliases sin sin,Column-method
@@ -1477,7 +1480,8 @@ setMethod("sin",
})
#' @details
-#' \code{sinh}: Computes the hyperbolic sine of the given value.
+#' \code{sinh}: Returns the hyperbolic sine of the given value,
+#' as if computed by \code{java.lang.Math.sinh()}.
#'
#' @rdname column_math_functions
#' @aliases sinh sinh,Column-method
@@ -1653,7 +1657,9 @@ setMethod("sumDistinct",
})
#' @details
-#' \code{tan}: Computes the tangent of the given value. Units in radians.
+#' \code{tan}: Returns the tangent of the given value,
+#' as if computed by \code{java.lang.Math.tan()}.
+#' Units in radians.
#'
#' @rdname column_math_functions
#' @aliases tan tan,Column-method
@@ -1667,7 +1673,8 @@ setMethod("tan",
})
#' @details
-#' \code{tanh}: Computes the hyperbolic tangent of the given value.
+#' \code{tanh}: Returns the hyperbolic tangent of the given value,
+#' as if computed by \code{java.lang.Math.tanh()}.
#'
#' @rdname column_math_functions
#' @aliases tanh tanh,Column-method
@@ -1973,7 +1980,8 @@ setMethod("year",
#' @details
#' \code{atan2}: Returns the angle theta from the conversion of rectangular coordinates
-#' (x, y) to polar coordinates (r, theta). Units in radians.
+#' (x, y) to polar coordinates (r, theta),
+#' as if computed by \code{java.lang.Math.atan2()}. Units in radians.
#'
#' @rdname column_math_functions
#' @aliases atan2 atan2,Column-method
http://git-wip-us.apache.org/repos/asf/spark/blob/a366b950/python/pyspark/sql/functions.py
----------------------------------------------------------------------
diff --git a/python/pyspark/sql/functions.py b/python/pyspark/sql/functions.py
index 9bb9c32..b9c0c57 100644
--- a/python/pyspark/sql/functions.py
+++ b/python/pyspark/sql/functions.py
@@ -106,18 +106,15 @@ _functions = {
_functions_1_4 = {
# unary math functions
- 'acos': 'Computes the cosine inverse of the given value; the returned angle is in the range' +
- '0.0 through pi.',
- 'asin': 'Computes the sine inverse of the given value; the returned angle is in the range' +
- '-pi/2 through pi/2.',
- 'atan': 'Computes the tangent inverse of the given value; the returned angle is in the range' +
- '-pi/2 through pi/2',
+ 'acos': ':return: inverse cosine of `col`, as if computed by `java.lang.Math.acos()`',
+ 'asin': ':return: inverse sine of `col`, as if computed by `java.lang.Math.asin()`',
+ 'atan': ':return: inverse tangent of `col`, as if computed by `java.lang.Math.atan()`',
'cbrt': 'Computes the cube-root of the given value.',
'ceil': 'Computes the ceiling of the given value.',
- 'cos': """Computes the cosine of the given value.
-
- :param col: :class:`DoubleType` column, units in radians.""",
- 'cosh': 'Computes the hyperbolic cosine of the given value.',
+ 'cos': """:param col: angle in radians
+ :return: cosine of the angle, as if computed by `java.lang.Math.cos()`.""",
+ 'cosh': """:param col: hyperbolic angle
+ :return: hyperbolic cosine of the angle, as if computed by `java.lang.Math.cosh()`""",
'exp': 'Computes the exponential of the given value.',
'expm1': 'Computes the exponential of the given value minus one.',
'floor': 'Computes the floor of the given value.',
@@ -127,14 +124,16 @@ _functions_1_4 = {
'rint': 'Returns the double value that is closest in value to the argument and' +
' is equal to a mathematical integer.',
'signum': 'Computes the signum of the given value.',
- 'sin': """Computes the sine of the given value.
-
- :param col: :class:`DoubleType` column, units in radians.""",
- 'sinh': 'Computes the hyperbolic sine of the given value.',
- 'tan': """Computes the tangent of the given value.
-
- :param col: :class:`DoubleType` column, units in radians.""",
- 'tanh': 'Computes the hyperbolic tangent of the given value.',
+ 'sin': """:param col: angle in radians
+ :return: sine of the angle, as if computed by `java.lang.Math.sin()`""",
+ 'sinh': """:param col: hyperbolic angle
+ :return: hyperbolic sine of the given value,
+ as if computed by `java.lang.Math.sinh()`""",
+ 'tan': """:param col: angle in radians
+ :return: tangent of the given value, as if computed by `java.lang.Math.tan()`""",
+ 'tanh': """:param col: hyperbolic angle
+ :return: hyperbolic tangent of the given value,
+ as if computed by `java.lang.Math.tanh()`""",
'toDegrees': '.. note:: Deprecated in 2.1, use :func:`degrees` instead.',
'toRadians': '.. note:: Deprecated in 2.1, use :func:`radians` instead.',
'bitwiseNOT': 'Computes bitwise not.',
@@ -173,16 +172,31 @@ _functions_1_6 = {
_functions_2_1 = {
# unary math functions
- 'degrees': 'Converts an angle measured in radians to an approximately equivalent angle ' +
- 'measured in degrees.',
- 'radians': 'Converts an angle measured in degrees to an approximately equivalent angle ' +
- 'measured in radians.',
+ 'degrees': """
+ Converts an angle measured in radians to an approximately equivalent angle
+ measured in degrees.
+ :param col: angle in radians
+ :return: angle in degrees, as if computed by `java.lang.Math.toDegrees()`
+ """,
+ 'radians': """
+ Converts an angle measured in degrees to an approximately equivalent angle
+ measured in radians.
+ :param col: angle in degrees
+ :return: angle in radians, as if computed by `java.lang.Math.toRadians()`
+ """,
}
# math functions that take two arguments as input
_binary_mathfunctions = {
- 'atan2': 'Returns the angle theta from the conversion of rectangular coordinates (x, y) to' +
- 'polar coordinates (r, theta). Units in radians.',
+ 'atan2': """
+ :param col1: coordinate on y-axis
+ :param col2: coordinate on x-axis
+ :return: the `theta` component of the point
+ (`r`, `theta`)
+ in polar coordinates that corresponds to the point
+ (`x`, `y`) in Cartesian coordinates,
+ as if computed by `java.lang.Math.atan2()`
+ """,
'hypot': 'Computes ``sqrt(a^2 + b^2)`` without intermediate overflow or underflow.',
'pow': 'Returns the value of the first argument raised to the power of the second argument.',
}
http://git-wip-us.apache.org/repos/asf/spark/blob/a366b950/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/mathExpressions.scala
----------------------------------------------------------------------
diff --git a/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/mathExpressions.scala b/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/mathExpressions.scala
index 2c2cf3d..bc4cfce 100644
--- a/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/mathExpressions.scala
+++ b/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/mathExpressions.scala
@@ -168,9 +168,11 @@ case class Pi() extends LeafMathExpression(math.Pi, "PI")
////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////
-// scalastyle:off line.size.limit
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the inverse cosine (a.k.a. arccosine) of `expr` if -1<=`expr`<=1 or NaN otherwise.",
+ usage = """
+ _FUNC_(expr) - Returns the inverse cosine (a.k.a. arc cosine) of `expr`, as if computed by
+ `java.lang.Math._FUNC_`.
+ """,
examples = """
Examples:
> SELECT _FUNC_(1);
@@ -178,12 +180,13 @@ case class Pi() extends LeafMathExpression(math.Pi, "PI")
> SELECT _FUNC_(2);
NaN
""")
-// scalastyle:on line.size.limit
case class Acos(child: Expression) extends UnaryMathExpression(math.acos, "ACOS")
-// scalastyle:off line.size.limit
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the inverse sine (a.k.a. arcsine) the arc sin of `expr` if -1<=`expr`<=1 or NaN otherwise.",
+ usage = """
+ _FUNC_(expr) - Returns the inverse sine (a.k.a. arc sine) the arc sin of `expr`,
+ as if computed by `java.lang.Math._FUNC_`.
+ """,
examples = """
Examples:
> SELECT _FUNC_(0);
@@ -191,18 +194,18 @@ case class Acos(child: Expression) extends UnaryMathExpression(math.acos, "ACOS"
> SELECT _FUNC_(2);
NaN
""")
-// scalastyle:on line.size.limit
case class Asin(child: Expression) extends UnaryMathExpression(math.asin, "ASIN")
-// scalastyle:off line.size.limit
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the inverse tangent (a.k.a. arctangent).",
+ usage = """
+ _FUNC_(expr) - Returns the inverse tangent (a.k.a. arc tangent) of `expr`, as if computed by
+ `java.lang.Math._FUNC_`
+ """,
examples = """
Examples:
> SELECT _FUNC_(0);
0.0
""")
-// scalastyle:on line.size.limit
case class Atan(child: Expression) extends UnaryMathExpression(math.atan, "ATAN")
@ExpressionDescription(
@@ -252,7 +255,14 @@ case class Ceil(child: Expression) extends UnaryMathExpression(math.ceil, "CEIL"
}
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the cosine of `expr`.",
+ usage = """
+ _FUNC_(expr) - Returns the cosine of `expr`, as if computed by
+ `java.lang.Math._FUNC_`.
+ """,
+ arguments = """
+ Arguments:
+ * expr - angle in radians
+ """,
examples = """
Examples:
> SELECT _FUNC_(0);
@@ -261,7 +271,14 @@ case class Ceil(child: Expression) extends UnaryMathExpression(math.ceil, "CEIL"
case class Cos(child: Expression) extends UnaryMathExpression(math.cos, "COS")
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the hyperbolic cosine of `expr`.",
+ usage = """
+ _FUNC_(expr) - Returns the hyperbolic cosine of `expr`, as if computed by
+ `java.lang.Math._FUNC_`.
+ """,
+ arguments = """
+ Arguments:
+ * expr - hyperbolic angle
+ """,
examples = """
Examples:
> SELECT _FUNC_(0);
@@ -512,7 +529,11 @@ case class Rint(child: Expression) extends UnaryMathExpression(math.rint, "ROUND
case class Signum(child: Expression) extends UnaryMathExpression(math.signum, "SIGNUM")
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the sine of `expr`.",
+ usage = "_FUNC_(expr) - Returns the sine of `expr`, as if computed by `java.lang.Math._FUNC_`.",
+ arguments = """
+ Arguments:
+ * expr - angle in radians
+ """,
examples = """
Examples:
> SELECT _FUNC_(0);
@@ -521,7 +542,13 @@ case class Signum(child: Expression) extends UnaryMathExpression(math.signum, "S
case class Sin(child: Expression) extends UnaryMathExpression(math.sin, "SIN")
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the hyperbolic sine of `expr`.",
+ usage = """
+ _FUNC_(expr) - Returns hyperbolic sine of `expr`, as if computed by `java.lang.Math._FUNC_`.
+ """,
+ arguments = """
+ Arguments:
+ * expr - hyperbolic angle
+ """,
examples = """
Examples:
> SELECT _FUNC_(0);
@@ -539,7 +566,13 @@ case class Sinh(child: Expression) extends UnaryMathExpression(math.sinh, "SINH"
case class Sqrt(child: Expression) extends UnaryMathExpression(math.sqrt, "SQRT")
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the tangent of `expr`.",
+ usage = """
+ _FUNC_(expr) - Returns the tangent of `expr`, as if computed by `java.lang.Math._FUNC_`.
+ """,
+ arguments = """
+ Arguments:
+ * expr - angle in radians
+ """,
examples = """
Examples:
> SELECT _FUNC_(0);
@@ -548,7 +581,13 @@ case class Sqrt(child: Expression) extends UnaryMathExpression(math.sqrt, "SQRT"
case class Tan(child: Expression) extends UnaryMathExpression(math.tan, "TAN")
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the cotangent of `expr`.",
+ usage = """
+ _FUNC_(expr) - Returns the cotangent of `expr`, as if computed by `1/java.lang.Math._FUNC_`.
+ """,
+ arguments = """
+ Arguments:
+ * expr - angle in radians
+ """,
examples = """
Examples:
> SELECT _FUNC_(1);
@@ -562,7 +601,14 @@ case class Cot(child: Expression)
}
@ExpressionDescription(
- usage = "_FUNC_(expr) - Returns the hyperbolic tangent of `expr`.",
+ usage = """
+ _FUNC_(expr) - Returns the hyperbolic tangent of `expr`, as if computed by
+ `java.lang.Math._FUNC_`.
+ """,
+ arguments = """
+ Arguments:
+ * expr - hyperbolic angle
+ """,
examples = """
Examples:
> SELECT _FUNC_(0);
@@ -572,6 +618,10 @@ case class Tanh(child: Expression) extends UnaryMathExpression(math.tanh, "TANH"
@ExpressionDescription(
usage = "_FUNC_(expr) - Converts radians to degrees.",
+ arguments = """
+ Arguments:
+ * expr - angle in radians
+ """,
examples = """
Examples:
> SELECT _FUNC_(3.141592653589793);
@@ -583,6 +633,10 @@ case class ToDegrees(child: Expression) extends UnaryMathExpression(math.toDegre
@ExpressionDescription(
usage = "_FUNC_(expr) - Converts degrees to radians.",
+ arguments = """
+ Arguments:
+ * expr - angle in degrees
+ """,
examples = """
Examples:
> SELECT _FUNC_(180);
@@ -768,15 +822,22 @@ case class Unhex(child: Expression) extends UnaryExpression with ImplicitCastInp
////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////
-// scalastyle:off line.size.limit
@ExpressionDescription(
- usage = "_FUNC_(expr1, expr2) - Returns the angle in radians between the positive x-axis of a plane and the point given by the coordinates (`expr1`, `expr2`).",
+ usage = """
+ _FUNC_(exprY, exprX) - Returns the angle in radians between the positive x-axis of a plane
+ and the point given by the coordinates (`exprX`, `exprY`), as if computed by
+ `java.lang.Math._FUNC_`.
+ """,
+ arguments = """
+ Arguments:
+ * exprY - coordinate on y-axis
+ * exprX - coordinate on x-axis
+ """,
examples = """
Examples:
> SELECT _FUNC_(0, 0);
0.0
""")
-// scalastyle:on line.size.limit
case class Atan2(left: Expression, right: Expression)
extends BinaryMathExpression(math.atan2, "ATAN2") {
http://git-wip-us.apache.org/repos/asf/spark/blob/a366b950/sql/core/src/main/scala/org/apache/spark/sql/functions.scala
----------------------------------------------------------------------
diff --git a/sql/core/src/main/scala/org/apache/spark/sql/functions.scala b/sql/core/src/main/scala/org/apache/spark/sql/functions.scala
index 0d54c02..c9ca9a8 100644
--- a/sql/core/src/main/scala/org/apache/spark/sql/functions.scala
+++ b/sql/core/src/main/scala/org/apache/spark/sql/functions.scala
@@ -1313,8 +1313,7 @@ object functions {
//////////////////////////////////////////////////////////////////////////////////////////////
/**
- * Computes the cosine inverse of the given value; the returned angle is in the range
- * 0.0 through pi.
+ * @return inverse cosine of `e` in radians, as if computed by `java.lang.Math.acos`
*
* @group math_funcs
* @since 1.4.0
@@ -1322,8 +1321,7 @@ object functions {
def acos(e: Column): Column = withExpr { Acos(e.expr) }
/**
- * Computes the cosine inverse of the given column; the returned angle is in the range
- * 0.0 through pi.
+ * @return inverse cosine of `columnName`, as if computed by `java.lang.Math.acos`
*
* @group math_funcs
* @since 1.4.0
@@ -1331,8 +1329,7 @@ object functions {
def acos(columnName: String): Column = acos(Column(columnName))
/**
- * Computes the sine inverse of the given value; the returned angle is in the range
- * -pi/2 through pi/2.
+ * @return inverse sine of `e` in radians, as if computed by `java.lang.Math.asin`
*
* @group math_funcs
* @since 1.4.0
@@ -1340,8 +1337,7 @@ object functions {
def asin(e: Column): Column = withExpr { Asin(e.expr) }
/**
- * Computes the sine inverse of the given column; the returned angle is in the range
- * -pi/2 through pi/2.
+ * @return inverse sine of `columnName`, as if computed by `java.lang.Math.asin`
*
* @group math_funcs
* @since 1.4.0
@@ -1349,8 +1345,7 @@ object functions {
def asin(columnName: String): Column = asin(Column(columnName))
/**
- * Computes the tangent inverse of the given column; the returned angle is in the range
- * -pi/2 through pi/2
+ * @return inverse tangent of `e`, as if computed by `java.lang.Math.atan`
*
* @group math_funcs
* @since 1.4.0
@@ -1358,8 +1353,7 @@ object functions {
def atan(e: Column): Column = withExpr { Atan(e.expr) }
/**
- * Computes the tangent inverse of the given column; the returned angle is in the range
- * -pi/2 through pi/2
+ * @return inverse tangent of `columnName`, as if computed by `java.lang.Math.atan`
*
* @group math_funcs
* @since 1.4.0
@@ -1367,77 +1361,117 @@ object functions {
def atan(columnName: String): Column = atan(Column(columnName))
/**
- * Returns the angle theta from the conversion of rectangular coordinates (x, y) to
- * polar coordinates (r, theta). Units in radians.
+ * @param y coordinate on y-axis
+ * @param x coordinate on x-axis
+ * @return the <i>theta</i> component of the point
+ * (<i>r</i>, <i>theta</i>)
+ * in polar coordinates that corresponds to the point
+ * (<i>x</i>, <i>y</i>) in Cartesian coordinates,
+ * as if computed by `java.lang.Math.atan2`
*
* @group math_funcs
* @since 1.4.0
*/
- def atan2(l: Column, r: Column): Column = withExpr { Atan2(l.expr, r.expr) }
+ def atan2(y: Column, x: Column): Column = withExpr { Atan2(y.expr, x.expr) }
/**
- * Returns the angle theta from the conversion of rectangular coordinates (x, y) to
- * polar coordinates (r, theta).
+ * @param y coordinate on y-axis
+ * @param xName coordinate on x-axis
+ * @return the <i>theta</i> component of the point
+ * (<i>r</i>, <i>theta</i>)
+ * in polar coordinates that corresponds to the point
+ * (<i>x</i>, <i>y</i>) in Cartesian coordinates,
+ * as if computed by `java.lang.Math.atan2`
*
* @group math_funcs
* @since 1.4.0
*/
- def atan2(l: Column, rightName: String): Column = atan2(l, Column(rightName))
+ def atan2(y: Column, xName: String): Column = atan2(y, Column(xName))
/**
- * Returns the angle theta from the conversion of rectangular coordinates (x, y) to
- * polar coordinates (r, theta).
+ * @param yName coordinate on y-axis
+ * @param x coordinate on x-axis
+ * @return the <i>theta</i> component of the point
+ * (<i>r</i>, <i>theta</i>)
+ * in polar coordinates that corresponds to the point
+ * (<i>x</i>, <i>y</i>) in Cartesian coordinates,
+ * as if computed by `java.lang.Math.atan2`
*
* @group math_funcs
* @since 1.4.0
*/
- def atan2(leftName: String, r: Column): Column = atan2(Column(leftName), r)
+ def atan2(yName: String, x: Column): Column = atan2(Column(yName), x)
/**
- * Returns the angle theta from the conversion of rectangular coordinates (x, y) to
- * polar coordinates (r, theta).
+ * @param yName coordinate on y-axis
+ * @param xName coordinate on x-axis
+ * @return the <i>theta</i> component of the point
+ * (<i>r</i>, <i>theta</i>)
+ * in polar coordinates that corresponds to the point
+ * (<i>x</i>, <i>y</i>) in Cartesian coordinates,
+ * as if computed by `java.lang.Math.atan2`
*
* @group math_funcs
* @since 1.4.0
*/
- def atan2(leftName: String, rightName: String): Column =
- atan2(Column(leftName), Column(rightName))
+ def atan2(yName: String, xName: String): Column =
+ atan2(Column(yName), Column(xName))
/**
- * Returns the angle theta from the conversion of rectangular coordinates (x, y) to
- * polar coordinates (r, theta).
+ * @param y coordinate on y-axis
+ * @param xValue coordinate on x-axis
+ * @return the <i>theta</i> component of the point
+ * (<i>r</i>, <i>theta</i>)
+ * in polar coordinates that corresponds to the point
+ * (<i>x</i>, <i>y</i>) in Cartesian coordinates,
+ * as if computed by `java.lang.Math.atan2`
*
* @group math_funcs
* @since 1.4.0
*/
- def atan2(l: Column, r: Double): Column = atan2(l, lit(r))
+ def atan2(y: Column, xValue: Double): Column = atan2(y, lit(xValue))
/**
- * Returns the angle theta from the conversion of rectangular coordinates (x, y) to
- * polar coordinates (r, theta).
+ * @param yName coordinate on y-axis
+ * @param xValue coordinate on x-axis
+ * @return the <i>theta</i> component of the point
+ * (<i>r</i>, <i>theta</i>)
+ * in polar coordinates that corresponds to the point
+ * (<i>x</i>, <i>y</i>) in Cartesian coordinates,
+ * as if computed by `java.lang.Math.atan2`
*
* @group math_funcs
* @since 1.4.0
*/
- def atan2(leftName: String, r: Double): Column = atan2(Column(leftName), r)
+ def atan2(yName: String, xValue: Double): Column = atan2(Column(yName), xValue)
/**
- * Returns the angle theta from the conversion of rectangular coordinates (x, y) to
- * polar coordinates (r, theta).
+ * @param yValue coordinate on y-axis
+ * @param x coordinate on x-axis
+ * @return the <i>theta</i> component of the point
+ * (<i>r</i>, <i>theta</i>)
+ * in polar coordinates that corresponds to the point
+ * (<i>x</i>, <i>y</i>) in Cartesian coordinates,
+ * as if computed by `java.lang.Math.atan2`
*
* @group math_funcs
* @since 1.4.0
*/
- def atan2(l: Double, r: Column): Column = atan2(lit(l), r)
+ def atan2(yValue: Double, x: Column): Column = atan2(lit(yValue), x)
/**
- * Returns the angle theta from the conversion of rectangular coordinates (x, y) to
- * polar coordinates (r, theta).
+ * @param yValue coordinate on y-axis
+ * @param xName coordinate on x-axis
+ * @return the <i>theta</i> component of the point
+ * (<i>r</i>, <i>theta</i>)
+ * in polar coordinates that corresponds to the point
+ * (<i>x</i>, <i>y</i>) in Cartesian coordinates,
+ * as if computed by `java.lang.Math.atan2`
*
* @group math_funcs
* @since 1.4.0
*/
- def atan2(l: Double, rightName: String): Column = atan2(l, Column(rightName))
+ def atan2(yValue: Double, xName: String): Column = atan2(yValue, Column(xName))
/**
* An expression that returns the string representation of the binary value of the given long
@@ -1500,7 +1534,8 @@ object functions {
}
/**
- * Computes the cosine of the given value. Units in radians.
+ * @param e angle in radians
+ * @return cosine of the angle, as if computed by `java.lang.Math.cos`
*
* @group math_funcs
* @since 1.4.0
@@ -1508,7 +1543,8 @@ object functions {
def cos(e: Column): Column = withExpr { Cos(e.expr) }
/**
- * Computes the cosine of the given column.
+ * @param columnName angle in radians
+ * @return cosine of the angle, as if computed by `java.lang.Math.cos`
*
* @group math_funcs
* @since 1.4.0
@@ -1516,7 +1552,8 @@ object functions {
def cos(columnName: String): Column = cos(Column(columnName))
/**
- * Computes the hyperbolic cosine of the given value.
+ * @param e hyperbolic angle
+ * @return hyperbolic cosine of the angle, as if computed by `java.lang.Math.cosh`
*
* @group math_funcs
* @since 1.4.0
@@ -1524,7 +1561,8 @@ object functions {
def cosh(e: Column): Column = withExpr { Cosh(e.expr) }
/**
- * Computes the hyperbolic cosine of the given column.
+ * @param columnName hyperbolic angle
+ * @return hyperbolic cosine of the angle, as if computed by `java.lang.Math.cosh`
*
* @group math_funcs
* @since 1.4.0
@@ -1967,7 +2005,8 @@ object functions {
def signum(columnName: String): Column = signum(Column(columnName))
/**
- * Computes the sine of the given value. Units in radians.
+ * @param e angle in radians
+ * @return sine of the angle, as if computed by `java.lang.Math.sin`
*
* @group math_funcs
* @since 1.4.0
@@ -1975,7 +2014,8 @@ object functions {
def sin(e: Column): Column = withExpr { Sin(e.expr) }
/**
- * Computes the sine of the given column.
+ * @param columnName angle in radians
+ * @return sine of the angle, as if computed by `java.lang.Math.sin`
*
* @group math_funcs
* @since 1.4.0
@@ -1983,7 +2023,8 @@ object functions {
def sin(columnName: String): Column = sin(Column(columnName))
/**
- * Computes the hyperbolic sine of the given value.
+ * @param e hyperbolic angle
+ * @return hyperbolic sine of the given value, as if computed by `java.lang.Math.sinh`
*
* @group math_funcs
* @since 1.4.0
@@ -1991,7 +2032,8 @@ object functions {
def sinh(e: Column): Column = withExpr { Sinh(e.expr) }
/**
- * Computes the hyperbolic sine of the given column.
+ * @param columnName hyperbolic angle
+ * @return hyperbolic sine of the given value, as if computed by `java.lang.Math.sinh`
*
* @group math_funcs
* @since 1.4.0
@@ -1999,7 +2041,8 @@ object functions {
def sinh(columnName: String): Column = sinh(Column(columnName))
/**
- * Computes the tangent of the given value. Units in radians.
+ * @param e angle in radians
+ * @return tangent of the given value, as if computed by `java.lang.Math.tan`
*
* @group math_funcs
* @since 1.4.0
@@ -2007,7 +2050,8 @@ object functions {
def tan(e: Column): Column = withExpr { Tan(e.expr) }
/**
- * Computes the tangent of the given column.
+ * @param columnName angle in radians
+ * @return tangent of the given value, as if computed by `java.lang.Math.tan`
*
* @group math_funcs
* @since 1.4.0
@@ -2015,7 +2059,8 @@ object functions {
def tan(columnName: String): Column = tan(Column(columnName))
/**
- * Computes the hyperbolic tangent of the given value.
+ * @param e hyperbolic angle
+ * @return hyperbolic tangent of the given value, as if computed by `java.lang.Math.tanh`
*
* @group math_funcs
* @since 1.4.0
@@ -2023,7 +2068,8 @@ object functions {
def tanh(e: Column): Column = withExpr { Tanh(e.expr) }
/**
- * Computes the hyperbolic tangent of the given column.
+ * @param columnName hyperbolic angle
+ * @return hyperbolic tangent of the given value, as if computed by `java.lang.Math.tanh`
*
* @group math_funcs
* @since 1.4.0
@@ -2047,6 +2093,9 @@ object functions {
/**
* Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
*
+ * @param e angle in radians
+ * @return angle in degrees, as if computed by `java.lang.Math.toDegrees`
+ *
* @group math_funcs
* @since 2.1.0
*/
@@ -2055,6 +2104,9 @@ object functions {
/**
* Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
*
+ * @param columnName angle in radians
+ * @return angle in degrees, as if computed by `java.lang.Math.toDegrees`
+ *
* @group math_funcs
* @since 2.1.0
*/
@@ -2077,6 +2129,9 @@ object functions {
/**
* Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
*
+ * @param e angle in degrees
+ * @return angle in radians, as if computed by `java.lang.Math.toRadians`
+ *
* @group math_funcs
* @since 2.1.0
*/
@@ -2085,6 +2140,9 @@ object functions {
/**
* Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
*
+ * @param columnName angle in degrees
+ * @return angle in radians, as if computed by `java.lang.Math.toRadians`
+ *
* @group math_funcs
* @since 2.1.0
*/
@@ -2873,7 +2931,7 @@ object functions {
* or equal to the `windowDuration`. Check
* `org.apache.spark.unsafe.types.CalendarInterval` for valid duration
* identifiers. This duration is likewise absolute, and does not vary
- * according to a calendar.
+ * according to a calendar.
* @param startTime The offset with respect to 1970-01-01 00:00:00 UTC with which to start
* window intervals. For example, in order to have hourly tumbling windows that
* start 15 minutes past the hour, e.g. 12:15-13:15, 13:15-14:15... provide
@@ -2929,7 +2987,7 @@ object functions {
* or equal to the `windowDuration`. Check
* `org.apache.spark.unsafe.types.CalendarInterval` for valid duration
* identifiers. This duration is likewise absolute, and does not vary
- * according to a calendar.
+ * according to a calendar.
*
* @group datetime_funcs
* @since 2.0.0
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org