-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1c3faa4
commit 75c5741
Showing
15 changed files
with
791 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| <!-- | ||
| @license Apache-2.0 | ||
| Copyright (c) 2024 The Stdlib Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
| # ndarraylike2ndarray | ||
|
|
||
| > Convert an ndarray-like object to an [`ndarray`][@stdlib/ndarray/base/ctor]. | ||
| <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <!-- Package usage documentation. --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' ); | ||
| ``` | ||
|
|
||
| #### ndarraylike2ndarray( x ) | ||
|
|
||
| Converts an ndarray-like object to an [`ndarray`][@stdlib/ndarray/base/ctor]. | ||
|
|
||
| ```javascript | ||
| var array = require( '@stdlib/ndarray/array' ); | ||
|
|
||
| var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] ); | ||
| var out = ndarraylike2ndarray( arr ); | ||
| // returns <ndarray> | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <!-- Package usage examples. --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var array = require( '@stdlib/ndarray/array' ); | ||
| var ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' ); | ||
|
|
||
| // Create an ndarray: | ||
| var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); | ||
|
|
||
| // Convert to a "base" ndarray: | ||
| var out = ndarraylike2ndarray( x ); | ||
| // returns <ndarray> | ||
|
|
||
| // Print various properties: | ||
| console.log( 'dtype: %s', out.dtype ); | ||
| console.log( 'ndims: %d', out.shape.length ); | ||
| console.log( 'length: %d', out.length ); | ||
| console.log( 'shape: [ %s ]', out.shape.join( ', ' ) ); | ||
| console.log( 'strides: [ %s ]', out.strides.join( ', ' ) ); | ||
| console.log( 'offset: %d', out.offset ); | ||
| console.log( 'order: %s', out.order ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| <!-- 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. --> | ||
|
|
||
| <section class="references"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.references --> | ||
|
|
||
| <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
|
||
| <section class="related"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.related --> | ||
|
|
||
| <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="links"> | ||
|
|
||
| [@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/ndarray/tree/main/base/ctor | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2024 The Stdlib Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| // MODULES // | ||
|
|
||
| var bench = require( '@stdlib/bench' ); | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
| var ndarrayBase = require( './../../../base/ctor' ); | ||
| var ndarray = require( './../../../ctor' ); | ||
| var isCollection = require( '@stdlib/assert/is-collection' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var ndarraylike2ndarray = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg+'::base_ndarray', function benchmark( b ) { | ||
| var strides; | ||
| var values; | ||
| var buffer; | ||
| var offset; | ||
| var dtype; | ||
| var shape; | ||
| var order; | ||
| var out; | ||
| var i; | ||
|
|
||
| dtype = 'float64'; | ||
| buffer = new Float64Array( 4 ); | ||
| shape = [ 2, 2 ]; | ||
| strides = [ 2, 1 ]; | ||
| offset = 0; | ||
| order = 'row-major'; | ||
|
|
||
| values = [ | ||
| ndarrayBase( dtype, buffer, shape, strides, offset, order ), | ||
| ndarrayBase( dtype, buffer, shape, strides, offset, order ), | ||
| ndarrayBase( dtype, buffer, shape, strides, offset, order ), | ||
| ndarrayBase( dtype, buffer, shape, strides, offset, order ), | ||
| ndarrayBase( dtype, buffer, shape, strides, offset, order ) | ||
| ]; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| out = ndarraylike2ndarray( values[ i%values.length ] ); | ||
| if ( typeof out !== 'object' ) { | ||
| b.fail( 'should return an object' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( !isCollection( out.data ) ) { | ||
| b.fail( 'should return a collection' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); | ||
|
|
||
| bench( pkg+'::ndarray', function benchmark( b ) { | ||
| var strides; | ||
| var values; | ||
| var buffer; | ||
| var offset; | ||
| var dtype; | ||
| var shape; | ||
| var order; | ||
| var out; | ||
| var i; | ||
|
|
||
| dtype = 'float64'; | ||
| buffer = new Float64Array( 4 ); | ||
| shape = [ 2, 2 ]; | ||
| strides = [ 2, 1 ]; | ||
| offset = 0; | ||
| order = 'row-major'; | ||
|
|
||
| values = [ | ||
| ndarray( dtype, buffer, shape, strides, offset, order ), | ||
| ndarray( dtype, buffer, shape, strides, offset, order ), | ||
| ndarray( dtype, buffer, shape, strides, offset, order ), | ||
| ndarray( dtype, buffer, shape, strides, offset, order ), | ||
| ndarray( dtype, buffer, shape, strides, offset, order ) | ||
| ]; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| out = ndarraylike2ndarray( values[ i%values.length ] ); | ||
| if ( typeof out !== 'object' ) { | ||
| b.fail( 'should return an object' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( !isCollection( out.data ) ) { | ||
| b.fail( 'should return a collection' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); | ||
|
|
||
| bench( pkg+'::ndarray_like', function benchmark( b ) { | ||
| var strides; | ||
| var values; | ||
| var buffer; | ||
| var offset; | ||
| var dtype; | ||
| var shape; | ||
| var order; | ||
| var out; | ||
| var obj; | ||
| var i; | ||
|
|
||
| dtype = 'float64'; | ||
| buffer = new Float64Array( 4 ); | ||
| shape = [ 2, 2 ]; | ||
| strides = [ 2, 1 ]; | ||
| offset = 0; | ||
| order = 'row-major'; | ||
|
|
||
| values = []; | ||
| for ( i = 0; i < 5; i++ ) { | ||
| obj = { | ||
| 'dtype': dtype, | ||
| 'data': buffer, | ||
| 'shape': shape, | ||
| 'strides': strides, | ||
| 'offset': offset, | ||
| 'order': order | ||
| }; | ||
| values.push( obj ); | ||
| } | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| out = ndarraylike2ndarray( values[ i%values.length ] ); | ||
| if ( typeof out !== 'object' ) { | ||
| b.fail( 'should return an object' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( !isCollection( out.data ) ) { | ||
| b.fail( 'should return a collection' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
|
|
||
| {{alias}}( x ) | ||
| Converts an ndarray-like object to an ndarray. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| x: ndarrayLike | ||
| Input ndarray-like object. | ||
|
|
||
| Returns | ||
| ------- | ||
| out: ndarray | ||
| Output array. | ||
|
|
||
| Examples | ||
| -------- | ||
| > var arr = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ); | ||
| > var out = {{alias}}( arr ) | ||
| <ndarray> | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
Oops, something went wrong.