forked from Open-EO/openeo-processes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
subtract.json
80 lines (80 loc) · 2.63 KB
/
subtract.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{
"id": "subtract",
"summary": "Subtraction of a sequence of numbers",
"description": "Takes the first element of a sequential array of numbers and subtracts all other elements from it.\n\nThe computations should follow [IEEE Standard 754](https://ieeexplore.ieee.org/document/4610935) whenever the processing environment supports it. Otherwise an exception must the thrown for incomputable results.\n\nBy default no-data values are ignored. Setting `ignore_nodata` to `false` considers no-data values so that `null` is returned if any element is such a value.",
"categories": [
"math",
"reducer"
],
"parameter_order": ["data", "ignore_nodata"],
"parameters": {
"data": {
"description": "An array of numbers with at least two elements.",
"schema": {
"type": "array",
"items": {
"type": [
"number",
"null"
]
},
"minItems": 2
},
"required": true
},
"ignore_nodata": {
"description": "Indicates whether no-data values are ignored or not. Ignores them by default. Setting this flag to `false` considers no-data values so that `null` is returned if any value is such a value.",
"schema": {
"type": "boolean",
"default": true
}
}
},
"returns": {
"description": "The computed result of the sequence of numbers.",
"schema": {
"type": [
"number",
"null"
]
}
},
"exceptions": {
"SubtrahendMissing": {
"message": "Subtraction requires at least two numbers (a minuend and one or more subtrahends)."
}
},
"examples": [
{
"arguments": {
"data": [5,10]
},
"returns": -5
},
{
"arguments": {
"data": [-2,4,-2]
},
"returns": -4
},
{
"arguments": {
"data": [1,null],
"ignore_nodata": false
},
"returns": null
}
],
"links": [
{
"rel": "about",
"href": "http://mathworld.wolfram.com/Subtraction.html",
"title": "Subtraction explained by Wolfram MathWorld"
},
{
"rel": "about",
"href": "https://ieeexplore.ieee.org/document/4610935",
"title": "IEEE Standard 754-2008 for Floating-Point Arithmetic"
}
]
}