forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrepl.txt
More file actions
85 lines (66 loc) · 2.46 KB
/
repl.txt
File metadata and controls
85 lines (66 loc) · 2.46 KB
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
81
82
83
84
{{alias}}( x, n[, options] )
Tests whether at least `n` elements along one or more ndarray dimensions are
truthy.
Parameters
----------
x: ndarray
Input ndarray.
n: ndarray|integer
Number of elements which must be truthy. Must be broadcast compatible
with the non-reduced dimensions of input ndarray. Must have an integer
data type.
options: Object (optional)
Function options.
options.dims: Array<integer> (optional)
List of dimensions over which to perform a reduction. If not provided,
the function performs a reduction over all elements in a provided input
ndarray.
options.keepdims: boolean (optional)
Boolean indicating whether the reduced dimensions should be included in
the returned ndarray as singleton dimensions. Default: false.
Returns
-------
out: ndarray
Output ndarray. When performing a reduction over all elements, the
function returns a zero-dimensional ndarray containing the result.
Examples
--------
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 0 ], [ 3, 4 ] ] );
> var y = {{alias}}( x, 3 )
<ndarray>[ true ]
> y = {{alias}}( x, 3, { 'keepdims': true } )
<ndarray>[ [ true ] ]
{{alias}}.assign( x, n, y[, options] )
Tests whether at least `n` elements along one or more ndarray dimensions are
truthy and assigns the results to a provided output ndarray.
Parameters
----------
x: ndarray
Input ndarray.
n: ndarray|integer
Number of elements which must be truthy. Must be broadcast compatible
with the non-reduced dimensions of input ndarray. Must have an integer
data type.
y: ndarray
Output ndarray. The output shape must match the shape of the non-reduced
dimensions of the input ndarray.
options: Object (optional)
Function options.
options.dims: Array<integer> (optional)
List of dimensions over which to perform a reduction. If not provided,
the function performs a reduction over all elements in a provided input
ndarray.
Returns
-------
y: ndarray
Output ndarray.
Examples
--------
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 0 ], [ 3, 4 ] ] );
> var y = {{alias:@stdlib/ndarray/from-scalar}}( false );
> var out = {{alias}}.assign( x, 3, y )
<ndarray>[ true ]
> var bool = ( out === y )
true
See Also
--------