Skip to content

[SPARK-23329][SQL] Fix documentation of trigonometric functions #20618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
misutoth wants to merge 10 commits into from
Closed

[SPARK-23329][SQL] Fix documentation of trigonometric functions #20618

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0a0c4ae
[SPARK-23329][SQL] Fix documentation of trigonometric functions
misutoth Feb 13, 2018
168d7b3
[SPARK-23329][SQL] Removed unnecessary aligning, reworded inverse fun…
misutoth Feb 19, 2018
2586b0f
[SPARK-23329][SQL] Fixed formatting of long lines, reverted line brea…
misutoth Feb 19, 2018
8550a27
[SPARK-23329][SQL] Make usage text consistent with other docs, revert…
misutoth Feb 20, 2018
40da998
[SPARK-23329][SQL] Formatting finetunings
misutoth Feb 20, 2018
0e4e15a
[SPARK-23329][SQL] Fix documentation of functions.R, functions.scala,…
misutoth Feb 21, 2018
fcf1338
[SPARK-23329][SQL] Fixed line length
misutoth Feb 28, 2018
2ea1f18
[SPARK-23329][SQL] Fixed line length of functions.py
misutoth Feb 28, 2018
10afda5
[SPARK-23329][SQL] Fixed python style problem
misutoth Mar 1, 2018
627e204
[SPARK-23329][SQL] Formatting fixes, changed scaladoc references
misutoth Mar 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[SPARK-23329][SQL] Removed unnecessary aligning, reworded inverse fun… 
…ctions
  • Loading branch information
@misutoth
misutoth committed Feb 19, 2018
commit 168d7b3715c8ad19b68c9542ffdb90bcb126c312
150 changes: 73 additions & 77 deletions sql/core/src/main/scala/org/apache/spark/sql/functions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1313,78 +1313,75 @@ object functions {
//////////////////////////////////////////////////////////////////////////////////////////////

/**
* @return angle in radians whose cosine is `e`, as if computed by [[java.lang.Math#acos]]
* @return inverse cosine of `e` in radians, as if computed by [[java.lang.Math#acos]]
*
* @group math_funcs
* @since 1.4.0
*/
def acos(e: Column): Column = withExpr { Acos(e.expr) }

// scalastyle:off line.size.limit
/**
* @return angle in radians whose cosine is `columnName` as if computed by [[java.lang.Math#acos]]
* @return inverse cosine of `columnName`, as if computed by [[java.lang.Math#acos]]
*
* @group math_funcs
* @since 1.4.0
*/
def acos(columnName: String): Column = acos(Column(columnName))

/**
* @return angle in radians whose sine is `e`, as if computed by [[java.lang.Math#asin]]
* @return inverse sine of `e` in radians, as if computed by [[java.lang.Math#asin]]
*
* @group math_funcs
* @since 1.4.0
*/
def asin(e: Column): Column = withExpr { Asin(e.expr) }

/**
* @return angle in radians whose sine is `columnName`, as if computed by [[java.lang.Math#asin]]
* @return inverse sine of `columnName`, as if computed by [[java.lang.Math#asin]]
*
* @group math_funcs
* @since 1.4.0
*/
def asin(columnName: String): Column = asin(Column(columnName))

/**
* @return angle in radians whose tangent is `e`, as if computed by [[java.lang.Math#atan]]
* @return inverse tangent of `e`, as if computed by [[java.lang.Math#atan]]
*
* @group math_funcs
* @since 1.4.0
*/
def atan(e: Column): Column = withExpr { Atan(e.expr) }

// scalastyle:off line.size.limit
/**
* @return angle in radians whose tangent is `columnName`, as if computed by [[java.lang.Math#atan]]
* @return inverse tangent of `columnName`, as if computed by [[java.lang.Math#atan]]
*
* @group math_funcs
* @since 1.4.0
*/
def atan(columnName: String): Column = atan(Column(columnName))

/**
*
* @param y coordinate on y-axis
* @param x coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
def atan2(y: Column, x: Column): Column = withExpr { Atan2(y.expr, x.expr) }

/**
* @param y coordinate on y-axis
* @param y coordinate on y-axis
* @param xName coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -1393,12 +1390,12 @@ object functions {

/**
* @param yName coordinate on y-axis
* @param x coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
* @param x coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -1408,11 +1405,11 @@ object functions {
/**
* @param yName coordinate on y-axis
* @param xName coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -1421,27 +1418,27 @@ object functions {
atan2(Column(yName), Column(xName))

/**
* @param y coordinate on y-axis
* @param y coordinate on y-axis
* @param xValue coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
def atan2(y: Column, xValue: Double): Column = atan2(y, lit(xValue))

/**
* @param yName coordinate on y-axis
* @param yName coordinate on y-axis
* @param xValue coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -1450,12 +1447,12 @@ object functions {

/**
* @param yValue coordinate on y-axis
* @param x coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
* @param x coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -1464,12 +1461,12 @@ object functions {

/**
* @param yValue coordinate on y-axis
* @param xName coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
* @param xName coordinate on x-axis
* @return the <i>theta</i> component of the point
* (<i>r</i>,&nbsp;<i>theta</i>)
Copy link
Member

@HyukjinKwon HyukjinKwon Mar 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit &nbsp; -> . Seems broken in Javadoc.

Copy link
Contributor Author

@misutoth misutoth Mar 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I have removed the non breaking spaces.

* in polar coordinates that corresponds to the point
* (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
* as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
Expand Down Expand Up @@ -1538,7 +1535,7 @@ object functions {

/**
* @param e angle in radians
* @return cosine of the angle, as if computed by [[java.lang.Math#cos]]
* @return cosine of the angle, as if computed by [[java.lang.Math#cos]]
Copy link
Member

@HyukjinKwon HyukjinKwon Mar 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems this link is broken in Scaladoc. Let's just use `java.lang.Math.cos` in this file.

Copy link
Contributor Author

@misutoth misutoth Mar 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced all of them as suggested.

*
* @group math_funcs
* @since 1.4.0
Expand All @@ -1547,7 +1544,7 @@ object functions {

/**
* @param columnName angle in radians
* @return cosine of the angle, as if computed by [[java.lang.Math#cos]]
* @return cosine of the angle, as if computed by [[java.lang.Math#cos]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -1556,7 +1553,7 @@ object functions {

/**
* @param e angle in radians
* @return hyperbolic cosine of the angle, as if computed by [[java.lang.Math#cosh]]
* @return hyperbolic cosine of the angle, as if computed by [[java.lang.Math#cosh]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -1565,7 +1562,7 @@ object functions {

/**
* @param columnName angle in radians
* @return hyperbolic cosine of the angle, as if computed by [[java.lang.Math#cosh]]
* @return hyperbolic cosine of the angle, as if computed by [[java.lang.Math#cosh]]
*
* @group math_funcs
* @since 1.4.0
Expand Down Expand Up @@ -2009,7 +2006,7 @@ object functions {

/**
* @param e angle in radians
* @return sine of the angle, as if computed by [[java.lang.Math#sin]]
* @return sine of the angle, as if computed by [[java.lang.Math#sin]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -2018,7 +2015,7 @@ object functions {

/**
* @param columnName angle in radians
* @return sine of the angle, as if computed by [[java.lang.Math#sin]]
* @return sine of the angle, as if computed by [[java.lang.Math#sin]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -2027,7 +2024,7 @@ object functions {

/**
* @param e hyperbolic angle
* @return hyperbolic sine of the given value, as if computed by [[java.lang.Math#sinh]]
* @return hyperbolic sine of the given value, as if computed by [[java.lang.Math#sinh]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -2036,7 +2033,7 @@ object functions {

/**
* @param columnName hyperbolic angle
* @return hyperbolic sine of the given value, as if computed by [[java.lang.Math#sinh]]
* @return hyperbolic sine of the given value, as if computed by [[java.lang.Math#sinh]]
*
* @group math_funcs
* @since 1.4.0
Expand All @@ -2045,15 +2042,15 @@ object functions {

/**
* @param e angle in radians
* @return tangent of the given value, as if computed by [[java.lang.Math#tan]]
* @return tangent of the given value, as if computed by [[java.lang.Math#tan]]
*
* @group math_funcs
* @since 1.4.0
*/
def tan(e: Column): Column = withExpr { Tan(e.expr) }

/**
* @param columnName angle in radians
* @param columnName angle in radians
* @return tangent of the given value, as if computed by [[java.lang.Math#tan]]
*
* @group math_funcs
Expand All @@ -2063,17 +2060,16 @@ object functions {

/**
* @param e hyperbolic angle
* @return hyperbolic tangent of the given value, as if computed by [[java.lang.Math#tanh]]
* @return hyperbolic tangent of the given value, as if computed by [[java.lang.Math#tanh]]
*
* @group math_funcs
* @since 1.4.0
*/
def tanh(e: Column): Column = withExpr { Tanh(e.expr) }

/**
* @param columnName hyperbolic angle
* @return hyperbolic tangent of the given value,
* as if computed by [[java.lang.Math#tanh]]
* @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
Expand All @@ -2097,8 +2093,8 @@ 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]]
* @param e angle in radians
* @return angle in degrees, as if computed by [[java.lang.Math#toDegrees]]
*
* @group math_funcs
* @since 2.1.0
Expand All @@ -2108,8 +2104,8 @@ 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]]
* @param columnName angle in radians
* @return angle in degrees, as if computed by [[java.lang.Math#toDegrees]]
*
* @group math_funcs
* @since 2.1.0
Expand All @@ -2133,8 +2129,8 @@ 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]]
* @param e angle in degrees
* @return angle in radians, as if computed by [[java.lang.Math#toRadians]]
*
* @group math_funcs
* @since 2.1.0
Expand All @@ -2144,8 +2140,8 @@ 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]]
* @param columnName angle in degrees
* @return angle in radians, as if computed by [[java.lang.Math#toRadians]]
*
* @group math_funcs
* @since 2.1.0
Expand Down