Add REPL text and TypeScript declarations

Author: kgryte

lib/node_modules/@stdlib/math/special/abs/docs/repl.txt

@@ -0,0 +1,43 @@
+
+{{alias}}( x )
+    Computes the absolute value.
+
+    If provided a number, the function returns a number.
+
+    If provided an ndarray or array-like object, the function performs element-
+    wise iteration and returns an ndarray having the same shape as `x` and
+    containing element-wise results.
+
+    Parameters
+    ----------
+    x: ndarray|ArrayLikeObject|number
+        Input value.
+
+    Returns
+    -------
+    y: ndarray|number
+        Element-wise results.
+
+    Examples
+    --------
+    // Provide a number:
+    > var y = {{alias}}( -1.0 )
+    1.0
+
+    // Provide an array-like object:
+    > var x = new {{alias:@stdlib/array/float64}}( [ -1.0, -2.0 ] );
+    > y = {{alias}}( x )
+    <ndarray>
+    > y.data
+    <Float64Array>[ 1.0, 2.0 ]
+
+    // Provide an ndarray:
+    > x = {{alias:@stdlib/ndarray/array}}( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
+    > y = {{alias}}( x )
+    <ndarray>
+    > y.get( 0, 1 )
+    2.0
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/math/special/abs/docs/types/index.d.ts

@@ -0,0 +1,71 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2020 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/// <reference types="@stdlib/types"/>
+
+import { ArrayLike } from '@stdlib/types/array';
+import { ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Computes the absolute value.
+*
+* @param x - input value
+* @returns absolute value
+*
+* @example
+* var y = abs( -1.0 );
+* // returns 1.0
+*/
+declare function abs( x: number ): number;
+
+/**
+* Computes the absolute value.
+*
+* @param x - input value
+* @returns absolute value
+*
+* @example
+* var Float64Array = require( `@stdlib/array/float64` );
+*
+* var x = new Float64Array( [ -1.0, -2.0 ] );
+*
+* var y = abs( x );
+* // returns <ndarray>
+*
+* var v = y.data;
+* // returns <Float64Array>[ 1.0, 2.0 ]
+*
+* @example
+* var array = require( `@stdlib/ndarray/array` );
+*
+* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
+*
+* var y = abs( x );
+* // returns <ndarray>
+*
+* var v = y.get( 0, 1 );
+* // returns 2.0
+*/
+declare function abs( x: ndarray | ArrayLike<number> ): ndarray;
+
+
+// EXPORTS //
+
+export = abs;

lib/node_modules/@stdlib/math/special/abs/docs/types/test.ts

@@ -0,0 +1,78 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2020 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import abs = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number if provided a number...
+{
+	abs( 8 ); // $ExpectType number
+}
+
+// The function returns an ndarray if provided an array-like object...
+{
+	const x = new Float64Array( 10 );
+
+	abs( x ); // $ExpectType ndarray
+}
+
+// The function returns an ndarray if provided an ndarray...
+{
+	const buf = [ 1, 2, 3, 4 ];
+
+	const x = {
+		'byteLength': null,
+		'BYTES_PER_ELEMENT': null,
+		'data': buf,
+		'dtype': 'generic',
+		'flags': {
+			'ROW_MAJOR_CONTIGUOUS': true,
+			'COLUMN_MAJOR_CONTIGUOUS': false
+		},
+		'length': 4,
+		'ndims': 1,
+		'offset': 0,
+		'order': 'row-major',
+		'shape': [ 4 ],
+		'strides': [ 1 ],
+		'get': ( i: number ): number => {
+			return buf[ i ];
+		},
+		'set': ( i: number, v: number ): void => {
+			buf[ i ] = v;
+		}
+	};
+
+	abs( x ); // $ExpectType ndarray
+}
+
+// The function does not compile if provided a value other than an ndarray, array-like object, or number...
+{
+	abs( true ); // $ExpectError
+	abs( false ); // $ExpectError
+	abs( null ); // $ExpectError
+	abs( undefined ); // $ExpectError
+	abs( {} ); // $ExpectError
+}
+
+// The function does not compile if provided insufficient arguments...
+{
+	abs(); // $ExpectError
+}