Skip to content

Commit 8f3b1e2

Browse files
committed
docs: add REPL help
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 7ca0425 commit 8f3b1e2

File tree

1 file changed

+55
-0
lines changed
  • lib/node_modules/@stdlib/ndarray/base/every/docs

1 file changed

+55
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
2+
{{alias}}( arrays )
3+
Tests whether every element in an ndarray is truthy.
4+
5+
A provided "ndarray" should be an `object` with the following properties:
6+
7+
- dtype: data type.
8+
- data: data buffer.
9+
- shape: dimensions.
10+
- strides: stride lengths.
11+
- offset: index offset.
12+
- order: specifies whether an ndarray is row-major (C-style) or column-major
13+
(Fortran-style).
14+
15+
Parameters
16+
----------
17+
arrays: ArrayLikeObject<ndarray>
18+
Array-like object containing an input ndarray.
19+
20+
Returns
21+
-------
22+
out: boolean
23+
Boolean indicating whether every element in an ndarray is truthy.
24+
25+
Examples
26+
--------
27+
// Define ndarray data and meta data...
28+
> var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 1.0 ] );
29+
> var dtype = 'float64';
30+
> var shape = [ 2, 2 ];
31+
> var sx = [ 2, 1 ];
32+
> var ox = 0;
33+
> var order = 'row-major';
34+
35+
// Using an ndarray...
36+
> var x = {{alias:@stdlib/ndarray/ctor}}( dtype, xbuf, shape, sx, ox, order );
37+
> {{alias}}( [ x ] )
38+
true
39+
40+
// Using a minimal ndarray-like object...
41+
> xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 0.0 ] );
42+
> x = {
43+
... 'dtype': dtype,
44+
... 'data': xbuf,
45+
... 'shape': shape,
46+
... 'strides': sx,
47+
... 'offset': ox,
48+
... 'order': order
49+
... };
50+
> {{alias}}( [ x ] )
51+
false
52+
53+
See Also
54+
--------
55+

0 commit comments

Comments
 (0)