DOCS-12338: 4.2 Trigonometry Expressions (Aggregation)

Author: ravindk89

source/includes/extracts-agg-operators.yaml

@@ -1,3 +1,58 @@
+ref: agg-operators-trigonometry
+content: |
+
+   .. include:: /includes/intro-aggregation-trigonometry.rst
+
+   .. list-table::
+      :header-rows: 1
+      :widths: 20 80
+
+      * - Name
+        - Description
+
+      * - :expression:`$sin`
+        - Returns the sine of a value that is measured in radians.
+
+      * - :expression:`$cos`
+        - Returns the cosine of a value that is measured in radians.
+
+      * - :expression:`$tan`
+        - Returns the tangent of a value that is measured in radians.
+
+      * - :expression:`$asin`
+        - Returns the inverse sin (arc sine) of a value in radians.
+
+      * - :expression:`$acos`
+        - Returns the inverse cosine (arc cosine) of a value in radians.
+
+      * - :expression:`$atan`
+        - Returns the inverse tangent (arc tangent) of a value in 
+          radians.
+
+      * - :expression:`$atan2`
+        - Returns the inverse tangent (arc tangent) of ``y / x`` in
+          radians, where ``y`` and ``x`` are the first and second 
+          values passed to the expression respectively.
+
+      * - :expression:`$asinh`
+        - Returns the inverse hyperbolic sine (hyperbolic arc sine) of a 
+          value in radians.
+
+      * - :expression:`$acosh`
+        - Returns the inverse hyperbolic cosine (hyperbolic arc cosine)
+          of a value in radians.
+
+      * - :expression:`$atanh`
+        - Returns the inverse hyperbolic tangent (hyperbolic arc
+          tangent) of a value in radians.
+
+      * - :expression:`$degreesToRadians`
+        - Converts a value from degrees to radians.
+
+      * - :expression:`$radiansToDegrees`
+        - Converts a value from radians to degrees.
+
+---
 ref: agg-operators-arithmetic
 content: |
 

source/includes/intro-aggregation-trigonometry.rst

@@ -0,0 +1,4 @@
+Trigonometry expressions perform trigonometric operations on numbers.
+Values that represent angles are always input or output in  radians. Use
+:expression:`$degreesToRadians` and :expression:`$radiansToDegrees` to
+convert between degree and radian measurements.

source/includes/ref-toc-aggregation-operators.yaml

@@ -2,6 +2,16 @@ name: :expression:`$abs`
 description: Returns the absolute value of a number.
 file: /reference/operator/aggregation/abs
 ---
+name: :expression:`$acos`
+file: /reference/operator/aggregation/acos
+description: |
+  Returns the inverse cosine (arc cosine) of a value in radians.
+---
+name: :expression:`$acosh`
+file: /reference/operator/aggregation/acosh
+description: |
+  Returns the inverse hyperbolic cosine (hyperbolic arc cosine) of a value in radians.
+---
 name: :expression:`$add`
 file: /reference/operator/aggregation/add
 description: |
@@ -46,6 +56,33 @@ file: /reference/operator/aggregation/arrayToObject
 description: |
   Converts an array of key value pairs to a document.
 ---
+name: :expression:`$asin`
+file: /reference/operator/aggregation/asin
+description: |
+  Returns the inverse sine (arc sine) of a value in radians.
+---
+name: :expression:`$asinh`
+file: /reference/operator/aggregation/asinh
+description: |
+  Returns the inverse hyperbolic sin (hyperbolic arc sine) of a value in radians.
+---
+name: :expression:`$atan`
+file: /reference/operator/aggregation/atan
+description: |
+  Returns the inverse tangent (arc tangent) of a value in radians.
+---
+name: :expression:`$atan2`
+file: /reference/operator/aggregation/atan2
+description: |
+  Returns the inverse tangent (arc tangent) of ``y / x`` in radians,
+  where ``y`` and ``x`` are the first and second values passed to the
+  expression respectively.
+---
+name: :expression:`$atanh`
+file: /reference/operator/aggregation/atanh
+description: |
+  Returns the inverse hyperbolic tangent (hyperbolic arc tangent) of a value in radians.
+---
 name: :group:`$avg`
 file: /reference/operator/aggregation/avg
 description: |
@@ -91,6 +128,11 @@ file: /reference/operator/aggregation/convert
 description: |
   Converts a value to a specified type.
 ---
+name: :expression:`$cos`
+file: /reference/operator/aggregation/cos
+description: |
+  Returns the cosine of a value that is measured in radians.
+---
 name: :expression:`$dateFromParts`
 file: /reference/operator/aggregation/dateFromParts
 description: |
@@ -129,6 +171,11 @@ description: |
   Returns the day of the year for a date as a number between 1 and 366
   (leap year).
 ---
+name: :expression:`$degreesToRadians`
+file: /reference/operator/aggregation/degreesToRadians
+description: |
+  Converts a value from degrees to radians.
+---
 name: :expression:`$divide`
 file: /reference/operator/aggregation/divide
 description: |
@@ -392,6 +439,11 @@ description: |
 
   Available in :pipeline:`$group` stage only.
 ---
+name: :expression:`$radiansToDegrees`
+file: /reference/operator/aggregation/radiansToDegrees
+description: |
+  Converts a value from radians to degrees.
+---
 name: :expression:`$range`
 description: |
    Outputs an array containing a sequence of integers according to
@@ -460,6 +512,11 @@ description: |
   Returns the number of elements in the array. Accepts a single
   expression as argument.
 ---
+name: :expression:`$sin`
+file: /reference/operator/aggregation/sin
+description: |
+  Returns the sine of a value that is measured in radians.
+---
 name: :expression:`$slice`
 description: |
   Returns a subset of an array.
@@ -561,6 +618,11 @@ description: |
    expression and breaks out of the control flow.
 
 ---
+name: :expression:`$tan`
+file: /reference/operator/aggregation/tan
+description: |
+  Returns the tangent of a value that is measured in radians.
+---
 name: :expression:`$toBool`
 file: /reference/operator/aggregation/toBool
 description: |

source/meta/aggregation-quick-reference.txt

@@ -185,6 +185,13 @@ Text Expression Operator
 
 .. include:: /includes/extracts/agg-operators-text.rst
 
+.. _agg-quick-ref-operator-trigonometry:
+
+Trigonometry Expression Operators
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/agg-operators-trigonometry.rst
+
 Type Expression Operators
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 

source/reference/operator/aggregation.txt

@@ -34,7 +34,6 @@ stages </reference/operator/aggregation-pipeline>`.
 
 .. include:: /includes/intro-aggregation-operator-expressions.rst
 
-
 Arithmetic Expression Operators
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -92,6 +91,11 @@ Text Expression Operator
 
 .. include:: /includes/extracts/agg-operators-text.rst
 
+Trigonometry Expression Operators
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/agg-operators-trigonometry.rst
+
 Type Expression Operators
 ~~~~~~~~~~~~~~~~~~~~~~~~~