Skip to content
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

refactor: update math/base/special/rcbrt #2189

Merged
merged 3 commits into from
Apr 19, 2024
Merged

refactor: update math/base/special/rcbrt #2189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b286e4e
refactor: use main.c, update examples and README heading
gunjjoshi Apr 19, 2024
9dc9f8e
Update index.js
gunjjoshi Apr 19, 2024
13d7c5f
remove newline
gunjjoshi Apr 19, 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
8 changes: 3 additions & 5 deletions lib/node_modules/@stdlib/math/base/special/rcbrt/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ limitations under the License.

-->

# Reciprocal Cube Root
# rcbrt

> Compute the reciprocal of the principal [cube root][cube-root] of a double-precision floating-point number.

Expand Down Expand Up @@ -86,15 +86,13 @@ v = rcbrt( Infinity );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var rcbrt = require( '@stdlib/math/base/special/rcbrt' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 );
x = discreteUniform( 0.0, 100.0 );
console.log( 'rcbrt(%d) = %d', x, rcbrt( x ) );
}
```
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/rcbrt/benchmark/benchmark.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ bench( pkg, function benchmark( b ) {

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*100000.0 ) - 0.0;
x = ( randu() * 100000.0 ) - 0.0;
y = rcbrt( x );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
Expand All @@ -64,7 +64,7 @@ bench( pkg+'::built-in', opts, function benchmark( b ) {

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*100000.0 ) - 0.0;
x = ( randu() * 100000.0 ) - 0.0;
y = 1.0 / Math.cbrt( x ); // eslint-disable-line stdlib/no-builtin-math
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/rcbrt/benchmark/benchmark.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ bench( pkg+'::native', opts, function benchmark( b ) {

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*100000.0 ) - 0.0;
x = ( randu() * 100000.0 ) - 0.0;
y = rcbrt( x );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/rcbrt/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
0.1
> y = {{alias}}( 0.0 )
Infinity
> y = {{alias}}( Infinity )
> y = {{alias}}( {{alias:@stdlib/constants/float64/pinf}} )
0.0
> y = {{alias}}( -8.0 )
-0.5
Expand Down
6 changes: 2 additions & 4 deletions lib/node_modules/@stdlib/math/base/special/rcbrt/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,12 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var rcbrt = require( './../lib' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 );
x = discreteUniform( 0.0, 100.0 );
console.log( 'rcbrt(%d) = %d', x, rcbrt( x ) );
}
18 changes: 6 additions & 12 deletions lib/node_modules/@stdlib/math/base/special/rcbrt/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,12 @@
{
"task": "build",
"src": [
"./src/rcbrt.c"
"./src/main.c"
],
"include": [
"./include"
],
"libraries": [
"-lm"
],
"libraries": [],
"libpath": [],
"dependencies": [
"@stdlib/math/base/napi/unary",
Expand All @@ -45,14 +43,12 @@
{
"task": "benchmark",
"src": [
"./src/rcbrt.c"
"./src/main.c"
],
"include": [
"./include"
],
"libraries": [
"-lm"
],
"libraries": [],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is likely fine, as we explicitly specify -lm in the make recipes.

"libpath": [],
"dependencies": [
"@stdlib/math/base/special/cbrt"
Expand All @@ -61,14 +57,12 @@
{
"task": "examples",
"src": [
"./src/rcbrt.c"
"./src/main.c"
],
"include": [
"./include"
],
"libraries": [
"-lm"
],
"libraries": [],
"libpath": [],
"dependencies": [
"@stdlib/math/base/special/cbrt"
Expand Down
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/math/base/special/rcbrt/src/addon.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@
#include "stdlib/math/base/special/rcbrt.h"
#include "stdlib/math/base/napi/unary.h"

// cppcheck-suppress shadowFunction
STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_rcbrt )
4 changes: 2 additions & 2 deletions ...tdlib/math/base/special/rcbrt/src/rcbrt.c → ...stdlib/math/base/special/rcbrt/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
/**
* Computes the reciprocal cube root of a double-precision floating-point number.
*
* @param x number
* @return reciprocal cube root
* @param x number
* @return reciprocal cube root
*
* @example
* double y = stdlib_base_rcbrt( 8.0 );
Expand Down
Loading
Loading