is_nan: Return false instead of true for non-numerical data types (#551)

* `is_nan`: Return `false` instead of `true` for non-numerical data types. #486

* Update is_nan.json

Co-authored-by: Stefaan Lippens <[email protected]>

* Fix tests and examples

---------

Co-authored-by: Stefaan Lippens <[email protected]>

Author: m-mohr

CHANGELOG.md

@@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added a uniqueness contraint to various array-typed parameters (e.g. lists of dimension names or labels)
 - `apply_polygon`: Renamed `polygons` parameter to `geometries` for better alignment with other geometry handling processes. [#511](https://github.com/Open-EO/openeo-processes/issues/511)
 - `clip`: Throw an exception if min > max [#472](https://github.com/Open-EO/openeo-processes/issues/472)
+- `is_nan`: Return `false` instead of `true` for non-numerical data types. [#486](https://github.com/Open-EO/openeo-processes/issues/486)
 - `save_results`: Returns the STAC resource instead of boolean `true` [API#376](https://github.com/Open-EO/openeo-api/issues/376)
 
 ### Fixed

is_nan.json

@@ -1,56 +1,36 @@
-{
-    "id": "is_nan",
-    "summary": "Value is not a number",
-    "description": "Checks whether the specified value `x` is *not* a number. Numbers are all integers and floating-point numbers, except for the special value `NaN` as defined by the [IEEE Standard 754](https://ieeexplore.ieee.org/document/4610935).",
-    "categories": [
-        "comparison",
-        "math > constants"
-    ],
-    "parameters": [
-        {
-            "name": "x",
-            "description": "The data to check.",
-            "schema": {
-                "description": "Any data type is allowed."
-            }
-        }
-    ],
-    "returns": {
-        "description": "Returns `true` for `NaN` and all non-numeric data types, otherwise returns `false`.",
-        "schema": {
-            "type": "boolean"
-        }
-    },
-    "examples": [
-        {
-            "arguments": {
-                "x": 1
-            },
-            "returns": false
-        },
-        {
-            "arguments": {
-                "x": "Test"
-            },
-            "returns": true
-        },
-        {
-            "arguments": {
-                "x": null
-            },
-            "returns": true
-        }
-    ],
-    "links": [
-        {
-            "rel": "about",
-            "href": "https://ieeexplore.ieee.org/document/4610935",
-            "title": "IEEE Standard 754-2008 for Floating-Point Arithmetic"
-        },
-        {
-            "rel": "about",
-            "href": "http://mathworld.wolfram.com/NaN.html",
-            "title": "NaN explained by Wolfram MathWorld"
-        }
-    ]
-}
+{
+    "id": "is_nan",
+    "summary": "Value is not a number",
+    "description": "Checks whether the specified value `x` carries the special value `NaN` (not a number) as defined by the [IEEE Standard 754](https://ieeexplore.ieee.org/document/4610935), in which case it returns `true`. Returns `false` otherwise.",
+    "categories": [
+        "comparison",
+        "math > constants"
+    ],
+    "parameters": [
+        {
+            "name": "x",
+            "description": "The data to check.",
+            "schema": {
+                "description": "Any data type is allowed."
+            }
+        }
+    ],
+    "returns": {
+        "description": "Returns `true` for `NaN` and `false` otherwise.",
+        "schema": {
+            "type": "boolean"
+        }
+    },
+    "links": [
+        {
+            "rel": "about",
+            "href": "https://ieeexplore.ieee.org/document/4610935",
+            "title": "IEEE Standard 754-2008 for Floating-Point Arithmetic"
+        },
+        {
+            "rel": "about",
+            "href": "http://mathworld.wolfram.com/NaN.html",
+            "title": "NaN explained by Wolfram MathWorld"
+        }
+    ]
+}

tests/is_nan.json5

@@ -36,55 +36,55 @@
       "arguments": {
         "x": true
       },
-      "returns": true
+      "returns": false
     },
     {
       "arguments": {
         "x": false
       },
-      "returns": true
+      "returns": false
     },
     {
       "arguments": {
         "x": [NaN]
       },
-      "returns": true
+      "returns": false
     },
     {
       "arguments": {
         "x": []
       },
-      "returns": true
+      "returns": false
     },
     {
       "arguments": {
         "x": {}
       },
-      "returns": true
+      "returns": false
     },
     {
       "arguments": {
         "x": {"nan": NaN}
       },
-      "returns": true
+      "returns": false
     },
     {
       "arguments": {
         "x": "NaN"
       },
-      "returns": true
+      "returns": false
     },
     {
       "arguments": {
         "x": "nan"
       },
-      "returns": true
+      "returns": false
     },
     {
       "arguments": {
         "x": {"type": "nodata"}
       },
-      "returns": true
+      "returns": false
     }
   ]
 }