Skip to content

Commit b134073

Browse files
authored
Specify input dtypes for the statistical functions (#234)
Functions like mean() that perform divisions require floating-point inputs. All other functions require numeric inputs.
1 parent 8232c5f commit b134073

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

spec/API_specification/statistical_functions.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Calculates the maximum value of the input array `x`.
2424

2525
- **x**: _<array>_
2626

27-
- input array.
27+
- input array. Should have a numeric data type.
2828

2929
- **axis**: _Optional\[ Union\[ int, Tuple\[ int, ... ] ] ]_
3030

@@ -49,7 +49,7 @@ Calculates the arithmetic mean of the input array `x`.
4949

5050
- **x**: _<array>_
5151

52-
- input array.
52+
- input array. Should have a floating-point data type.
5353

5454
- **axis**: _Optional\[ Union\[ int, Tuple\[ int, ... ] ] ]_
5555

@@ -74,7 +74,7 @@ Calculates the minimum value of the input array `x`.
7474

7575
- **x**: _<array>_
7676

77-
- input array.
77+
- input array. Should have a numeric data type.
7878

7979
- **axis**: _Optional\[ Union\[ int, Tuple\[ int, ... ] ] ]_
8080

@@ -99,7 +99,7 @@ Calculates the product of input array `x` elements.
9999

100100
- **x**: _<array>_
101101

102-
- input array.
102+
- input array. Should have a numeric data type.
103103

104104
- **axis**: _Optional\[ Union\[ int, Tuple\[ int, ... ] ] ]_
105105

@@ -124,7 +124,7 @@ Calculates the standard deviation of the input array `x`.
124124

125125
- **x**: _<array>_
126126

127-
- input array.
127+
- input array. Should have a floating-point data type.
128128

129129
- **axis**: _Optional\[ Union\[ int, Tuple\[ int, ... ] ] ]_
130130

@@ -153,7 +153,7 @@ Calculates the sum of the input array `x`.
153153

154154
- **x**: _<array>_
155155

156-
- input array.
156+
- input array. Should have a numeric data type.
157157

158158
- **axis**: _Optional\[ Union\[ int, Tuple\[ int, ... ] ] ]_
159159

@@ -178,7 +178,7 @@ Calculates the variance of the input array `x`.
178178

179179
- **x**: _<array>_
180180

181-
- input array.
181+
- input array. Should have a floating-point data type.
182182

183183
- **axis**: _Optional\[ Union\[ int, Tuple\[ int, ... ] ] ]_
184184

0 commit comments

Comments
 (0)