Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Features
 
+-   [`2501de9`](https://github.com/stdlib-js/stdlib/commit/2501de9d60e1239dc54568fff1c6ecdf2770e3fa) - add `ndarray/vector/float64`
 -   [`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
@@ -392,6 +393,9 @@ A total of 15 issues were closed in this release:
 
 <details>
 
+-   [`2501de9`](https://github.com/stdlib-js/stdlib/commit/2501de9d60e1239dc54568fff1c6ecdf2770e3fa) - **feat:** add `ndarray/vector/float64` _(by Athan Reines)_
+-   [`f75732b`](https://github.com/stdlib-js/stdlib/commit/f75732ba5e3117ae0f9336722834307243eca2be) - **docs:** update example _(by Athan Reines)_
+-   [`5662f92`](https://github.com/stdlib-js/stdlib/commit/5662f920d833b3033ac24e38ef2a13b7506f7495) - **docs:** update example _(by Athan Reines)_
 -   [`b599489`](https://github.com/stdlib-js/stdlib/commit/b5994896400e31d3850ba003a2eb016142bf6c9a) - **docs:** fix signature _(by Athan Reines)_
 -   [`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)_

vector/ctor/docs/repl.txt

@@ -189,7 +189,7 @@
 
     Examples
     --------
-    > var buf = new {{alias:@stdlib/array/buffer}}( 16 );
+    > var buf = new {{alias:@stdlib/array/buffer}}( 32 );
     > var arr = {{alias}}( buf, 0, 4, 'float32' )
     <ndarray>
     > var dt = {{alias:@stdlib/ndarray/dtype}}( arr )

vector/float32/docs/repl.txt

@@ -164,7 +164,7 @@
 
     Examples
     --------
-    > var buf = new {{alias:@stdlib/array/buffer}}( 16 );
+    > var buf = new {{alias:@stdlib/array/buffer}}( 32 );
     > var arr = {{alias}}( buf, 0, 4 )
     <ndarray>
     > var len = {{alias:@stdlib/ndarray/numel}}( arr )

vector/float64/README.md

@@ -0,0 +1,196 @@
+<!--
+
+@license Apache-2.0
+
+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.
+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.
+
+-->
+
+# Float64Vector
+
+> Create a double-precision floating-point vector (i.e., a one-dimensional [ndarray][@stdlib/ndarray/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 Float64Vector = require( '@stdlib/ndarray/vector/float64' );
+```
+
+#### Float64Vector( \[options] )
+
+Returns a one-dimensional double-precision floating-point [ndarray][@stdlib/ndarray/ctor].
+
+```javascript
+var numel = require( '@stdlib/ndarray/numel' );
+
+var arr = new Float64Vector();
+// returns <ndarray>
+
+var len = numel( arr );
+// returns 0
+```
+
+The function accepts the following options:
+
+-   **order**: specifies whether an [ndarray][@stdlib/ndarray/ctor] is `'row-major'` (C-style) or `'column-major'` (Fortran-style). Default: `'row-major'`.
+-   **mode**: specifies how to handle indices which exceed array dimensions (see [`ndarray`][@stdlib/ndarray/ctor]). Default: `'throw'`.
+-   **readonly**: boolean indicating whether an array should be **read-only**. Default: `false`.
+
+#### Float64Vector( length\[, options] )
+
+Returns a one-dimensional double-precision floating-point [ndarray][@stdlib/ndarray/ctor] having a specified `length`.
+
+```javascript
+var numel = require( '@stdlib/ndarray/numel' );
+
+var arr = new Float64Vector( 5 );
+// returns <ndarray>
+
+var len1 = numel( arr );
+// returns 5
+```
+
+#### Float64Vector( obj\[, options] )
+
+Creates a one-dimensional double-precision floating-point [ndarray][@stdlib/ndarray/ctor] from an array-like object or iterable.
+
+```javascript
+var numel = require( '@stdlib/ndarray/numel' );
+
+var arr = new Float64Vector( [ 1.0, 2.0, 3.0 ] );
+// returns <ndarray>
+
+var len1 = numel( arr );
+// returns 3
+```
+
+#### Float64Vector( buffer\[, byteOffset\[, length]]\[, options] )
+
+Returns a one-dimensional double-precision floating-point [ndarray][@stdlib/ndarray/ctor] view of an [`ArrayBuffer`][@stdlib/array/buffer].
+
+```javascript
+var ArrayBuffer = require( '@stdlib/array/buffer' );
+var numel = require( '@stdlib/ndarray/numel' );
+
+var buf = new ArrayBuffer( 64 );
+
+var arr1 = new Float64Vector( buf );
+// returns <ndarray>
+
+var len1 = numel( arr1 );
+// returns 8
+
+var arr2 = new Float64Vector( buf, 16 );
+// returns <ndarray>
+
+var len2 = numel( arr2 );
+// returns 6
+
+var arr3 = new Float64Vector( buf, 16, 1 );
+// returns <ndarray>
+
+var len3 = numel( arr3 );
+// returns 1
+```
+
+</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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var sum = require( '@stdlib/blas/ext/sum' );
+var map = require( '@stdlib/ndarray/map' );
+var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
+
+// Create a vector containing random values:
+var x = new Float64Vector( discreteUniform( 10, 0, 100 ) );
+
+// Compute the sum:
+var v = sum( x );
+console.log( v.get() );
+
+// Define a function which applies a threshold to individual values:
+function threshold( v ) {
+    return ( v > 10 ) ? v : 0;
+}
+
+// Apply threshold:
+var y = map( x, threshold );
+
+// Recompute the sum:
+v = sum( y );
+console.log( v.get() );
+```
+
+</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/array/buffer]: https://github.com/stdlib-js/array-buffer
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
+
+</section>
+
+<!-- /.links -->

vector/float64/benchmark/benchmark.js

@@ -0,0 +1,47 @@
+/**
+* @license Apache-2.0
+*
+* 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.
+* 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 isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var pkg = require( './../package.json' ).name;
+var Float64Vector = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var arr;
+	var i;
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr = new Float64Vector( 0 );
+		if ( arr.length !== 0 ) {
+			b.fail( 'should have length 0' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( arr ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

vector/float64/benchmark/benchmark.size.js

@@ -0,0 +1,93 @@
+/**
+* @license Apache-2.0
+*
+* 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.
+* 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 pow = require( '@stdlib/math/base/special/pow' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var pkg = require( './../package.json' ).name;
+var Float64Vector = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var arr;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			arr = new Float64Vector( len );
+			if ( arr.length !== len ) {
+				b.fail( 'unexpected length' );
+			}
+		}
+		b.toc();
+		if ( !isndarrayLike( arr ) ) {
+			b.fail( 'should return an ndarray' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':size='+len, f );
+	}
+}
+
+main();