Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions lib/node_modules/@stdlib/array/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import empty = require( '@stdlib/array/empty' );
import emptyLike = require( '@stdlib/array/empty-like' );
import filled = require( '@stdlib/array/filled' );
import filledBy = require( '@stdlib/array/filled-by' );
import Float16Array = require( '@stdlib/array/float16' );
import Float32Array = require( '@stdlib/array/float32' );
import Float64Array = require( '@stdlib/array/float64' );
import iterator2array = require( '@stdlib/array/from-iterator' );
Expand Down Expand Up @@ -636,6 +637,73 @@ interface Namespace {
*/
filledBy: typeof filledBy;

/**
* Half-precision floating-point number array constructor.
*
* @param arg - length, typed array, array-like object, or buffer
* @param byteOffset - byte offset (default: 0)
* @param length - view length
* @throws ArrayBuffer byte length must be a multiple of `2`
* @throws if provided only a single argument, must provide a valid argument
* @throws byte offset must be a nonnegative integer
* @throws byte offset must be a multiple of `2`
* @throws view length must be a positive multiple of `2`
* @throws must provide sufficient memory to accommodate byte offset and view length requirements
* @returns half-precision floating-point number array
*
* @example
* var arr = new ns.Float16Array();
* // returns <Float16Array>
*
* var len = arr.length;
* // returns 0
*
* @example
* var arr = new ns.Float16Array( 2 );
* // returns <Float16Array>
*
* var len = arr.length;
* // returns 2
*
* @example
* var arr = new ns.Float16Array( [ 1.0, 2.0 ] );
* // returns <Float16Array>
*
* var len = arr.length;
* // returns 2
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 16 );
* var arr = new ns.Float16Array( buf );
* // returns <Float16Array>
*
* var len = arr.length;
* // returns 8
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 16 );
* var arr = new ns.Float16Array( buf, 8 );
* // returns <Float16Array>
*
* var len = arr.length;
* // returns 4
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = new ns.Float16Array( buf, 8, 2 );
* // returns <Float16Array>
*
* var len = arr.length;
* // returns 2
*/
Float16Array: typeof Float16Array;

/**
* Typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in the platform byte order.
*/
Expand Down
Loading