Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -48,6 +48,7 @@
 
 <details>
 
+-   [`839aaf6`](https://github.com/stdlib-js/stdlib/commit/839aaf681cf5e10b2f4d1ed566d716dd2726421b) - **docs:** update documentation [(#13120)](https://github.com/stdlib-js/stdlib/pull/13120) _(by stdlib-bot)_
 -   [`4a14673`](https://github.com/stdlib-js/stdlib/commit/4a1467352fcbd486caca6564a300c627449d796d) - **docs:** update namespace table of contents [(#13121)](https://github.com/stdlib-js/stdlib/pull/13121) _(by stdlib-bot)_
 -   [`8bf9161`](https://github.com/stdlib-js/stdlib/commit/8bf91614301abf9249ff3ea9379baa4bc6c450e0) - **feat:** add `ndarray/matrix` namespace _(by Athan Reines)_
 -   [`dc9a2a7`](https://github.com/stdlib-js/stdlib/commit/dc9a2a7eb4962f9743ba7a7369a6593669370296) - **feat:** add `ndarray/matrix/ctor` _(by Athan Reines)_

matrix/docs/types/index.d.ts

@@ -27,7 +27,116 @@ import matrix = require( './../../../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( './../../../dtype' );
+	* var getShape = require( './../../../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( './../../../dtype' );
+	* var getShape = require( './../../../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( './../../../dtype' );
+	* var getShape = require( './../../../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( './../../../dtype' );
+	* var getShape = require( './../../../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( './../../../shape' );
+	* var getDType = require( './../../../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( './../../../shape' );
+	* var getDType = require( './../../../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( './../../../dtype' );
+	* var getShape = require( './../../../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;
 }