Skip to content

docs: update function description in math/base/special/log #2808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Planeshifter merged 13 commits into from
Aug 18, 2024
Merged

docs: update function description in math/base/special/log #2808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0d03fda
docs: update function description
gunjjoshi Aug 18, 2024
d604a42
Update index.js
gunjjoshi Aug 18, 2024
7cf43d1
Update package.json
gunjjoshi Aug 18, 2024
96afdee
Update index.d.ts
gunjjoshi Aug 18, 2024
9fff10b
Update repl.txt
gunjjoshi Aug 18, 2024
9cd83ae
Update log.h
gunjjoshi Aug 18, 2024
a3df367
Update index.js
gunjjoshi Aug 18, 2024
b40d0b0
Update main.js
gunjjoshi Aug 18, 2024
2c641cb
Update native.js
gunjjoshi Aug 18, 2024
322d0dc
Update main.c
gunjjoshi Aug 18, 2024
4a57082
Update README.md
gunjjoshi Aug 18, 2024
e4a4b4d
Update package.json
gunjjoshi Aug 18, 2024
f82158a
Update lib/node_modules/@stdlib/math/base/special/log/README.md
Planeshifter Aug 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/math/base/special/log/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# Logarithm

> Compute the base `b` [logarithm][logarithm].
> Compute the base `b` [logarithm][logarithm] of a double-precision floating-point number.

<section class="usage">

Expand All @@ -32,7 +32,7 @@ var log = require( '@stdlib/math/base/special/log' );

#### log( x, b )

Computes the base `b` logarithm of `x`.
Computes the base `b` logarithm of a double-precision floating-point number.

```javascript
var v = log( 100.0, 10.0 );
Expand Down Expand Up @@ -113,7 +113,7 @@ for ( i = 0; i < 100; i++ ) {

#### stdlib_base_log( x, b )

Computes the base `b` logarithm of `x`.
Computes the base `b` logarithm of a double-precision floating-point number.

```c
double v = stdlib_base_log( 100.0, 10.0 );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

{{alias}}( x, b )
Computes the base `b` logarithm of `x`.
Computes the base `b` logarithm of a double-precision floating-point number.

For negative `b` or `x`, the function returns `NaN`.

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
// TypeScript Version: 4.1

/**
* Computes the base `b` logarithm of `x`.
* Computes the base `b` logarithm of a double-precision floating-point number.
*
* @param x - input value
* @param b - base
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log/include/stdlib/math/base/special/log.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ extern "C" {
#endif

/**
* Computes the base b logarithm of x.
* Computes the base `b` logarithm of a double-precision floating-point number.
*/
double stdlib_base_log( const double x, const double b );

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'use strict';

/**
* Compute the base `b` logarithm.
* Compute the base `b` logarithm of a double-precision floating-point number.
*
* @module @stdlib/math/base/special/log
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var ln = require( '@stdlib/math/base/special/ln' );
// MAIN //

/**
* Computes the base `b` logarithm of `x`.
* Computes the base `b` logarithm of a double-precision floating-point number.
*
* @param {NonNegativeNumber} x - input value
* @param {NonNegativeNumber} b - base
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
// MAIN //

/**
* Computes the base b logarithm of x.
* Computes the base `b` logarithm of a double-precision floating-point number.
*
* @private
* @param {number} x - input value
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/math/base/special/log",
"version": "0.0.0",
"description": "Base `b` logarithm.",
"description": "Compute the base `b` logarithm of a double-precision floating-point number.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#include "stdlib/math/base/special/ln.h"

/**
* Computes the base b logarithm of x.
* Computes the base `b` logarithm of a double-precision floating-point number.
*
* @param x input value
* @param b input value
Expand Down