Skip to content

Commit 75f9ecd

Browse files
committed
docs: update function description to improve clarity
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 3192ef5 commit 75f9ecd

File tree

9 files changed

+12
-11
lines changed

9 files changed

+12
-11
lines changed

lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# kernelLog1p
2222

23-
> Compute `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
23+
> Evaluate a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var kernelLog1p = require( '@stdlib/math/base/special/kernel-log1p' );
3232

3333
#### kernelLog1p( f )
3434

35-
Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
35+
Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
3636

3737
```javascript
3838
var v = kernelLog1p( 1.0 );
@@ -111,7 +111,7 @@ logEachMap( 'kernelLog1p(%0.4f) = %0.4f', x, kernelLog1p );
111111

112112
#### stdlib_base_kernel_log1p( f )
113113

114-
Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
114+
Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
115115

116116
```c
117117
double out = stdlib_base_kernel_log1p( 1.0 );

lib/node_modules/@stdlib/math/base/special/kernel-log1p/docs/repl.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11

22
{{alias}}( f )
3-
Computes `log(1+f) - f` for `1+f` in ~[sqrt(2)/2, sqrt(2)].
3+
Evaluates a correction term for double-precision base-2 and base-10
4+
logarithms when `1+f` is in `[√2/2, √2]`.
45

56
This function provides a common means for computing logarithms in base e.
67
Argument reduction and adding the final term of the polynomial must be done

lib/node_modules/@stdlib/math/base/special/kernel-log1p/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
22+
* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
2323
*
2424
* ## Notes
2525
*

lib/node_modules/@stdlib/math/base/special/kernel-log1p/include/stdlib/math/base/special/kernel_log1p.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ extern "C" {
2929
#endif
3030

3131
/**
32-
* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
32+
* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
3333
*/
3434
double stdlib_base_kernel_log1p( const double f );
3535

lib/node_modules/@stdlib/math/base/special/kernel-log1p/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Compute `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
22+
* Evaluate a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
2323
*
2424
* @module @stdlib/math/base/special/kernel-log1p
2525
*

lib/node_modules/@stdlib/math/base/special/kernel-log1p/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ var polyvalQ = require( './polyval_q.js' );
4141
// MAIN //
4242

4343
/**
44-
* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
44+
* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
4545
*
4646
* ## Method
4747
*

lib/node_modules/@stdlib/math/base/special/kernel-log1p/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
29+
* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
3030
*
3131
* @private
3232
* @param {number} f - input value

lib/node_modules/@stdlib/math/base/special/kernel-log1p/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/math/base/special/kernel-log1p",
33
"version": "0.0.0",
4-
"description": "Compute log(1+f) - f for 1+f in ~[sqrt(2)/2, sqrt(2)].",
4+
"description": "Evaluates a correction term for double-precision base-2 and base-10 logarithms when 1+f is in [√2/2, √2].",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

lib/node_modules/@stdlib/math/base/special/kernel-log1p/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ static double polyval_q( const double x ) {
7878
/* End auto-generated functions. */
7979

8080
/**
81-
* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
81+
* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
8282
*
8383
* ## Method
8484
*

0 commit comments

Comments
 (0)