Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Features
 
+-   [`e8064cd`](https://github.com/stdlib-js/stdlib/commit/e8064cdc716fc9381a143620ef291722dba49228) - add `ndarray/vector/float32`
 -   [`b2cefbe`](https://github.com/stdlib-js/stdlib/commit/b2cefbe2b2192cb705b85c43ffac2f57ca782c42) - add custom `valueOf` method
 -   [`848f226`](https://github.com/stdlib-js/stdlib/commit/848f226d45aad2d627453c8306ae192c75338ac3) - add `factory` method
 -   [`916b907`](https://github.com/stdlib-js/stdlib/commit/916b9073d6cf82262233e835f9bbbaca26d685f0) - add `ndarray/vector/ctor`
@@ -391,6 +392,13 @@ A total of 15 issues were closed in this release:
 
 <details>
 
+-   [`e8064cd`](https://github.com/stdlib-js/stdlib/commit/e8064cdc716fc9381a143620ef291722dba49228) - **feat:** add `ndarray/vector/float32` _(by Athan Reines)_
+-   [`fbc6b85`](https://github.com/stdlib-js/stdlib/commit/fbc6b852fae5eb77c36e04208c4aad574d146459) - **docs:** fix comments _(by Athan Reines)_
+-   [`5471fc4`](https://github.com/stdlib-js/stdlib/commit/5471fc4ca1505d407bc2f0cb13cea076c73341c5) - **docs:** fix descriptions _(by Athan Reines)_
+-   [`7f4b555`](https://github.com/stdlib-js/stdlib/commit/7f4b555601081338bacc307c2a752ba9cd69107e) - **chore:** fix copyright year _(by Athan Reines)_
+-   [`6ce1c71`](https://github.com/stdlib-js/stdlib/commit/6ce1c716ea44aded1b140b1a897fd866774b22d8) - **docs:** update examples _(by Athan Reines)_
+-   [`384bc19`](https://github.com/stdlib-js/stdlib/commit/384bc19cdc6d91ddd4af97c2b1e5a4a0dac2b112) - **docs:** update examples _(by Athan Reines)_
+-   [`aa0af9e`](https://github.com/stdlib-js/stdlib/commit/aa0af9ec8401bad45f0dcafaeea4b38fd0f60e16) - **chore:** add TODO _(by Athan Reines)_
 -   [`30e2005`](https://github.com/stdlib-js/stdlib/commit/30e2005330c027b33d1386afacdacc50b3a46c77) - **test:** add tests _(by Athan Reines)_
 -   [`63756c5`](https://github.com/stdlib-js/stdlib/commit/63756c5110a952dc6f7d874badb99f125312902a) - **test:** add tests _(by Athan Reines)_
 -   [`01544ae`](https://github.com/stdlib-js/stdlib/commit/01544aef20deb6e2b8c6826462cd29916ce3e45b) - **test:** add tests _(by Athan Reines)_

vector/ctor/README.md

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2024 The Stdlib Authors.
+Copyright (c) 2025 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.

vector/ctor/docs/types/index.d.ts

@@ -76,7 +76,7 @@ interface GenericVector {
 	/**
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
-	* @param obj - array-like object or iterable from which to generate a typed array
+	* @param obj - array-like object or iterable from which to generate a vector
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
 	* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -116,7 +116,7 @@ interface TypedVector<T extends keyof TypedDataTypeMap> {
 	/**
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
-	* @param obj - array-like object or iterable from which to generate a typed array
+	* @param obj - array-like object or iterable from which to generate a vector
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
 	* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -141,7 +141,7 @@ interface TypedVector<T extends keyof TypedDataTypeMap> {
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
 	* @param buffer - underlying ArrayBuffer
-	* @param byteOffset - integer byte offset specifying the location of the first typed array element
+	* @param byteOffset - integer byte offset specifying the location of the first vector element
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
 	* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -154,7 +154,7 @@ interface TypedVector<T extends keyof TypedDataTypeMap> {
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
 	* @param buffer - underlying ArrayBuffer
-	* @param byteOffset - integer byte offset specifying the location of the first typed array element
+	* @param byteOffset - integer byte offset specifying the location of the first vector element
 	* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
@@ -324,7 +324,7 @@ interface Vector {
 	/**
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
-	* @param obj - array-like object or iterable from which to generate a typed array
+	* @param obj - array-like object or iterable from which to generate a vector
 	* @param dtype - data type (default: 'float64')
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
@@ -376,7 +376,7 @@ interface Vector {
 	/**
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
-	* @param obj - array-like object or iterable from which to generate a typed array
+	* @param obj - array-like object or iterable from which to generate a vector
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
 	* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -487,7 +487,7 @@ interface Vector {
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
 	* @param buffer - underlying ArrayBuffer
-	* @param byteOffset - integer byte offset specifying the location of the first typed array element (default: 0)
+	* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0)
 	* @param dtype - data type (default: 'float64')
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
@@ -546,7 +546,7 @@ interface Vector {
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
 	* @param buffer - underlying ArrayBuffer
-	* @param byteOffset - integer byte offset specifying the location of the first typed array element
+	* @param byteOffset - integer byte offset specifying the location of the first vector element
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
 	* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -589,7 +589,7 @@ interface Vector {
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
 	* @param buffer - underlying ArrayBuffer
-	* @param byteOffset - integer byte offset specifying the location of the first typed array element (default: 0)
+	* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0)
 	* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
 	* @param dtype - data type (default: 'float64')
 	* @param options - function options
@@ -647,7 +647,7 @@ interface Vector {
 	* Creates a vector (i.e., a one-dimensional ndarray).
 	*
 	* @param buffer - underlying ArrayBuffer
-	* @param byteOffset - integer byte offset specifying the location of the first typed array element
+	* @param byteOffset - integer byte offset specifying the location of the first vector element
 	* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
 	* @param options - function options
 	* @param options.readonly - boolean indicating whether to return a read-only vector
@@ -812,7 +812,7 @@ interface Vector {
 * Creates a vector (i.e., a one-dimensional ndarray).
 *
 * @param arg - length, typed array, array-like object, buffer, or iterable
-* @param byteOffset - integer byte offset specifying the location of the first typed array element (default: 0)
+* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0)
 * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
 * @param dtype - data type (default: 'float64')
 * @param options - function options

vector/ctor/docs/types/test.ts

@@ -61,7 +61,7 @@ import vector = require( './index' );
 	vector( new ArrayBuffer( 10 ), 8, 0, 'float32', {} ); // $ExpectType float32ndarray
 }
 
-// The compiler throws an error if the function is provided a first argument which is not a data type, number, array-like object, iterable, or options objects...
+// The compiler throws an error if the function is provided a first argument which is not a data type, number, array-like object, iterable, or options object...
 {
 	vector( true ); // $ExpectError
 	vector( false ); // $ExpectError
@@ -135,7 +135,7 @@ import vector = require( './index' );
 	f3( [ 1, 2, 3 ], {} ); // $ExpectType genericndarray<number>
 }
 
-// The compiler throws an error if the function returned by the `factory` method is provided a first argument which is not a data type, number, array-like object, iterable, or options objects...
+// The compiler throws an error if the function returned by the `factory` method is provided a first argument which is not a data type, number, array-like object, iterable, or options object...
 {
 	const f = vector.factory( 'float64' );
 

vector/ctor/lib/index.js

@@ -24,93 +24,107 @@
 * @module @stdlib/ndarray/vector/ctor
 *
 * @example
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+* var numel = require( '@stdlib/ndarray/numel' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
-* var v = new Vector();
+* var v = vector();
 * // returns <ndarray>
 *
-* var len = v.length;
+* var len = numel( v );
 * // returns 0
 *
-* var dt = v.dtype;
+* var dt = getDType( v );
 * // returns 'float64'
 *
 * @example
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+* var numel = require( '@stdlib/ndarray/numel' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
-* var v = new Vector( 2 );
+* var v = vector( 2 );
 * // returns <ndarray>
 *
-* var len = v.length;
+* var len = numel( v );
 * // returns 2
 *
-* var dt = v.dtype;
+* var dt = getDType( v );
 * // returns 'float64'
 *
 * @example
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+* var numel = require( '@stdlib/ndarray/numel' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
-* var v = new Vector( [ 1.0, 2.0 ] );
+* var v = vector( [ 1.0, 2.0 ] );
 * // returns <ndarray>
 *
-* var len = v.length;
+* var len = numel( v );
 * // returns 2
 *
-* var dt = v.dtype;
+* var dt = getDType( v );
 * // returns 'float64'
 *
 * @example
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+* var numel = require( '@stdlib/ndarray/numel' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
-* var v = new Vector( [ 1.0, 2.0 ], 'float32' );
+* var v = vector( [ 1.0, 2.0 ], 'float32' );
 * // returns <ndarray>
 *
-* var len = v.length;
+* var len = numel( v );
 * // returns 2
 *
-* var dt = v.dtype;
+* var dt = getDType( v );
 * // returns 'float32'
 *
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+* var numel = require( '@stdlib/ndarray/numel' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
 * var buf = new ArrayBuffer( 32 );
-* var v = new Vector( buf );
+* var v = vector( buf );
 * // returns <ndarray>
 *
-* var len = v.length;
+* var len = numel( v );
 * // returns 4
 *
-* var dt = v.dtype;
+* var dt = getDType( v );
 * // returns 'float64'
 *
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+* var numel = require( '@stdlib/ndarray/numel' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
 * var buf = new ArrayBuffer( 32 );
-* var v = new Vector( buf, 16 );
+* var v = vector( buf, 16 );
 * // returns <ndarray>
 *
-* var len = v.length;
+* var len = numel( v );
 * // returns 2
 *
-* var dt = v.dtype;
+* var dt = getDType( v );
 * // returns 'float64'
 *
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+* var numel = require( '@stdlib/ndarray/numel' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
 * var buf = new ArrayBuffer( 64 );
-* var v = new Vector( buf, 16, 2 );
+* var v = vector( buf, 16, 2 );
 * // returns <ndarray>
 *
-* var len = v.length;
+* var len = numel( v );
 * // returns 2
 *
-* var dt = v.dtype;
+* var dt = getDType( v );
 * // returns 'float64'
 */
 

vector/ctor/lib/main.js

@@ -149,7 +149,7 @@ function resolveOrder( options ) {
 * var len = numel( v );
 * // returns 2
 */
-function arraybuffer2vector( dtype, buffer, length, stride, byteOffset, order, options ) {
+function arraybuffer2vector( dtype, buffer, length, stride, byteOffset, order, options ) { // TODO: consider moving to `@stdlib/ndarray/from-arraybuffer` and generalize to n-dimensions such that `length` becomes `shape` and `stride` becomes `strides`
 	var buf;
 	var sh;
 	var st;