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
111 changes: 110 additions & 1 deletion lib/node_modules/@stdlib/ndarray/matrix/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,116 @@ import matrix = require( '@stdlib/ndarray/matrix/ctor' );
*/
interface Namespace {
/**
* TODO.
* Creates a matrix (i.e., a two-dimensional ndarray).
*
* @param arg0 - number of rows, shape, 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 - number of rows or shape
* @param arg3 - number of columns
* @param dtype - data type (default: 'float64')
* @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 getDType = require( '@stdlib/ndarray/dtype' );
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var arr = ns.matrix();
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 0, 0 ]
*
* var dt = String( getDType( arr ) );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var arr = ns.matrix( 2, 2 );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* var dt = String( getDType( arr ) );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var arr = ns.matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* var dt = String( getDType( arr ) );
* // returns 'float64'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var arr = ns.matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], 'float32' );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* var dt = String( getDType( arr ) );
* // returns 'float32'
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = ns.matrix( buf, 8, 2, 1, 'int32' );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 1 ]
*
* var dt = String( getDType( arr ) );
* // returns 'int32'
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = ns.matrix( buf, 8, [ 2, 1 ], 'int32', {} );
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 1 ]
*
* var dt = String( getDType( arr ) );
* // returns 'int32'
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var Float32Matrix = ns.matrix.factory( 'float32' );
*
* var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
* // returns <ndarray>
*
* var dt = String( getDType( arr ) );
* // returns 'float32'
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*/
matrix: typeof matrix;
}
Expand Down