You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ext/sum/README.md
+8-40Lines changed: 8 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,10 +40,7 @@ var array = require( '@stdlib/ndarray/array' );
40
40
var x =array( [ -1.0, 2.0, -3.0 ] );
41
41
42
42
var y =sum( x );
43
-
// returns <ndarray>
44
-
45
-
var v =y.get();
46
-
// returns -2.0
43
+
// returns <ndarray>[ -2.0 ]
47
44
```
48
45
49
46
The function has the following parameters:
@@ -60,82 +57,56 @@ The function accepts the following options:
60
57
By default, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform a reduction over specific dimensions, provide a `dims` option.
61
58
62
59
```javascript
63
-
var ndarray2array =require( '@stdlib/ndarray/to-array' );
64
60
var array =require( '@stdlib/ndarray/array' );
65
61
66
62
var x =array( [ -1.0, 2.0, -3.0, 4.0 ], {
67
63
'shape': [ 2, 2 ],
68
64
'order':'row-major'
69
65
});
70
66
71
-
var v =ndarray2array( x );
72
-
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
73
-
74
67
var y =sum( x, {
75
68
'dims': [ 0 ]
76
69
});
77
-
// returns <ndarray>
78
-
79
-
v =ndarray2array( y );
80
-
// returns [ -4.0, 6.0 ]
70
+
// returns <ndarray>[ -4.0, 6.0 ]
81
71
82
72
y =sum( x, {
83
73
'dims': [ 1 ]
84
74
});
85
-
// returns <ndarray>
86
-
87
-
v =ndarray2array( y );
88
-
// returns [ 1.0, 1.0 ]
75
+
// returns <ndarray>[ 1.0, 1.0 ]
89
76
90
77
y =sum( x, {
91
78
'dims': [ 0, 1 ]
92
79
});
93
-
// returns <ndarray>
94
-
95
-
v =y.get();
96
-
// returns 2.0
80
+
// returns <ndarray>[ 2.0 ]
97
81
```
98
82
99
83
By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
100
84
101
85
```javascript
102
-
var ndarray2array =require( '@stdlib/ndarray/to-array' );
103
86
var array =require( '@stdlib/ndarray/array' );
104
87
105
88
var x =array( [ -1.0, 2.0, -3.0, 4.0 ], {
106
89
'shape': [ 2, 2 ],
107
90
'order':'row-major'
108
91
});
109
92
110
-
var v =ndarray2array( x );
111
-
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
112
-
113
93
var y =sum( x, {
114
94
'dims': [ 0 ],
115
95
'keepdims':true
116
96
});
117
-
// returns <ndarray>
118
-
119
-
v =ndarray2array( y );
120
-
// returns [ [ -4.0, 6.0 ] ]
97
+
// returns <ndarray>[ [ -4.0, 6.0 ] ]
121
98
122
99
y =sum( x, {
123
100
'dims': [ 1 ],
124
101
'keepdims':true
125
102
});
126
-
// returns <ndarray>
127
-
128
-
v =ndarray2array( y );
129
-
// returns [ [ 1.0 ], [ 1.0 ] ]
103
+
// returns <ndarray>[ [ 1.0 ], [ 1.0 ] ]
130
104
131
105
y =sum( x, {
132
106
'dims': [ 0, 1 ],
133
107
'keepdims':true
134
108
});
135
-
// returns <ndarray>
136
-
137
-
v =ndarray2array( y );
138
-
// returns [ [ 2.0 ] ]
109
+
// returns <ndarray>[ [ 2.0 ] ]
139
110
```
140
111
141
112
By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option.
@@ -169,10 +140,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] );
Copy file name to clipboardExpand all lines: ext/sum/docs/types/index.d.ts
+4-16Lines changed: 4 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -75,10 +75,7 @@ interface Unary {
75
75
* var x = array( [ -1.0, 2.0, -3.0 ] );
76
76
*
77
77
* var y = sum( x );
78
-
* // returns <ndarray>
79
-
*
80
-
* var v = y.get();
81
-
* // returns -2.0
78
+
* // returns <ndarray>[ -2.0 ]
82
79
*/
83
80
<T=unknown,U=unknown>(x: InputArray<T>,options?: Options): OutputArray<U>;// NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.
0 commit comments