@stdlib/math-base-special-log1p - npm Package Compare versions

Comparing version 0.0.6 to 0.1.0

docs/types/index.d.ts

@@ -19,3 +19,3 @@ /*
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
@@ -22,0 +22,0 @@ /**

lib/index.js

@@ -50,3 +50,3 @@ /**
 
-var log1p = require( './log1p.js' );
+var log1p = require( './main.js' );
 
@@ -53,0 +53,0 @@

lib/polyval_lp.js

 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* Copyright (c) 2022 The Stdlib Authors.
 *
@@ -33,3 +33,2 @@ * Licensed under the Apache License, Version 2.0 (the "License");
 *
-*
 * @private
@@ -36,0 +35,0 @@ * @param {number} x - value at which to evaluate the polynomial

package.json

 {
   "name": "@stdlib/math-base-special-log1p",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "description": "Evaluate the natural logarithm of 1+x.",
@@ -21,4 +21,6 @@ "license": "Apache-2.0",
     "example": "./examples",
+    "include": "./include",
     "lib": "./lib",
     "scripts": "./scripts",
+    "src": "./src",
     "test": "./test"
@@ -42,23 +44,32 @@ },
   "dependencies": {
-    "@stdlib/constants-float64-exponent-bias": "^0.0.x",
-    "@stdlib/constants-float64-ninf": "^0.0.x",
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/number-float64-base-get-high-word": "^0.0.x",
-    "@stdlib/number-float64-base-set-high-word": "^0.0.x"
+    "@stdlib/constants-float64-exponent-bias": "^0.1.0",
+    "@stdlib/constants-float64-ninf": "^0.1.0",
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-napi-unary": "^0.1.0",
+    "@stdlib/number-float64-base-get-high-word": "^0.1.0",
+    "@stdlib/number-float64-base-set-high-word": "^0.1.0",
+    "@stdlib/utils-library-manifest": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-base-incrspace": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-float64-eps": "^0.0.x",
-    "@stdlib/fs-write-file": "^0.0.x",
-    "@stdlib/math-base-assert-is-negative-zero": "^0.0.x",
-    "@stdlib/math-base-special-abs": "^0.0.x",
-    "@stdlib/math-base-special-ln": "^0.0.x",
-    "@stdlib/math-base-special-round": "^0.0.x",
-    "@stdlib/math-base-tools-evalpoly-compile": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/array-base-incrspace": "^0.0.2",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/constants-float64-eps": "^0.1.0",
+    "@stdlib/fs-read-file": "^0.1.0",
+    "@stdlib/fs-write-file": "^0.1.0",
+    "@stdlib/math-base-assert-is-negative-zero": "^0.1.0",
+    "@stdlib/math-base-special-abs": "^0.0.6",
+    "@stdlib/math-base-special-ln": "^0.0.6",
+    "@stdlib/math-base-special-round": "^0.1.0",
+    "@stdlib/math-base-tools-evalpoly-compile": "^0.0.8",
+    "@stdlib/math-base-tools-evalpoly-compile-c": "^0.0.1",
+    "@stdlib/random-base-randu": "^0.0.8",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/string-substring-after": "^0.0.2",
+    "@stdlib/string-substring-before": "^0.1.0",
+    "@stdlib/time-current-year": "^0.1.0",
+    "@stdlib/utils-try-require": "^0.1.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"
   },
@@ -97,5 +108,5 @@ "engines": {
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

README.md

@@ -5,3 +5,3 @@ <!--
 
-Copyright (c) 2018 The Stdlib Authors.
+Copyright (c) 2022 The Stdlib Authors.
 
@@ -22,2 +22,13 @@ Licensed under the Apache License, Version 2.0 (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>
+
 # log1p
@@ -106,2 +117,92 @@
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- 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">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/math/base/special/log1p.h"
+```
+
+#### stdlib_base_log1p( x )
+
+Evaluates the [natural logarithm][@stdlib/math/base/special/ln] of `1+x`.
+
+```c
+double out = stdlib_base_log1p( 4.0 );
+// returns ~1.609
+
+out = stdlib_base_log1p( -1.0 );
+// returns -Infinity
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] double` input value.
+
+```c
+double stdlib_base_log1p( const double x );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/math/base/special/log1p.h"
+#include <stdlib.h>
+#include <stdio.h>
+
+int main( void ) {
+    double x;
+    double v;
+    int i;
+    
+    for ( i = 0; i < 100; i++ ) {
+        x = ( (double)rand() / (double)RAND_MAX ) * 100.0;
+        v = stdlib_base_log1p( x );
+        printf( "log1p(%lf) = %lf\n", x, v );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
@@ -115,4 +216,4 @@
 
--   <span class="package-name">[`@stdlib/math/base/special/ln`][@stdlib/math/base/special/ln]</span><span class="delimiter">: </span><span class="description">natural logarithm.</span>
--   <span class="package-name">[`@stdlib/math/base/special/log`][@stdlib/math/base/special/log]</span><span class="delimiter">: </span><span class="description">base `b` logarithm.</span>
+-   <span class="package-name">[`@stdlib/math-base/special/ln`][@stdlib/math/base/special/ln]</span><span class="delimiter">: </span><span class="description">natural logarithm.</span>
+-   <span class="package-name">[`@stdlib/math-base/special/log`][@stdlib/math/base/special/log]</span><span class="delimiter">: </span><span class="description">base `b` logarithm.</span>
 
@@ -142,10 +243,5 @@ </section>
 
-## License
-
-See [LICENSE][stdlib-license].
-
-
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
@@ -163,4 +259,4 @@ </section>
 
-[test-image]: https://github.com/stdlib-js/math-base-special-log1p/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/math-base-special-log1p/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/math-base-special-log1p/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/math-base-special-log1p/actions/workflows/test.yml?query=branch:v0.1.0
 
@@ -177,2 +273,9 @@ [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-log1p/main.svg
 
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[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
@@ -184,12 +287,4 @@ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 [esm-url]: https://github.com/stdlib-js/math-base-special-log1p/tree/esm
+[branches-url]: https://github.com/stdlib-js/math-base-special-log1p/blob/main/branches.md
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
-
-[stdlib]: https://github.com/stdlib-js/stdlib
-
-[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
-[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-log1p/main/LICENSE
-
 <!-- <related-links> -->
@@ -196,0 +291,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

69840

increased by49.03%

Number of package files

18

increased by80%

Lines of code

631

increased by22.76%

Number of lines in readme file

293

increased by47.98%

Worsened metrics

Dependency count

8

increased by33.33%

Dev dependency count

20

increased by53.85%

Number of low quality alerts

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@stdlib/math-base-napi-unary@^0.1.0

• + Added@stdlib/utils-library-manifest@^0.1.0

• + Added@stdlib/array-float32@0.1.1(transitive)

• + Added@stdlib/array-float64@0.1.1(transitive)

• + Added@stdlib/array-uint16@0.1.1(transitive)

• + Added@stdlib/array-uint32@0.1.1(transitive)

• + Added@stdlib/array-uint8@0.1.1(transitive)

• + Added@stdlib/assert-has-float32array-support@0.1.1(transitive)

• + Added@stdlib/assert-has-float64array-support@0.1.1(transitive)

• + Added@stdlib/assert-has-own-property@0.1.1(transitive)

• + Added@stdlib/assert-has-symbol-support@0.1.1(transitive)

• + Added@stdlib/assert-has-tostringtag-support@0.1.1(transitive)

• + Added@stdlib/assert-has-uint16array-support@0.1.1(transitive)

• + Added@stdlib/assert-has-uint32array-support@0.1.1(transitive)

• + Added@stdlib/assert-has-uint8array-support@0.1.1(transitive)

• + Added@stdlib/assert-is-array@0.1.1(transitive)

• + Added@stdlib/assert-is-big-endian@0.1.1(transitive)

• + Added@stdlib/assert-is-boolean@0.1.1(transitive)

• + Added@stdlib/assert-is-buffer@0.1.1(transitive)

• + Added@stdlib/assert-is-float32array@0.1.1(transitive)

• + Added@stdlib/assert-is-float64array@0.1.1(transitive)

• + Added@stdlib/assert-is-function@0.1.1(transitive)

• + Added@stdlib/assert-is-little-endian@0.1.1(transitive)

• + Added@stdlib/assert-is-number@0.1.1(transitive)

• + Added@stdlib/assert-is-object@0.1.1(transitive)

• + Added@stdlib/assert-is-object-like@0.1.1(transitive)

• + Added@stdlib/assert-is-plain-object@0.1.1(transitive)

• + Added@stdlib/assert-is-regexp@0.1.1(transitive)

• + Added@stdlib/assert-is-string@0.1.1(transitive)

• + Added@stdlib/assert-is-uint16array@0.1.1(transitive)

• + Added@stdlib/assert-is-uint32array@0.1.1(transitive)

• + Added@stdlib/assert-is-uint8array@0.1.1(transitive)

• + Added@stdlib/assert-tools-array-function@0.1.1(transitive)

• + Added@stdlib/boolean-ctor@0.1.1(transitive)

• + Added@stdlib/complex-float32@0.1.1(transitive)

• + Added@stdlib/complex-float64@0.1.1(transitive)

• + Added@stdlib/complex-reim@0.1.1(transitive)

• + Added@stdlib/complex-reimf@0.1.1(transitive)

• + Added@stdlib/constants-float64-exponent-bias@0.1.1(transitive)

• + Added@stdlib/constants-float64-ninf@0.1.1(transitive)

• + Added@stdlib/constants-float64-pinf@0.1.1(transitive)

• + Added@stdlib/constants-uint16-max@0.1.1(transitive)

• + Added@stdlib/constants-uint32-max@0.1.1(transitive)

• + Added@stdlib/constants-uint8-max@0.1.1(transitive)

• + Added@stdlib/error-tools-fmtprodmsg@0.1.1(transitive)

• + Added@stdlib/fs-exists@0.1.1(transitive)

• + Added@stdlib/fs-resolve-parent-path@0.1.1(transitive)

• + Added@stdlib/math-base-assert-is-nan@0.1.1(transitive)

• + Added@stdlib/math-base-napi-unary@0.1.1(transitive)

• + Added@stdlib/number-ctor@0.1.1(transitive)

• + Added@stdlib/number-float64-base-get-high-word@0.1.1(transitive)

• + Added@stdlib/number-float64-base-set-high-word@0.1.1(transitive)

• + Added@stdlib/number-float64-base-to-float32@0.1.1(transitive)

• + Added@stdlib/number-float64-base-to-words@0.1.1(transitive)

• + Added@stdlib/object-ctor@0.1.1(transitive)

• + Added@stdlib/os-byte-order@0.1.1(transitive)

• + Added@stdlib/os-float-word-order@0.1.1(transitive)

• + Added@stdlib/process-cwd@0.1.1(transitive)

• + Added@stdlib/regexp-extended-length-path@0.1.1(transitive)

• + Added@stdlib/regexp-function-name@0.1.1(transitive)

• + Added@stdlib/string-base-format-interpolate@0.1.1(transitive)

• + Added@stdlib/string-base-format-tokenize@0.1.1(transitive)

• + Added@stdlib/string-base-lowercase@0.2.1(transitive)

• + Added@stdlib/string-base-replace@0.1.1(transitive)

• + Added@stdlib/string-format@0.1.1(transitive)

• + Added@stdlib/string-replace@0.1.1(transitive)

• + Added@stdlib/symbol-ctor@0.1.1(transitive)

• + Added@stdlib/types@0.1.0(transitive)

• + Added@stdlib/utils-constructor-name@0.1.1(transitive)

• + Added@stdlib/utils-convert-path@0.1.1(transitive)

• + Added@stdlib/utils-define-nonenumerable-read-only-property@0.1.1(transitive)

• + Added@stdlib/utils-define-property@0.1.1(transitive)

• + Added@stdlib/utils-escape-regexp-string@0.1.1(transitive)

• + Added@stdlib/utils-get-prototype-of@0.1.1(transitive)

• + Added@stdlib/utils-global@0.1.1(transitive)

• + Added@stdlib/utils-library-manifest@0.1.1(transitive)

• + Added@stdlib/utils-native-class@0.1.1(transitive)

• + Added@stdlib/utils-type-of@0.1.2(transitive)

• - Removed@stdlib/array-float64@0.0.6(transitive)

• - Removed@stdlib/array-uint16@0.0.6(transitive)

• - Removed@stdlib/array-uint32@0.0.6(transitive)

• - Removed@stdlib/array-uint8@0.0.7(transitive)

• - Removed@stdlib/assert-has-float64array-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-node-buffer-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-own-property@0.0.7(transitive)

• - Removed@stdlib/assert-has-symbol-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-tostringtag-support@0.0.9(transitive)

• - Removed@stdlib/assert-has-uint16array-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-uint32array-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-uint8array-support@0.0.8(transitive)

• - Removed@stdlib/assert-is-array@0.0.7(transitive)

• - Removed@stdlib/assert-is-big-endian@0.0.7(transitive)

• - Removed@stdlib/assert-is-boolean@0.0.8(transitive)

• - Removed@stdlib/assert-is-buffer@0.0.8(transitive)

• - Removed@stdlib/assert-is-float64array@0.0.8(transitive)

• - Removed@stdlib/assert-is-function@0.0.8(transitive)

• - Removed@stdlib/assert-is-little-endian@0.0.7(transitive)

• - Removed@stdlib/assert-is-object@0.0.8(transitive)

• - Removed@stdlib/assert-is-object-like@0.0.8(transitive)

• - Removed@stdlib/assert-is-plain-object@0.0.7(transitive)

• - Removed@stdlib/assert-is-regexp@0.0.7(transitive)

• - Removed@stdlib/assert-is-regexp-string@0.0.9(transitive)

• - Removed@stdlib/assert-is-string@0.0.8(transitive)

• - Removed@stdlib/assert-is-uint16array@0.0.8(transitive)

• - Removed@stdlib/assert-is-uint32array@0.0.8(transitive)

• - Removed@stdlib/assert-is-uint8array@0.0.8(transitive)

• - Removed@stdlib/assert-tools-array-function@0.0.7(transitive)

• - Removed@stdlib/buffer-ctor@0.0.7(transitive)

• - Removed@stdlib/buffer-from-string@0.0.8(transitive)

• - Removed@stdlib/cli-ctor@0.0.3(transitive)

• - Removed@stdlib/constants-float64-exponent-bias@0.0.8(transitive)

• - Removed@stdlib/constants-float64-ninf@0.0.8(transitive)

• - Removed@stdlib/constants-float64-pinf@0.0.8(transitive)

• - Removed@stdlib/constants-uint16-max@0.0.7(transitive)

• - Removed@stdlib/constants-uint32-max@0.0.7(transitive)

• - Removed@stdlib/constants-uint8-max@0.0.7(transitive)

• - Removed@stdlib/fs-exists@0.0.8(transitive)

• - Removed@stdlib/fs-read-file@0.0.8(transitive)

• - Removed@stdlib/fs-resolve-parent-path@0.0.8(transitive)

• - Removed@stdlib/math-base-assert-is-nan@0.0.8(transitive)

• - Removed@stdlib/number-ctor@0.0.7(transitive)

• - Removed@stdlib/number-float64-base-get-high-word@0.0.6(transitive)

• - Removed@stdlib/number-float64-base-set-high-word@0.0.6(transitive)

• - Removed@stdlib/number-float64-base-to-words@0.0.7(transitive)

• - Removed@stdlib/os-byte-order@0.0.7(transitive)

• - Removed@stdlib/os-float-word-order@0.0.7(transitive)

• - Removed@stdlib/process-cwd@0.0.8(transitive)

• - Removed@stdlib/process-read-stdin@0.0.7(transitive)

• - Removed@stdlib/regexp-eol@0.0.7(transitive)

• - Removed@stdlib/regexp-extended-length-path@0.0.7(transitive)

• - Removed@stdlib/regexp-function-name@0.0.7(transitive)

• - Removed@stdlib/regexp-regexp@0.0.8(transitive)

• - Removed@stdlib/streams-node-stdin@0.0.7(transitive)

• - Removed@stdlib/string-base-format-interpolate@0.0.4(transitive)

• - Removed@stdlib/string-base-format-tokenize@0.0.4(transitive)

• - Removed@stdlib/string-format@0.0.3(transitive)

• - Removed@stdlib/string-lowercase@0.0.9(transitive)

• - Removed@stdlib/string-replace@0.0.11(transitive)

• - Removed@stdlib/types@0.0.14(transitive)

• - Removed@stdlib/utils-constructor-name@0.0.8(transitive)

• - Removed@stdlib/utils-convert-path@0.0.8(transitive)

• - Removed@stdlib/utils-define-nonenumerable-read-only-property@0.0.7(transitive)

• - Removed@stdlib/utils-define-property@0.0.9(transitive)

• - Removed@stdlib/utils-escape-regexp-string@0.0.9(transitive)

• - Removed@stdlib/utils-get-prototype-of@0.0.7(transitive)

• - Removed@stdlib/utils-global@0.0.7(transitive)

• - Removed@stdlib/utils-library-manifest@0.0.8(transitive)

• - Removed@stdlib/utils-native-class@0.0.8(transitive)

• - Removed@stdlib/utils-next-tick@0.0.8(transitive)

• - Removed@stdlib/utils-noop@0.0.14(transitive)

• - Removed@stdlib/utils-regexp-from-string@0.0.9(transitive)

• - Removed@stdlib/utils-type-of@0.0.8(transitive)

• - Removedminimist@1.2.8(transitive)

• Updated@stdlib/constants-float64-exponent-bias@^0.1.0

• Updated@stdlib/constants-float64-ninf@^0.1.0

• Updated@stdlib/constants-float64-pinf@^0.1.0

• Updated@stdlib/math-base-assert-is-nan@^0.1.0

• Updated@stdlib/number-float64-base-get-high-word@^0.1.0

• Updated@stdlib/number-float64-base-set-high-word@^0.1.0