Skip to content

Commit 78bcb59

Browse files
kgrytekgryte
committed
feat: add ndarray/base/ones 
1 parent 5173151 commit 78bcb59

22 files changed

Lines changed: 2692 additions & 0 deletions

‎lib/node_modules/@stdlib/ndarray/base/ones/README.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2026 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# ones
22+
23+
> Create a ones-filled [ndarray][@stdlib/ndarray/base/ctor] having a specified shape and [data type][@stdlib/ndarray/dtypes].
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var ones = require( '@stdlib/ndarray/base/ones' );
41+
```
42+
43+
#### ones( dtype, shape, order )
44+
45+
Creates a ones-filled [ndarray][@stdlib/ndarray/base/ctor] having a specified shape and numeric [data type][@stdlib/ndarray/dtypes].
46+
47+
```javascript
48+
var getShape = require( '@stdlib/ndarray/shape' );
49+
var getDType = require( '@stdlib/ndarray/dtype' );
50+
51+
var arr = ones( 'float64', [ 2, 2 ], 'row-major' );
52+
// returns <ndarray>[ [ 1.0, 1.0 ], [ 1.0, 1.0 ] ]
53+
54+
var sh = getShape( arr );
55+
// returns [ 2, 2 ]
56+
57+
var dt = String( getDType( arr ) );
58+
// returns 'float64'
59+
```
60+
61+
The function accepts the following arguments:
62+
63+
- **dtype**: underlying [data type][@stdlib/ndarray/dtypes]. Must be a numeric or "generic" [data type][@stdlib/ndarray/dtypes].
64+
- **shape**: array shape.
65+
- **order**: specifies whether an [ndarray][@stdlib/ndarray/base/ctor] is `'row-major'` (C-style) or `'column-major'` (Fortran-style).
66+
67+
</section>
68+
69+
<!-- /.usage -->
70+
71+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
72+
73+
<section class="notes">
74+
75+
</section>
76+
77+
<!-- /.notes -->
78+
79+
<!-- Package usage examples. -->
80+
81+
<section class="examples">
82+
83+
## Examples
84+
85+
<!-- eslint no-undef: "error" -->
86+
87+
```javascript
88+
var dtypes = require( '@stdlib/ndarray/dtypes' );
89+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
90+
var ones = require( '@stdlib/ndarray/base/ones' );
91+
92+
// Get a list of data types:
93+
var dt = dtypes( 'integer_and_generic' );
94+
95+
// Generate ones-filled arrays...
96+
var arr;
97+
var i;
98+
for ( i = 0; i < dt.length; i++ ) {
99+
arr = ones( dt[ i ], [ 2, 2 ], 'row-major' );
100+
console.log( ndarray2array( arr ) );
101+
}
102+
```
103+
104+
</section>
105+
106+
<!-- /.examples -->
107+
108+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
109+
110+
<section class="references">
111+
112+
</section>
113+
114+
<!-- /.references -->
115+
116+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
117+
118+
<section class="related">
119+
120+
</section>
121+
122+
<!-- /.related -->
123+
124+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
125+
126+
<section class="links">
127+
128+
[@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ctor
129+
130+
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
131+
132+
</section>
133+
134+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/base/ones/benchmark/benchmark.js‎

Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
25+
var format = require( '@stdlib/string/format' );
26+
var pkg = require( './../package.json' ).name;
27+
var ones = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( format( '%s:dtype=float64', pkg ), function benchmark( b ) {
33+
var arr;
34+
var i;
35+
b.tic();
36+
for ( i = 0; i < b.iterations; i++ ) {
37+
arr = ones( 'float64', [ 0 ], 'row-major' );
38+
if ( arr.length !== 0 ) {
39+
b.fail( 'should have length 0' );
40+
}
41+
}
42+
b.toc();
43+
if ( !isndarrayLike( arr ) ) {
44+
b.fail( 'should return an ndarray' );
45+
}
46+
b.pass( 'benchmark finished' );
47+
b.end();
48+
});
49+
50+
bench( format( '%s:dtype=float32', pkg ), function benchmark( b ) {
51+
var arr;
52+
var i;
53+
b.tic();
54+
for ( i = 0; i < b.iterations; i++ ) {
55+
arr = ones( 'float32', [ 0 ], 'row-major' );
56+
if ( arr.length !== 0 ) {
57+
b.fail( 'should have length 0' );
58+
}
59+
}
60+
b.toc();
61+
if ( !isndarrayLike( arr ) ) {
62+
b.fail( 'should return an ndarray' );
63+
}
64+
b.pass( 'benchmark finished' );
65+
b.end();
66+
});
67+
68+
bench( format( '%s:dtype=complex128', pkg ), function benchmark( b ) {
69+
var arr;
70+
var i;
71+
b.tic();
72+
for ( i = 0; i < b.iterations; i++ ) {
73+
arr = ones( 'complex128', [ 0 ], 'row-major' );
74+
if ( arr.length !== 0 ) {
75+
b.fail( 'should have length 0' );
76+
}
77+
}
78+
b.toc();
79+
if ( !isndarrayLike( arr ) ) {
80+
b.fail( 'should return an ndarray' );
81+
}
82+
b.pass( 'benchmark finished' );
83+
b.end();
84+
});
85+
86+
bench( format( '%s:dtype=complex64', pkg ), function benchmark( b ) {
87+
var arr;
88+
var i;
89+
b.tic();
90+
for ( i = 0; i < b.iterations; i++ ) {
91+
arr = ones( 'complex64', [ 0 ], 'row-major' );
92+
if ( arr.length !== 0 ) {
93+
b.fail( 'should have length 0' );
94+
}
95+
}
96+
b.toc();
97+
if ( !isndarrayLike( arr ) ) {
98+
b.fail( 'should return an ndarray' );
99+
}
100+
b.pass( 'benchmark finished' );
101+
b.end();
102+
});
103+
104+
bench( format( '%s:dtype=int32', pkg ), function benchmark( b ) {
105+
var arr;
106+
var i;
107+
b.tic();
108+
for ( i = 0; i < b.iterations; i++ ) {
109+
arr = ones( 'int32', [ 0 ], 'row-major' );
110+
if ( arr.length !== 0 ) {
111+
b.fail( 'should have length 0' );
112+
}
113+
}
114+
b.toc();
115+
if ( !isndarrayLike( arr ) ) {
116+
b.fail( 'should return an ndarray' );
117+
}
118+
b.pass( 'benchmark finished' );
119+
b.end();
120+
});
121+
122+
bench( format( '%s:dtype=uint32', pkg ), function benchmark( b ) {
123+
var arr;
124+
var i;
125+
b.tic();
126+
for ( i = 0; i < b.iterations; i++ ) {
127+
arr = ones( 'uint32', [ 0 ], 'row-major' );
128+
if ( arr.length !== 0 ) {
129+
b.fail( 'should have length 0' );
130+
}
131+
}
132+
b.toc();
133+
if ( !isndarrayLike( arr ) ) {
134+
b.fail( 'should return an ndarray' );
135+
}
136+
b.pass( 'benchmark finished' );
137+
b.end();
138+
});
139+
140+
bench( format( '%s:dtype=int16', pkg ), function benchmark( b ) {
141+
var arr;
142+
var i;
143+
b.tic();
144+
for ( i = 0; i < b.iterations; i++ ) {
145+
arr = ones( 'int16', [ 0 ], 'row-major' );
146+
if ( arr.length !== 0 ) {
147+
b.fail( 'should have length 0' );
148+
}
149+
}
150+
b.toc();
151+
if ( !isndarrayLike( arr ) ) {
152+
b.fail( 'should return an ndarray' );
153+
}
154+
b.pass( 'benchmark finished' );
155+
b.end();
156+
});
157+
158+
bench( format( '%s:dtype=uint16', pkg ), function benchmark( b ) {
159+
var arr;
160+
var i;
161+
b.tic();
162+
for ( i = 0; i < b.iterations; i++ ) {
163+
arr = ones( 'uint16', [ 0 ], 'row-major' );
164+
if ( arr.length !== 0 ) {
165+
b.fail( 'should have length 0' );
166+
}
167+
}
168+
b.toc();
169+
if ( !isndarrayLike( arr ) ) {
170+
b.fail( 'should return an ndarray' );
171+
}
172+
b.pass( 'benchmark finished' );
173+
b.end();
174+
});
175+
176+
bench( format( '%s:dtype=int8', pkg ), function benchmark( b ) {
177+
var arr;
178+
var i;
179+
b.tic();
180+
for ( i = 0; i < b.iterations; i++ ) {
181+
arr = ones( 'int8', [ 0 ], 'row-major' );
182+
if ( arr.length !== 0 ) {
183+
b.fail( 'should have length 0' );
184+
}
185+
}
186+
b.toc();
187+
if ( !isndarrayLike( arr ) ) {
188+
b.fail( 'should return an ndarray' );
189+
}
190+
b.pass( 'benchmark finished' );
191+
b.end();
192+
});
193+
194+
bench( format( '%s:dtype=uint8', pkg ), function benchmark( b ) {
195+
var arr;
196+
var i;
197+
b.tic();
198+
for ( i = 0; i < b.iterations; i++ ) {
199+
arr = ones( 'uint8', [ 0 ], 'row-major' );
200+
if ( arr.length !== 0 ) {
201+
b.fail( 'should have length 0' );
202+
}
203+
}
204+
b.toc();
205+
if ( !isndarrayLike( arr ) ) {
206+
b.fail( 'should return an ndarray' );
207+
}
208+
b.pass( 'benchmark finished' );
209+
b.end();
210+
});
211+
212+
bench( format( '%s:dtype=uint8c', pkg ), function benchmark( b ) {
213+
var arr;
214+
var i;
215+
b.tic();
216+
for ( i = 0; i < b.iterations; i++ ) {
217+
arr = ones( 'uint8c', [ 0 ], 'row-major' );
218+
if ( arr.length !== 0 ) {
219+
b.fail( 'should have length 0' );
220+
}
221+
}
222+
b.toc();
223+
if ( !isndarrayLike( arr ) ) {
224+
b.fail( 'should return an ndarray' );
225+
}
226+
b.pass( 'benchmark finished' );
227+
b.end();
228+
});
229+
230+
bench( format( '%s:dtype=generic', pkg ), function benchmark( b ) {
231+
var arr;
232+
var i;
233+
b.tic();
234+
for ( i = 0; i < b.iterations; i++ ) {
235+
arr = ones( 'generic', [ 0 ], 'row-major' );
236+
if ( arr.length !== 0 ) {
237+
b.fail( 'should have length 0' );
238+
}
239+
}
240+
b.toc();
241+
if ( !isndarrayLike( arr ) ) {
242+
b.fail( 'should return an ndarray' );
243+
}
244+
b.pass( 'benchmark finished' );
245+
b.end();
246+
});

0 commit comments

Comments
 (0)