Add README

Author: kgryte

lib/node_modules/@stdlib/math/special/abs/README.md

@@ -0,0 +1,166 @@
+<!--
+
+@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.
+
+-->
+
+# abs
+
+> Compute the [absolute value][absolute-value].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+The [absolute value][absolute-value] is defined as
+
+<!-- <equation class="equation" label="eq:absolute_value" align="center" raw="|x| = \begin{cases} x & \textrm{if}\ x \geq 0 \\ -x & \textrm{if}\ x < 0\end{cases}" alt="Absolute value"> -->
+
+<div class="equation" align="center" data-raw-text="|x| = \begin{cases} x &amp; \textrm{if}\ x \geq 0 \\ -x &amp; \textrm{if}\ x &lt; 0\end{cases}" data-equation="eq:absolute_value">
+    <img src="" alt="Absolute value">
+    <br>
+</div>
+
+<!-- </equation> -->
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var abs = require( '@stdlib/math/special/abs' );
+```
+
+#### abs( x )
+
+Computes the [absolute value][absolute-value]. 
+
+```javascript
+var y = abs( -1.0 );
+// returns 1.0
+```
+
+The function accepts the following arguments:
+
+-   `x`: input [`ndarray`][@stdlib/ndarray/ctor], array-like object, or number.
+
+If provided an [`ndarray`][@stdlib/ndarray/ctor] or array-like object, the function computes the [absolute value][absolute-value] for each element and returns an [`ndarray`][@stdlib/ndarray/ctor] having the same shape as `x` and containing element-wise results.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var array = require( '@stdlib/ndarray/array' );
+
+// Provide a typed array...
+var x = new Float64Array( [ -1.0, -2.0 ] );
+var y = abs( x );
+// returns <ndarray>
+
+var v = y.data;
+// returns <Float64Array>[ 1.0, 2.0 ]
+
+// Provide an ndarray...
+x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ); // 2x2
+y = abs( x );
+// returns <ndarray>
+
+v = y.get( 0, 1 );
+// returns 2.0
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var array = require( '@stdlib/ndarray/array' );
+var ind2sub = require( '@stdlib/ndarray/ind2sub' );
+var abs = require( '@stdlib/math/special/abs' );
+
+var sub;
+var sh;
+var x;
+var y;
+var i;
+
+// Provide a number...
+y = abs( -1.0 );
+console.log( 'x = %d => abs(x) = %d', -1.0, y );
+
+// Provide an array-like object...
+x = new Float64Array( [ -1.0, -2.0, -3.0 ] );
+y = abs( x );
+for ( i = 0; i < x.length; i++ ) {
+    console.log( 'x_%d = %d => abs(x_%d) = %d', i, x[ i ], i, y.iget( i ) );
+}
+
+// Provide an ndarray...
+x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
+sh = x.shape;
+
+y = abs( x );
+for ( i = 0; i < x.length; i++ ) {
+    sub = ind2sub( sh, i );
+    console.log( 'x_%d%d = %d => abs(x_%d%d) = %d', sub[ 0 ], sub[ 1 ], x.iget( i ), sub[ 0 ], sub[ 1 ], y.iget( i ) );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[absolute-value]: https://en.wikipedia.org/wiki/Absolute_value
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
+
+</section>
+
+<!-- /.links -->