feat: add tests and update main and readme accordingly

Author: LoayAhmed304

lib/node_modules/@stdlib/ndarray/base/eye/README.md

@@ -80,6 +80,9 @@ The function accepts the following arguments:
 
 ## Notes
 
+-   If the provided [data type][@stdlib/ndarray/dtypes] is complex, the function returns an ndarray whose kth diagonal is filled with complex numbers whose real component equals one and imaginary component equals zero
+
+-   If `k` is greater than the number of columns or less than number of negative rows, the function returns an array filled with zeros
 
 </section>
 

lib/node_modules/@stdlib/ndarray/base/eye/lib/main.js

@@ -23,9 +23,12 @@
 var isAccessorArray = require( '@stdlib/array/base/assert/is-accessor-array' );
 var accessorSetter = require( '@stdlib/array/base/accessor-setter' );
 var isComplexDataType = require( '@stdlib/ndarray/base/assert/is-complex-floating-point-data-type' );
+var isInteger = require( '@stdlib/assert/is-integer' );
+var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' );
 var ctors = require( '@stdlib/complex/ctors' );
 var max = require( '@stdlib/math/base/special/max' );
 var min = require( '@stdlib/math/base/special/min' );
+var format = require( '@stdlib/string/format' );
 var zeros = require( '@stdlib/ndarray/base/zeros' );
 
 
@@ -50,10 +53,13 @@ function setter( buf, idx, v ) {
 * Creates a two-dimensional array with ones on the kth diagonal and zeros elsewhere.
 *
 * @param {*} dtype - output array data type
-* @param {Number} rows - output array number of rows
-* @param {Number} cols - output array number of columns
-* @param {Number} k - diagonal index. positive refers to upper diagonal, and negative refers to lower diagonal
+* @param {NonNegativeInteger} rows - output array number of rows
+* @param {NonNegativeInteger} cols - output array number of columns
+* @param {IntegerNumber} k - diagonal index. positive refers to upper diagonal, and negative refers to lower diagonal
 * @param {string} order - memory layout (either row-major or column-major)
+* @throws {TypeError} first argument must be a recognized data type
+* @throws {TypeError} fourth argument must be an integer
+* @throws {TypeError} second and third arguments must be non-negative integers
 * @returns {ndarray} ndarray
 *
 * @example
@@ -87,6 +93,14 @@ function eye( dtype, rows, cols, k, order ) {
 	var c;
 	var x;
 
+	if ( !isInteger( k ) ) {
+		throw new TypeError( format('invalid arguments. Diagonal index must be an integer. Value: %s.', k) );
+	}
+
+	if ( !isNonNegativeInteger( rows ) || !isNonNegativeInteger( cols ) ) {
+		throw new TypeError( format('invalid arguments. Rows and columns must be non-negative integers. Value: %s, %s.', rows, cols) );
+	}
+
 	if ( k < 0 ) {
 		r = -k;
 		c = 0;