Skip to content

docs: update examples and fix whitespace #2865

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
merged 7 commits into from
Sep 7, 2024
Merged

docs: update examples and fix whitespace #2865

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a09a363
refactor: use discrete-uniform to generate random integers, style fixes
gunjjoshi Sep 6, 2024
525dc04
refactor: use discrete-uniform to generate random integers, style fixes
gunjjoshi Sep 6, 2024
22dfd08
refactor: use discrete-uniform to generate random integers, style fixes
gunjjoshi Sep 6, 2024
ad3f8ff
Merge branch 'stdlib-js:develop' into logf
gunjjoshi Sep 7, 2024
3b72beb
docs: use random/array/discrete-uniform in JS examples
gunjjoshi Sep 7, 2024
585abba
Apply suggestions from code review
kgryte Sep 7, 2024
4e26095
Apply suggestions from code review
kgryte Sep 7, 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
18 changes: 10 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/logf/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] of a single-precision floating-point number..
> Compute the base `b` [logarithm][logarithm] of a single-precision floating-point number.

<section class="usage">

Expand Down Expand Up @@ -66,18 +66,20 @@ v = logf( 2.0, -4.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var roundf = require( '@stdlib/math/base/special/roundf' );
var randu = require( '@stdlib/random/array/discrete-uniform' );
var logf = require( '@stdlib/math/base/special/logf' );

var b;
var x;
var opts = {
'dtype': 'float32'
};

var x = randu( 100, 0, 100, opts );
var b = randu( 100, 0, 5, opts );

var i;

for ( i = 0; i < 100; i++ ) {
x = roundf( randu() * 100.0 );
b = roundf( randu() * 5.0 );
console.log( 'logf( %d, %d ) = %d', x, b, logf( x, b ) );
console.log( 'logf( %d, %d ) = %d', x[ i ], b[ i ], logf( x[ i ], b[ i ] ) );
}
```

Expand Down
16 changes: 9 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/logf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var roundf = require( '@stdlib/math/base/special/roundf' );
var randu = require( '@stdlib/random/array/discrete-uniform' );
var logf = require( './../lib' );

var b;
var x;
var opts = {
'dtype': 'float32'
};

var x = randu( 100, 0, 100, opts );
var b = randu( 100, 0, 5, opts );

var i;

for ( i = 0; i < 100; i++ ) {
x = roundf( randu() * 100.0 );
b = roundf( randu() * 5.0 );
console.log( 'logf( %d, %d ) = %d', x, b, logf( x, b ) );
console.log( 'logf( %d, %d ) = %d', x[ i ], b[ i ], logf( x[ i ], b[ i ] ) );
}
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/logf/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
*
* @param x input value
* @param b input value
* @return output value
* @return output value
*
* @example
* float out = stdlib_base_logf( 100.0f, 10.0f );
Expand Down
Loading