@stdlib/math-base-special-abs 0.0.5 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/LICENSE

@@ -175,307 +175,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by this
-license (the "Software") to use, reproduce, display, distribute, execute, and
-transmit the Software, and to prepare derivative works of the Software, and to
-permit third-parties to whom the Software is furnished to do so, all subject to
-the following:
-
-The copyright notices in the Software and this entire statement, including the
-above license grant, this restriction and the following disclaimer, must be
-included in all copies of the Software, in whole or in part, and all derivative
-works of the Software, unless such copies or derivative works are solely in the
-form of machine-executable object code generated by a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
-OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
-OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-
-
-DEPENDENCIES
-
-The library links against the following external libraries, which have their own
-licenses:
-
-* OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
-def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
-
-Copyright (c) 2011-2014, The OpenBLAS Project
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   1. Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-   2. Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in
-      the documentation and/or other materials provided with the
-      distribution.
-
-   3. Neither the name of the OpenBLAS project nor the names of
-      its contributors may be used to endorse or promote products
-      derived from this software without specific prior written
-      permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
-THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* Electron <https://raw.githubusercontent.com/electron/electron/
-c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
-
-Copyright (c) 2013-2017 GitHub Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* Boost <http://www.boost.org/LICENSE_1_0.txt>
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by
-this license (the "Software") to use, reproduce, display, distribute,
-execute, and transmit the Software, and to prepare derivative works of the
-Software, and to permit third-parties to whom the Software is furnished to
-do so, all subject to the following:
-
-The copyright notices in the Software and this entire statement, including
-the above license grant, this restriction and the following disclaimer,
-must be included in all copies of the Software, in whole or in part, and
-all derivative works of the Software, unless such copies or derivative
-works are solely in the form of machine-executable object code generated by
-a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
-
-
-* Cephes <http://www.netlib.org/cephes/readme>
-
-Copyright (c) 1984-2000 Stephen L. Moshier
-
-Some software in this archive may be from the book _Methods and Programs for
-Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989)
-or from the Cephes Mathematical Library, a commercial product. In either event,
-it is copyrighted by the author. What you see here may be used freely but it
-comes with no support or guarantee.
-
-Stephen L. Moshier
-moshier@na-net.ornl.gov
-
-
-
-ATTRIBUTION
-
-The library contains implementations from the following external libraries,
-which have their own licenses:
-
-* FreeBSD <https://svnweb.freebsd.org/>
-
-Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* FDLIBM <http://www.netlib.org/fdlibm/>
-
-Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
-
-Copyright (c) 2009 The Go Authors. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Google Inc. nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
-
-Public domain.
-
-
-* ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
-
-Copyright JS Foundation and other contributors, https://js.foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-
-* StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
-e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
-
-Copyright (c) 2015: Dahua Lin.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
-SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
-
-The MIT License (MIT)
-
-Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
-
-https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-* MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
-mt19937ar.c>
-
-Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
- 1. Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
-
- 3. The names of its contributors may not be used to endorse or promote
-    products derived from this software without specific prior written
-    permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,9 +18,20 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # Absolute Value
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > Compute the [absolute value][absolute-value] of a double-precision floating-point number.
 
@@ -31,7 +42,7 @@ 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="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/lib/node_modules/@stdlib/math/base/special/abs/docs/img/equation_absolute_value.svg" alt="Absolute value">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/C:\Users\pb\Documents\GitHub\stdlib\lib\node_modules\@stdlib\math\base\special\abs\docs\img\equation_absolute_value.svg" alt="Absolute value">
     <br>
 </div>
 
@@ -126,16 +137,6 @@ for ( i = 0; i < 100; i++ ) {
 
 <!-- C usage documentation. -->
 
-<section class="installation">
-
-## Installation
-
-```bash
-npm install @stdlib/math-base-special-abs
-```
-
-</section>
-
 <section class="usage">
 
 ### Usage
@@ -183,8 +184,8 @@ double stdlib_base_abs( const double x );
 #include "stdlib/math/base/special/abs.h"
 #include <stdio.h>
 
-int main() {
-    double x[] = { 3.14, -3.14, 0.0, 0.0/0.0 };
+int main( void ) {
+    const double x[] = { 3.14, -3.14, 0.0, 0.0/0.0 };
 
     double y;
     int i;
@@ -203,6 +204,24 @@ int main() {
 
 <!-- /.c -->
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math-base/special/abs2`][@stdlib/math/base/special/abs2]</span><span class="delimiter">: </span><span class="description">compute the squared absolute value of a double-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/math-base/special/absf`][@stdlib/math/base/special/absf]</span><span class="delimiter">: </span><span class="description">compute the absolute value of a single-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/math-base/special/labs`][@stdlib/math/base/special/labs]</span><span class="delimiter">: </span><span class="description">compute an absolute value of a signed 32-bit integer.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
 
 <section class="main-repo" >
 
@@ -227,7 +246,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -240,26 +259,48 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-abs.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-abs
 
-[test-image]: https://github.com/stdlib-js/math-base-special-abs/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/math-base-special-abs/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/math-base-special-abs/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/math-base-special-abs/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-abs/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-abs?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-special-abs.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/math-base-special-abs/main
 
+-->
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
 
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/math-base-special-abs/tree/deno
+[umd-url]: https://github.com/stdlib-js/math-base-special-abs/tree/umd
+[esm-url]: https://github.com/stdlib-js/math-base-special-abs/tree/esm
+[branches-url]: https://github.com/stdlib-js/math-base-special-abs/blob/main/branches.md
+
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-abs/main/LICENSE
 
 [absolute-value]: https://en.wikipedia.org/wiki/Absolute_value
 
+<!-- <related-links> -->
+
+[@stdlib/math/base/special/abs2]: https://www.npmjs.com/package/@stdlib/math-base-special-abs2
+
+[@stdlib/math/base/special/absf]: https://www.npmjs.com/package/@stdlib/math-base-special-absf
+
+[@stdlib/math/base/special/labs]: https://www.npmjs.com/package/@stdlib/math-base-special-labs
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import abs from '../docs/types/index';
+export = abs;

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";var a=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var e=a(function(c,s){
+function i(t){return Math.abs(t)}s.exports=i
+});var u=e();module.exports=u;
+/** @license Apache-2.0 */
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2021 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Computes the absolute value of a double-precision floating-point number `x`.\n*\n* @param {number} x - input value\n* @returns {number} absolute value\n*\n* @example\n* var v = abs( -1.0 );\n* // returns 1.0\n*\n* @example\n* var v = abs( 2.0 );\n* // returns 2.0\n*\n* @example\n* var v = abs( 0.0 );\n* // returns 0.0\n*\n* @example\n* var v = abs( -0.0 );\n* // returns 0.0\n*\n* @example\n* var v = abs( NaN );\n* // returns NaN\n*/\nfunction abs( x ) {\n\treturn Math.abs( x ); // eslint-disable-line stdlib/no-builtin-math\n}\n\n\n// EXPORTS //\n\nmodule.exports = abs;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute an absolute value of a double-precision floating-point number.\n*\n* @module @stdlib/math-base-special-abs\n*\n* @example\n* var abs = require( '@stdlib/math-base-special-abs' );\n*\n* var v = abs( -1.0 );\n* // returns 1.0\n*\n* v = abs( 2.0 );\n* // returns 2.0\n*\n* v = abs( 0.0 );\n* // returns 0.0\n*\n* v = abs( -0.0 );\n* // returns 0.0\n*\n* v = abs( NaN );\n* // returns NaN\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAgDA,SAASC,EAAKC,EAAI,CACjB,OAAO,KAAK,IAAKA,CAAE,CACpB,CAKAF,EAAO,QAAUC,ICTjB,IAAIE,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "abs", "x", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Computes the absolute value of double-precision floating-point number `x`.

package/lib/abs.js

@@ -22,6 +22,7 @@
 
 var Float64Array = require( '@stdlib/array-float64' );
 var Uint32Array = require( '@stdlib/array-uint32' );
+var ABS_MASK = require( '@stdlib/constants-float64-high-word-abs-mask' );
 var HIGH = require( './high.js' );
 
 
@@ -30,9 +31,6 @@ var HIGH = require( './high.js' );
 var FLOAT64_VIEW = new Float64Array( 1 );
 var UINT32_VIEW = new Uint32Array( FLOAT64_VIEW.buffer );
 
-// 0x7fffffff = 2147483647 => 0 11111111111 11111111111111111111
-var ABS_MASK = 0x7fffffff>>>0; // asm type annotation
-
 
 // MAIN //
 
@@ -70,7 +68,6 @@ var ABS_MASK = 0x7fffffff>>>0; // asm type annotation
 *
 * In which Uint32 can we find the higher order bits? If little endian, the second; if big endian, the first.
 *
-*
 * ## References
 *
 * -   [Open Group][1]

package/lib/index.js

@@ -44,9 +44,9 @@
 
 // MODULES //
 
-var abs = require( './main.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = abs;
+module.exports = main;

package/manifest.json

@@ -28,7 +28,7 @@
 		{
 			"task": "build",
 			"src": [
-				"./src/abs.c"
+				"./src/main.c"
 			],
 			"include": [
 				"./include"
@@ -37,13 +37,14 @@
 			"libpath": [],
 			"dependencies": [
 				"@stdlib/math-base-napi-unary",
-				"@stdlib/number-float64-base-to-words"
+				"@stdlib/constants-float64-high-word-abs-mask",
+        "@stdlib/number-float64-base-to-words"
 			]
 		},
 		{
 			"task": "benchmark",
 			"src": [
-				"./src/abs.c"
+				"./src/main.c"
 			],
 			"include": [
 				"./include"
@@ -51,13 +52,14 @@
 			"libraries": [],
 			"libpath": [],
 			"dependencies": [
-				"@stdlib/number-float64-base-to-words"
+				"@stdlib/constants-float64-high-word-abs-mask",
+        "@stdlib/number-float64-base-to-words"
 			]
 		},
 		{
 			"task": "examples",
 			"src": [
-				"./src/abs.c"
+				"./src/main.c"
 			],
 			"include": [
 				"./include"
@@ -65,7 +67,8 @@
 			"libraries": [],
 			"libpath": [],
 			"dependencies": [
-				"@stdlib/number-float64-base-to-words"
+				"@stdlib/constants-float64-high-word-abs-mask",
+        "@stdlib/number-float64-base-to-words"
 			]
 		}
 	]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/math-base-special-abs",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Compute the absolute value of a double-precision floating-point number.",
   "license": "Apache-2.0",
   "author": {
@@ -40,27 +40,28 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-napi-unary": "^0.0.x",
-    "@stdlib/number-float64-base-to-words": "^0.0.x",
-    "@stdlib/utils-library-manifest": "^0.0.x"
+    "@stdlib/constants-float64-high-word-abs-mask": "^0.1.0",
+    "@stdlib/math-base-napi-unary": "^0.1.0",
+    "@stdlib/number-float64-base-to-words": "^0.1.0",
+    "@stdlib/utils-library-manifest": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-float64": "^0.0.x",
-    "@stdlib/array-uint32": "^0.0.x",
-    "@stdlib/assert-is-little-endian": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-float64-ninf": "^0.0.x",
-    "@stdlib/constants-float64-pi": "^0.0.x",
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-assert-is-positive-zero": "^0.0.x",
-    "@stdlib/math-base-special-round": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
-    "@stdlib/utils-try-require": "^0.0.x",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/array-uint32": "^0.1.0",
+    "@stdlib/assert-is-little-endian": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/constants-float64-ninf": "^0.1.0",
+    "@stdlib/constants-float64-pi": "^0.1.0",
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-assert-is-positive-zero": "^0.1.0",
+    "@stdlib/math-base-special-round": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.0.8",
+    "@stdlib/utils-try-require": "^0.1.0",
     "proxyquire": "^2.0.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -91,9 +92,91 @@
     "double",
     "double-precision"
   ],
-  "__stdlib__": {},
+  "__stdlib__": {
+    "stability": "stable",
+    "envs": {
+      "node": true,
+      "browser": true,
+      "repl": true
+    },
+    "namespaces": {
+      "repl": true,
+      "parent": false
+    },
+    "namespace": false,
+    "standalone": true,
+    "c_api": true,
+    "addon": false,
+    "wasm": false,
+    "cli": false,
+    "benchmarks": {
+      "c": true,
+      "cephes": true,
+      "cpp": false,
+      "boost": false,
+      "fortran": false,
+      "python": true,
+      "numpy": false,
+      "scipy": false,
+      "r": true,
+      "julia": true,
+      "js": true
+    },
+    "examples": {
+      "c": true,
+      "cpp": false,
+      "fortran": false,
+      "js": true
+    },
+    "dtype": "float64",
+    "base_alias": "abs",
+    "alias": "abs",
+    "short_desc": "absolute value",
+    "link_text": "absolute value",
+    "domain": [
+      {
+        "min": "-infinity",
+        "max": "infinity"
+      }
+    ],
+    "rand": {
+      "min": -10,
+      "max": 10
+    },
+    "keywords": [
+      "absolute",
+      "value",
+      "abs",
+      "magnitude"
+    ],
+    "extra_keywords": [
+      "math.abs"
+    ],
+    "example_values": [
+      -2,
+      1,
+      3,
+      -5,
+      4,
+      0,
+      -1,
+      -3,
+      -3.14,
+      5.6,
+      -9,
+      -5.55,
+      3.5,
+      10,
+      -9.99,
+      3,
+      -6,
+      -7,
+      8,
+      -7.77
+    ]
+  },
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/src/{abs.c → main.c}

@@ -17,11 +17,9 @@
 */
 
 #include "stdlib/math/base/special/abs.h"
+#include "stdlib/constants/float64/high_word_abs_mask.h"
 #include "stdlib/number/float64/base/to_words.h"
 
-// 0x7fffffff = 2147483647 => 0 11111111111 11111111111111111111
-static const uint32_t ABS_MASK = 2147483647;
-
 /**
 * Computes the absolute value of a double-precision floating-point number.
 *
@@ -35,6 +33,6 @@ static const uint32_t ABS_MASK = 2147483647;
 double stdlib_base_abs( const double x ) {
 	stdlib_base_float64_words_t w;
 	w.value = x;
-	w.words.high &= ABS_MASK;
+	w.words.high &= STDLIB_CONSTANT_FLOAT64_HIGH_WORD_ABS_MASK;
 	return w.value;
 }

package/binding.gyp

@@ -1,170 +0,0 @@
-# @license Apache-2.0
-#
-# Copyright (c) 2018 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.
-
-# A `.gyp` file for building a Node.js native add-on.
-#
-# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
-# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
-{
-  # List of files to include in this file:
-  'includes': [
-    './include.gypi',
-  ],
-
-  # Define variables to be used throughout the configuration for all targets:
-  'variables': {
-    # Target name should match the add-on export name:
-    'addon_target_name%': 'addon',
-
-    # Set variables based on the host OS:
-    'conditions': [
-      [
-        'OS=="win"',
-        {
-          # Define the object file suffix:
-          'obj': 'obj',
-        },
-        {
-          # Define the object file suffix:
-          'obj': 'o',
-        }
-      ], # end condition (OS=="win")
-    ], # end conditions
-  }, # end variables
-
-  # Define compile targets:
-  'targets': [
-
-    # Target to generate an add-on:
-    {
-      # The target name should match the add-on export name:
-      'target_name': '<(addon_target_name)',
-
-      # Define dependencies:
-      'dependencies': [],
-
-      # Define directories which contain relevant include headers:
-      'include_dirs': [
-        # Local include directory:
-        '<@(include_dirs)',
-      ],
-
-      # List of source files:
-      'sources': [
-        '<@(src_files)',
-      ],
-
-      # Settings which should be applied when a target's object files are used as linker input:
-      'link_settings': {
-        # Define libraries:
-        'libraries': [
-          '<@(libraries)',
-        ],
-
-        # Define library directories:
-        'library_dirs': [
-          '<@(library_dirs)',
-        ],
-      },
-
-      # C/C++ compiler flags:
-      'cflags': [
-        # Enable commonly used warning options:
-        '-Wall',
-
-        # Aggressive optimization:
-        '-O3',
-      ],
-
-      # C specific compiler flags:
-      'cflags_c': [
-        # Specify the C standard to which a program is expected to conform:
-        '-std=c99',
-      ],
-
-      # C++ specific compiler flags:
-      'cflags_cpp': [
-        # Specify the C++ standard to which a program is expected to conform:
-        '-std=c++11',
-      ],
-
-      # Linker flags:
-      'ldflags': [],
-
-      # Apply conditions based on the host OS:
-      'conditions': [
-        [
-          'OS=="mac"',
-          {
-            # Linker flags:
-            'ldflags': [
-              '-undefined dynamic_lookup',
-              '-Wl,-no-pie',
-              '-Wl,-search_paths_first',
-            ],
-          },
-        ], # end condition (OS=="mac")
-        [
-          'OS!="win"',
-          {
-            # C/C++ flags:
-            'cflags': [
-              # Generate platform-independent code:
-              '-fPIC',
-            ],
-          },
-        ], # end condition (OS!="win")
-      ], # end conditions
-    }, # end target <(addon_target_name)
-
-    # Target to copy a generated add-on to a standard location:
-    {
-      'target_name': 'copy_addon',
-
-      # Declare that the output of this target is not linked:
-      'type': 'none',
-
-      # Define dependencies:
-      'dependencies': [
-        # Require that the add-on be generated before building this target:
-        '<(addon_target_name)',
-      ],
-
-      # Define a list of actions:
-      'actions': [
-        {
-          'action_name': 'copy_addon',
-          'message': 'Copying addon...',
-
-          # Explicitly list the inputs in the command-line invocation below:
-          'inputs': [],
-
-          # Declare the expected outputs:
-          'outputs': [
-            '<(addon_output_dir)/<(addon_target_name).node',
-          ],
-
-          # Define the command-line invocation:
-          'action': [
-            'cp',
-            '<(PRODUCT_DIR)/<(addon_target_name).node',
-            '<(addon_output_dir)/<(addon_target_name).node',
-          ],
-        },
-      ], # end actions
-    }, # end target copy_addon
-  ], # end targets
-}

package/docs/repl.txt

@@ -1,30 +0,0 @@
-
-{{alias}}( x )
-    Computes the absolute value of a double-precision floating-point number `x`.
-
-    Parameters
-    ----------
-    x: number
-        Input value.
-
-    Returns
-    -------
-    y: number
-        Absolute value.
-
-    Examples
-    --------
-    > var y = {{alias}}( -1.0 )
-    1.0
-    > y = {{alias}}( 2.0 )
-    2.0
-    > y = {{alias}}( 0.0 )
-    0.0
-    > y = {{alias}}( -0.0 )
-    0.0
-    > y = {{alias}}( NaN )
-    NaN
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,44 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2019 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...
-{
-	abs( 8 ); // $ExpectType number
-}
-
-// The function does not compile if provided a value other than a number...
-{
-	abs( true ); // $ExpectError
-	abs( false ); // $ExpectError
-	abs( null ); // $ExpectError
-	abs( undefined ); // $ExpectError
-	abs( '5' ); // $ExpectError
-	abs( [] ); // $ExpectError
-	abs( {} ); // $ExpectError
-	abs( ( x: number ): number => x ); // $ExpectError
-}
-
-// The function does not compile if provided insufficient arguments...
-{
-	abs(); // $ExpectError
-}