diff --git a/lib/node_modules/@stdlib/ndarray/vector/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/vector/docs/types/index.d.ts index 3cf3d75e9810..8031064fa63d 100644 --- a/lib/node_modules/@stdlib/ndarray/vector/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/vector/docs/types/index.d.ts @@ -26,6 +26,7 @@ import Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); import vector = require( '@stdlib/ndarray/vector/ctor' ); import Float32Vector = require( '@stdlib/ndarray/vector/float32' ); import Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +import GenericVector = require( '@stdlib/ndarray/vector/generic' ); import Int8Vector = require( '@stdlib/ndarray/vector/int8' ); import Int16Vector = require( '@stdlib/ndarray/vector/int16' ); import Int32Vector = require( '@stdlib/ndarray/vector/int32' ); @@ -410,6 +411,47 @@ interface Namespace { */ Float64Vector: typeof Float64Vector; + /** + * Creates a "generic" 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 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 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 + * @param options.order - memory layout (either row-major or column-major) + * @returns one-dimensional ndarray + * + * @example + * var numel = require( '@stdlib/ndarray/numel' ); + * + * var arr = new ns.GenericVector(); + * // returns + * + * var len = numel( arr ); + * // returns 0 + * + * @example + * var numel = require( '@stdlib/ndarray/numel' ); + * + * var arr = new ns.GenericVector( 2 ); + * // returns + * + * var len = numel( arr ); + * // returns 2 + * + * @example + * var numel = require( '@stdlib/ndarray/numel' ); + * + * var arr = new ns.GenericVector( [ 1.0, 2.0 ] ); + * // returns + * + * var len = numel( arr ); + * // returns 2 + */ + GenericVector: typeof GenericVector; + /** * Creates a signed 8-bit integer vector (i.e., a one-dimensional ndarray). *