Math functions: Clarified value ranges and NaN

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased / Draft
 
+### Fixed
+
+- Trigonometric functions: Clarified that NaN is returned outside of their defined input range and defined output ranges where possible.
+
 ## [2.0.0-rc.1] - 2023-05-25
 
 ### Added

arccos.json

@@ -1,7 +1,7 @@
 {
     "id": "arccos",
     "summary": "Inverse cosine",
-    "description": "Computes the arc cosine of `x`. The arc cosine is the inverse function of the cosine so that *`arccos(cos(x)) = x`*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated.",
+    "description": "Computes the arc cosine of `x`. The arc cosine is the inverse function of the cosine so that *`arccos(cos(x)) = x`*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated. `NaN` is returned for values < -1 and > 1.",
     "categories": [
         "math > trigonometric"
     ],
@@ -23,7 +23,8 @@
             "type": [
                 "number",
                 "null"
-            ]
+            ],
+            "minimum": 0
         }
     },
     "examples": [
@@ -41,4 +42,4 @@
             "title": "Inverse cosine explained by Wolfram MathWorld"
         }
     ]
-}
+}

arcosh.json

@@ -1,7 +1,7 @@
 {
     "id": "arcosh",
     "summary": "Inverse hyperbolic cosine",
-    "description": "Computes the inverse hyperbolic cosine of `x`. It is the inverse function of the hyperbolic cosine so that *`arcosh(cosh(x)) = x`*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated.",
+    "description": "Computes the inverse hyperbolic cosine of `x`. It is the inverse function of the hyperbolic cosine so that *`arcosh(cosh(x)) = x`*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated. `NaN` is returned for values < 1.",
     "categories": [
         "math > trigonometric"
     ],
@@ -23,7 +23,8 @@
             "type": [
                 "number",
                 "null"
-            ]
+            ],
+            "minimum": 0
         }
     },
     "examples": [
@@ -41,4 +42,4 @@
             "title": "Inverse hyperbolic cosine explained by Wolfram MathWorld"
         }
     ]
-}
+}

arcsin.json

@@ -1,7 +1,7 @@
 {
     "id": "arcsin",
     "summary": "Inverse sine",
-    "description": "Computes the arc sine of `x`. The arc sine is the inverse function of the sine so that *`arcsin(sin(x)) = x`*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated.",
+    "description": "Computes the arc sine of `x`. The arc sine is the inverse function of the sine so that *`arcsin(sin(x)) = x`*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated. `NaN` is returned for values < -1 and > 1.",
     "categories": [
         "math > trigonometric"
     ],
@@ -41,4 +41,4 @@
             "title": "Inverse sine explained by Wolfram MathWorld"
         }
     ]
-}
+}

artanh.json

@@ -1,7 +1,7 @@
 {
     "id": "artanh",
     "summary": "Inverse hyperbolic tangent",
-    "description": "Computes the inverse hyperbolic tangent of `x`. It is the inverse function of the hyperbolic tangent so that *`artanh(tanh(x)) = x`*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated.",
+    "description": "Computes the inverse hyperbolic tangent of `x`. It is the inverse function of the hyperbolic tangent so that *`artanh(tanh(x)) = x`*.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated. `NaN` is returned for values <= -1 and >= 1.",
     "categories": [
         "math > trigonometric"
     ],
@@ -13,7 +13,9 @@
                 "type": [
                     "number",
                     "null"
-                ]
+                ],
+                "minimumExclusive": -1,
+                "maximumExclusive": 1
             }
         }
     ],
@@ -41,4 +43,4 @@
             "title": "Inverse hyperbolic tangent explained by Wolfram MathWorld"
         }
     ]
-}
+}

cos.json

@@ -23,7 +23,9 @@
             "type": [
                 "number",
                 "null"
-            ]
+            ],
+            "minimum": -1,
+            "maximum": 1
         }
     },
     "examples": [
@@ -41,4 +43,4 @@
             "title": "Cosine explained by Wolfram MathWorld"
         }
     ]
-}
+}

cosh.json

@@ -23,7 +23,8 @@
             "type": [
                 "number",
                 "null"
-            ]
+            ],
+            "minimum": 1
         }
     },
     "examples": [
@@ -41,4 +42,4 @@
             "title": "Hyperbolic cosine explained by Wolfram MathWorld"
         }
     ]
-}
+}

sin.json

@@ -23,7 +23,9 @@
             "type": [
                 "number",
                 "null"
-            ]
+            ],
+            "minimum": -1,
+            "maximum": 1
         }
     },
     "examples": [
@@ -41,4 +43,4 @@
             "title": "Sine explained by Wolfram MathWorld"
         }
     ]
-}
+}

tan.json

@@ -1,7 +1,7 @@
 {
     "id": "tan",
     "summary": "Tangent",
-    "description": "Computes the tangent of `x`. The tangent is defined to be the sine of x divided by the cosine of x.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated.",
+    "description": "Computes the tangent of `x`. The tangent is defined to be the sine of x divided by the cosine of x.\n\nWorks on radians only.\nThe no-data value `null` is passed through and therefore gets propagated. `NaN` is returned for values where the tangent function is not defined.",
     "categories": [
         "math > trigonometric"
     ],
@@ -41,4 +41,4 @@
             "title": "Tangent explained by Wolfram MathWorld"
         }
     ]
-}
+}

tanh.json

@@ -23,7 +23,9 @@
             "type": [
                 "number",
                 "null"
-            ]
+            ],
+            "minimum": -1,
+            "maximum": 1
         }
     },
     "examples": [
@@ -41,4 +43,4 @@
             "title": "Hyperbolic tangent explained by Wolfram MathWorld"
         }
     ]
-}
+}