@stdlib/ndarray-base-from-array 0.1.0 → 0.1.1

package/README.md

@@ -68,13 +68,16 @@ var array2ndarray = require( '@stdlib/ndarray-base-from-array' );
 Returns a one-dimensional [ndarray][@stdlib/ndarray/base/ctor] which wraps a provided input array.
 
 ```javascript
+var getShape = require( '@stdlib/ndarray-shape' );
+var getDType = require( '@stdlib/ndarray-dtype' );
+
 var x = array2ndarray( [ 1, 2, 3 ], 'row-major' );
 // returns <ndarray>
 
-var sh = x.shape;
+var sh = getShape( x );
 // returns [ 3 ]
 
-var dt = x.dtype;
+var dt = String( getDType( x ) );
 // returns 'generic'
 ```
 
@@ -104,29 +107,29 @@ The function supports the following parameters:
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var dtype = require( '@stdlib/ndarray-dtype' );
+var getDType = require( '@stdlib/ndarray-dtype' );
 var typedarray = require( '@stdlib/array-typed' );
 var array2ndarray = require( '@stdlib/ndarray-base-from-array' );
 
 var buf = typedarray( 10, 'float64' );
 var x = array2ndarray( buf, 'row-major' );
-console.log( dtype( x ) );
-// => 'float64'
+var dt = String( getDType( x ) );
+// returns 'float64'
 
 buf = typedarray( 10, 'int32' );
 x = array2ndarray( buf, 'row-major' );
-console.log( dtype( x ) );
-// => 'int32'
+dt = String( getDType( x ) );
+// returns 'int32'
 
 buf = typedarray( 10, 'complex128' );
 x = array2ndarray( buf, 'row-major' );
-console.log( dtype( x ) );
-// => 'complex128'
+dt = String( getDType( x ) );
+// returns 'complex128'
 
 buf = typedarray( 10, 'bool' );
 x = array2ndarray( buf, 'row-major' );
-console.log( dtype( x ) );
-// => 'bool'
+dt = String( getDType( x ) );
+// returns 'bool'
 ```
 
 </section>
@@ -188,8 +191,8 @@ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-from-array.svg
 [npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-from-array
 
-[test-image]: https://github.com/stdlib-js/ndarray-base-from-array/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/ndarray-base-from-array/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/ndarray-base-from-array/actions/workflows/test.yml/badge.svg?branch=v0.1.1
+[test-url]: https://github.com/stdlib-js/ndarray-base-from-array/actions/workflows/test.yml?query=branch:v0.1.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-from-array/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-from-array?branch=main

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../lib/main.js", "../lib/index.js"],
-  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar dtype = require( '@stdlib/ndarray-base-buffer-dtype' );\nvar ndarray = require( '@stdlib/ndarray-base-ctor' );\n\n\n// MAIN //\n\n/**\n* Converts an array to a one-dimensional ndarray.\n*\n* @param {Collection} buf - input array\n* @param {string} order - memory layout (either 'row-major' or 'column-major')\n* @returns {ndarray} ndarray\n*\n* @example\n* var arr = [ 1, 2, 3 ];\n*\n* var x = array2ndarray( arr, 'row-major' );\n* // returns <ndarray>\n*\n* var dt = x.dtype;\n* // returns 'generic'\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var arr = new Float64Array( [ 1.0, 2.0, 3.0 ] );\n*\n* var x = array2ndarray( arr, 'row-major' );\n* // returns <ndarray>\n*\n* var dt = x.dtype;\n* // returns 'float64'\n*/\nfunction array2ndarray( buf, order ) {\n\tvar dt = dtype( buf ) || 'generic';\n\treturn new ndarray( dt, buf, [ buf.length ], [ 1 ], 0, order );\n}\n\n\n// EXPORTS //\n\nmodule.exports = array2ndarray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert an array to a one-dimensional ndarray.\n*\n* @module @stdlib/ndarray-base-from-array\n*\n* @example\n* var array2ndarray = require( '@stdlib/ndarray-base-from-array' );\n*\n* var arr = [ 1, 2, 3 ];\n*\n* var x = array2ndarray( arr, 'row-major' );\n* // returns <ndarray>\n*\n* var dt = x.dtype;\n* // returns 'generic'\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
-  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,mCAAoC,EACrDC,EAAU,QAAS,2BAA4B,EAgCnD,SAASC,EAAeC,EAAKC,EAAQ,CACpC,IAAIC,EAAKL,EAAOG,CAAI,GAAK,UACzB,OAAO,IAAIF,EAASI,EAAIF,EAAK,CAAEA,EAAI,MAAO,EAAG,CAAE,CAAE,EAAG,EAAGC,CAAM,CAC9D,CAKAL,EAAO,QAAUG,ICxBjB,IAAII,EAAO,IAKX,OAAO,QAAUA",
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar dtype = require( '@stdlib/ndarray-base-buffer-dtype' );\nvar ndarray = require( '@stdlib/ndarray-base-ctor' );\n\n\n// MAIN //\n\n/**\n* Converts an array to a one-dimensional ndarray.\n*\n* @param {Collection} buf - input array\n* @param {string} order - memory layout (either 'row-major' or 'column-major')\n* @returns {ndarray} ndarray\n*\n* @example\n* var getDType = require( '@stdlib/ndarray-dtype' );\n*\n* var arr = [ 1, 2, 3 ];\n*\n* var x = array2ndarray( arr, 'row-major' );\n* // returns <ndarray>\n*\n* var dt = String( getDType( x ) );\n* // returns 'generic'\n*\n* @example\n* var getDType = require( '@stdlib/ndarray-dtype' );\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var arr = new Float64Array( [ 1.0, 2.0, 3.0 ] );\n*\n* var x = array2ndarray( arr, 'row-major' );\n* // returns <ndarray>\n*\n* var dt = String( getDType( x ) );\n* // returns 'float64'\n*/\nfunction array2ndarray( buf, order ) {\n\tvar dt = dtype( buf ) || 'generic';\n\treturn new ndarray( dt, buf, [ buf.length ], [ 1 ], 0, order );\n}\n\n\n// EXPORTS //\n\nmodule.exports = array2ndarray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert an array to a one-dimensional ndarray.\n*\n* @module @stdlib/ndarray-base-from-array\n*\n* @example\n* var getDType = require( '@stdlib/ndarray-dtype' );\n* var array2ndarray = require( '@stdlib/ndarray-base-from-array' );\n*\n* var arr = [ 1, 2, 3 ];\n*\n* var x = array2ndarray( arr, 'row-major' );\n* // returns <ndarray>\n*\n* var dt = String( getDType( x ) );\n* // returns 'generic'\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,mCAAoC,EACrDC,EAAU,QAAS,2BAA4B,EAmCnD,SAASC,EAAeC,EAAKC,EAAQ,CACpC,IAAIC,EAAKL,EAAOG,CAAI,GAAK,UACzB,OAAO,IAAIF,EAASI,EAAIF,EAAK,CAAEA,EAAI,MAAO,EAAG,CAAE,CAAE,EAAG,EAAGC,CAAM,CAC9D,CAKAL,EAAO,QAAUG,IC1BjB,IAAII,EAAO,IAKX,OAAO,QAAUA",
   "names": ["require_main", "__commonJSMin", "exports", "module", "dtype", "ndarray", "array2ndarray", "buf", "order", "dt", "main"]
 }

package/docs/types/index.d.ts

@@ -31,6 +31,7 @@ import { float64ndarray, float32ndarray, int32ndarray, int16ndarray, int8ndarray
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Float64Array = require( '@stdlib/array-float64' );
 *
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
@@ -38,7 +39,7 @@ import { float64ndarray, float32ndarray, int32ndarray, int16ndarray, int8ndarray
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'float64'
 */
 declare function array2ndarray( buf: Float64Array, order: Order ): float64ndarray;
@@ -51,6 +52,7 @@ declare function array2ndarray( buf: Float64Array, order: Order ): float64ndarra
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Float32Array = require( '@stdlib/array-float32' );
 *
 * var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] );
@@ -58,7 +60,7 @@ declare function array2ndarray( buf: Float64Array, order: Order ): float64ndarra
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'float32'
 */
 declare function array2ndarray( buf: Float32Array, order: Order ): float32ndarray;
@@ -71,6 +73,7 @@ declare function array2ndarray( buf: Float32Array, order: Order ): float32ndarra
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Complex128Array = require( '@stdlib/array-complex128' );
 *
 * var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
@@ -78,7 +81,7 @@ declare function array2ndarray( buf: Float32Array, order: Order ): float32ndarra
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'complex128'
 */
 declare function array2ndarray( buf: Complex128Array, order: Order ): complex128ndarray;
@@ -91,6 +94,7 @@ declare function array2ndarray( buf: Complex128Array, order: Order ): complex128
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Complex64Array = require( '@stdlib/array-complex64' );
 *
 * var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
@@ -98,7 +102,7 @@ declare function array2ndarray( buf: Complex128Array, order: Order ): complex128
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'complex64'
 */
 declare function array2ndarray( buf: Complex64Array, order: Order ): complex64ndarray;
@@ -111,6 +115,7 @@ declare function array2ndarray( buf: Complex64Array, order: Order ): complex64nd
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Int32Array = require( '@stdlib/array-int32' );
 *
 * var arr = new Int32Array( [ 1, 2, 3, 4 ] );
@@ -118,7 +123,7 @@ declare function array2ndarray( buf: Complex64Array, order: Order ): complex64nd
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'int32'
 */
 declare function array2ndarray( buf: Int32Array, order: Order ): int32ndarray;
@@ -131,6 +136,7 @@ declare function array2ndarray( buf: Int32Array, order: Order ): int32ndarray;
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Int16Array = require( '@stdlib/array-int16' );
 *
 * var arr = new Int16Array( [ 1, 2, 3, 4 ] );
@@ -138,7 +144,7 @@ declare function array2ndarray( buf: Int32Array, order: Order ): int32ndarray;
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'int16'
 */
 declare function array2ndarray( buf: Int16Array, order: Order ): int16ndarray;
@@ -151,6 +157,7 @@ declare function array2ndarray( buf: Int16Array, order: Order ): int16ndarray;
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Int8Array = require( '@stdlib/array-int8' );
 *
 * var arr = new Int8Array( [ 1, 2, 3, 4 ] );
@@ -158,7 +165,7 @@ declare function array2ndarray( buf: Int16Array, order: Order ): int16ndarray;
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'int8'
 */
 declare function array2ndarray( buf: Int8Array, order: Order ): int8ndarray;
@@ -171,6 +178,7 @@ declare function array2ndarray( buf: Int8Array, order: Order ): int8ndarray;
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Uint32Array = require( '@stdlib/array-uint32' );
 *
 * var arr = new Uint32Array( [ 1, 2, 3, 4 ] );
@@ -178,7 +186,7 @@ declare function array2ndarray( buf: Int8Array, order: Order ): int8ndarray;
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'uint32'
 */
 declare function array2ndarray( buf: Uint32Array, order: Order ): uint32ndarray;
@@ -191,6 +199,7 @@ declare function array2ndarray( buf: Uint32Array, order: Order ): uint32ndarray;
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Uint16Array = require( '@stdlib/array-uint16' );
 *
 * var arr = new Uint16Array( [ 1, 2, 3, 4 ] );
@@ -198,7 +207,7 @@ declare function array2ndarray( buf: Uint32Array, order: Order ): uint32ndarray;
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'uint16'
 */
 declare function array2ndarray( buf: Uint16Array, order: Order ): uint16ndarray;
@@ -211,6 +220,7 @@ declare function array2ndarray( buf: Uint16Array, order: Order ): uint16ndarray;
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Uint8Array = require( '@stdlib/array-uint8' );
 *
 * var arr = new Uint8Array( [ 1, 2, 3, 4 ] );
@@ -218,7 +228,7 @@ declare function array2ndarray( buf: Uint16Array, order: Order ): uint16ndarray;
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'uint8'
 */
 declare function array2ndarray( buf: Uint8Array, order: Order ): uint8ndarray;
@@ -231,6 +241,7 @@ declare function array2ndarray( buf: Uint8Array, order: Order ): uint8ndarray;
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Uint8ClampedArray = require( '@stdlib/array-uint8c' );
 *
 * var arr = new Uint8ClampedArray( [ 1, 2, 3, 4 ] );
@@ -238,7 +249,7 @@ declare function array2ndarray( buf: Uint8Array, order: Order ): uint8ndarray;
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'uint8c'
 */
 declare function array2ndarray( buf: Uint8ClampedArray, order: Order ): uint8cndarray;
@@ -251,6 +262,7 @@ declare function array2ndarray( buf: Uint8ClampedArray, order: Order ): uint8cnd
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var BooleanArray = require( '@stdlib/array-bool' );
 *
 * var arr = new BooleanArray( [ true, false, true, false ] );
@@ -258,7 +270,7 @@ declare function array2ndarray( buf: Uint8ClampedArray, order: Order ): uint8cnd
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'bool'
 */
 declare function array2ndarray( buf: BooleanArray, order: Order ): boolndarray;
@@ -271,12 +283,14 @@ declare function array2ndarray( buf: BooleanArray, order: Order ): boolndarray;
 * @returns one-dimensional ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
+*
 * var arr = [ 1, 2, 3, 4 ];
 *
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'generic'
 */
 declare function array2ndarray<T = unknown>( buf: Array<T> | Collection<T> | AccessorArrayLike<T>, order: Order ): genericndarray<T>;

package/lib/index.js

@@ -24,6 +24,7 @@
 * @module @stdlib/ndarray-base-from-array
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var array2ndarray = require( '@stdlib/ndarray-base-from-array' );
 *
 * var arr = [ 1, 2, 3 ];
@@ -31,7 +32,7 @@
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'generic'
 */
 

package/lib/main.js

@@ -34,15 +34,18 @@ var ndarray = require( '@stdlib/ndarray-base-ctor' );
 * @returns {ndarray} ndarray
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
+*
 * var arr = [ 1, 2, 3 ];
 *
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'generic'
 *
 * @example
+* var getDType = require( '@stdlib/ndarray-dtype' );
 * var Float64Array = require( '@stdlib/array-float64' );
 *
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0 ] );
@@ -50,7 +53,7 @@ var ndarray = require( '@stdlib/ndarray-base-ctor' );
 * var x = array2ndarray( arr, 'row-major' );
 * // returns <ndarray>
 *
-* var dt = x.dtype;
+* var dt = String( getDType( x ) );
 * // returns 'float64'
 */
 function array2ndarray( buf, order ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/ndarray-base-from-array",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Convert an array to a one-dimensional ndarray.",
   "license": "Apache-2.0",
   "author": {
@@ -30,8 +30,8 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/ndarray-base-buffer-dtype": "^0.4.0",
-    "@stdlib/ndarray-base-ctor": "^0.2.2"
+    "@stdlib/ndarray-base-buffer-dtype": "^0.4.1",
+    "@stdlib/ndarray-base-ctor": "^0.3.0"
   },
   "devDependencies": {},
   "engines": {