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
75 changes: 75 additions & 0 deletions lib/node_modules/@stdlib/ndarray/matrix/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import Complex128Matrix = require( '@stdlib/ndarray/matrix/complex128' );
import matrix = require( '@stdlib/ndarray/matrix/ctor' );
import Float32Matrix = require( '@stdlib/ndarray/matrix/float32' );
import Float64Matrix = require( '@stdlib/ndarray/matrix/float64' );
import Int16Matrix = require( '@stdlib/ndarray/matrix/int16' );
import Int32Matrix = require( '@stdlib/ndarray/matrix/int32' );

/**
Expand Down Expand Up @@ -441,6 +442,80 @@ interface Namespace {
*/
Float64Matrix: typeof Float64Matrix;

/**
* Creates a 16-bit signed integer matrix (i.e., a two-dimensional ndarray).
*
* @param arg0 - shape, number of rows, array-like object, ArrayBuffer, or iterable
* @param arg1 - number of columns or integer byte offset specifying the location of the first matrix element
* @param arg2 - matrix shape or number of rows
* @param arg3 - number of columns
* @param options - function options
* @param options.readonly - boolean indicating whether to return a read-only matrix
* @param options.mode - specifies how to handle indices which exceed matrix dimensions
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
* @param options.order - memory layout (either row-major or column-major)
* @returns two-dimensional ndarray
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var arr = new ns.Int16Matrix();
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 0, 0 ]
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var arr = new ns.Int16Matrix( [ 2, 2 ] );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var arr = new ns.Int16Matrix( 2, 2 );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var arr = new ns.Int16Matrix( [ [ 1, 2 ], [ 3, 4 ] ] );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = new ns.Int16Matrix( buf, 8, [ 2, 1 ] );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 1 ]
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = new ns.Int16Matrix( buf, 8, 2, 1 );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 1 ]
*/
Int16Matrix: typeof Int16Matrix;

/**
* Creates a 32-bit signed integer matrix (i.e., a two-dimensional ndarray).
*
Expand Down
Loading