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.

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

adding bernoullif #6260

Closed
wants to merge 78 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
78 commits
Select commit Hold shift + click to select a range
d97c96a
adding bernoullif
Girish-Garg Mar 21, 2025
3d264b5
Update main.c
Girish-Garg Mar 22, 2025
2ec1aee
Update manifest.json
Girish-Garg Mar 22, 2025
a07a770
Update lib/node_modules/@stdlib/math/base/special/bernoullif/src/main.c
Girish-Garg Mar 22, 2025
60b9fb0
docs: add `d_x` example
kgryte Mar 21, 2025
74c56fc
docs: add `f_x` example
kgryte Mar 21, 2025
614f3ed
docs: update example
kgryte Mar 21, 2025
c219e91
docs: add `i_x` example
kgryte Mar 21, 2025
e638a3c
docs: add `u_x` example
kgryte Mar 21, 2025
b19173f
docs: add `k_x_as_i_x` example
kgryte Mar 21, 2025
6444785
docs: fix dtype
kgryte Mar 21, 2025
56a6aa0
docs: add `t_x_as_u_x` example
kgryte Mar 21, 2025
2d9de7f
docs: add `s_x` example
kgryte Mar 21, 2025
f5794fd
docs: add `c_x` example
kgryte Mar 21, 2025
ee88adf
docs: add `z_x` example
kgryte Mar 21, 2025
13c6893
docs: add `c_x_as_z_x` example
kgryte Mar 21, 2025
3329f19
docs: update descriptions
kgryte Mar 21, 2025
9bfb194
test: add 0d tests
kgryte Mar 21, 2025
37dfa2b
docs: fix related package
kgryte Mar 21, 2025
12a9a47
bench: update random value generation
hrshya Mar 21, 2025
578fc3a
bench: update random value generation
hrshya Mar 21, 2025
54760d9
bench: update random value generation
hrshya Mar 21, 2025
6857df4
fix: add missing index normalization and add associated tests
kgryte Mar 22, 2025
bf39593
docs: add note
kgryte Mar 22, 2025
66365e5
docs: add note and fix note
kgryte Mar 22, 2025
574c3b2
test: add tests
kgryte Mar 22, 2025
2a312f7
feat: add `array/base/fill-by`
kgryte Mar 22, 2025
fb987a5
feat: add `fillBy` to namespace
kgryte Mar 22, 2025
7855129
chore: fix EditorConfig lint errors
AlyAbdelmoneim Mar 21, 2025
7a95ad3
fix: address JavaScript lint errors
thedeeppp Mar 21, 2025
5b0608b
refactor: accommodate known array types for increased performance
kgryte Mar 22, 2025
c36f0c1
style: fix spacing
kgryte Mar 22, 2025
ee3e939
feat: add `ndarray/base/fill-by`
kgryte Mar 22, 2025
0245cac
feat: add `fillBy` to namespace
kgryte Mar 22, 2025
80d4ebb
fix: handle zero-dimensional ndarrays
kgryte Mar 22, 2025
447759d
feat: add `ndarray/fill`
kgryte Mar 22, 2025
788e3c8
fix: update type defn
kgryte Mar 22, 2025
216b43a
feat: add `fill` to namespace
kgryte Mar 22, 2025
f87a11e
feat: add `ndfill` to namespace
kgryte Mar 22, 2025
c837d99
chore: add TODO
kgryte Mar 22, 2025
445050b
bench: update random value generation
hrshya Mar 22, 2025
058fa94
bench: update random value generation
hrshya Mar 22, 2025
c437c73
bench: update random value generation
hrshya Mar 22, 2025
9ab86dd
docs: replace manual `for` loop in examples
anandkaranubc Mar 22, 2025
057c7e2
bench: update random value generation
hrshya Mar 22, 2025
da2d6f3
docs: update namespace table of contents
stdlib-bot Mar 22, 2025
f23d456
feat: update namespace TypeScript declarations
stdlib-bot Mar 22, 2025
0c13150
docs: update related packages sections
stdlib-bot Mar 22, 2025
99f97b8
bench: update random value generation
hrshya Mar 22, 2025
c573621
bench: update random value generation
hrshya Mar 22, 2025
b6b800b
bench: update random value generation
hrshya Mar 22, 2025
d9703e3
docs: add missing period
kgryte Mar 22, 2025
656ebef
remove: remove `ops` from namespace
gururaj1512 Mar 18, 2025
7d05007
refactor: update paths
gururaj1512 Mar 18, 2025
d191b20
remove: remove `math/base/ops`
gururaj1512 Mar 18, 2025
7b505d9
feat: add `constants/float32/apery`
Neerajpathak07 Mar 22, 2025
da10e0b
feat: add accessor protocol and refactor `stats/base/nanmskrange`
rahulptl165 Mar 22, 2025
62c26dd
feat: refactor and add protocol support to `stats/base/meanwd`
prajjwalbajpai Mar 22, 2025
61e23b0
docs: add examples for `string` and `float` formatting
anandkaranubc Mar 22, 2025
65df310
bench: refactor random number generation in `stats/base/dists/levy`
hemantmm Mar 22, 2025
da364f2
chore: add workflow to autoclose redundant PRs
kgryte Mar 22, 2025
f4ed191
fix: update default type
kgryte Mar 23, 2025
2fe2d56
feat: add `ndarray/fill-by`
kgryte Mar 23, 2025
7aab855
feat: add `fillBy` to namespace
kgryte Mar 23, 2025
18bf1b9
chore: fix EditorConfig lint errors
AaryaBalwadkar Mar 22, 2025
ddd6b55
chore: fix C lint errors
AaryaBalwadkar Mar 23, 2025
03097f2
docs: update namespace table of contents
stdlib-bot Mar 23, 2025
b696310
docs: update REPL namespace documentation
stdlib-bot Mar 23, 2025
0374b18
docs: update list of contributors
stdlib-bot Mar 23, 2025
d42757f
feat: update namespace TypeScript declarations
stdlib-bot Mar 23, 2025
b75236b
feat: add `ndfillBy` to namespace
kgryte Mar 23, 2025
d8a0922
docs: use correct function name
anandkaranubc Mar 23, 2025
d2cab68
docs: add examples for `string` and `float` formatting
anandkaranubc Mar 23, 2025
f7c0673
chore: fix JavaScript lint errors
Kavyansh-Bagdi Mar 23, 2025
b0e8a31
updated tests
Girish-Garg Mar 23, 2025
2917d57
Merge branch 'stdlib-js:develop' into feat/bernoullif
Girish-Garg Mar 23, 2025
4d55398
updated docs
Girish-Garg Mar 23, 2025
e1efb4d
Merge branch 'feat/bernoullif' of https://github.com/Girish-Garg/stdl…
Girish-Garg Mar 23, 2025
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
232 changes: 232 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/bernoullif/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
<!--

@license Apache-2.0

Copyright (c) 2018 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# Bernoulli

> Compute the nth [Bernoulli number][bernoulli-number] as a single-precision floating-point.

<section class="intro">

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var bernoullif = require( '@stdlib/math/base/special/bernoullif' );
```

#### bernoullif( n )

Computes the nth [Bernoulli number][bernoulli-number] as a single-precision floating-point number.

```javascript
var v = bernoullif( 0 );
// returns 1.0

v = bernoullif( 1 );
// returns 0.5

v = bernoullif( 2 );
// returns ~0.167

v = bernoullif( 3 );
// returns 0.0

v = bernoullif( 4 );
// returns ~-0.033

v = bernoullif( 5 );
// returns 0.0

v = bernoullif( 20 );
// returns ~-529.124
```

For even integers `n >= 66`, the function alternates between returning positive and negative infinity, as larger [Bernoulli numbers][bernoulli-number] cannot be safely represented in [single-precision floating-point format][ieee754].

```javascript
var v = bernoullif( 306 );
// returns Infinity

v = bernoullif( 66 );
// returns Infinity

v = bernoullif( 68 );
// returns -Infinity
```

If not provided a nonnegative integer value, the function returns `NaN`.

```javascript
var v = bernoullif( 3.14 );
// returns NaN

v = bernoullif( -1 );
// returns NaN
```

If provided `NaN`, the function returns `NaN`.

```javascript
var v = bernoullif( NaN );
// returns NaN
```

</section>

<!-- /.usage -->

<section class="notes">

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var bernoullif = require( '@stdlib/math/base/special/bernoullif' );

var v;
var i;

for ( i = 0; i < 66; i++ ) {
v = bernoullif( i );
console.log( v );
}
```

</section>

<!-- /.examples -->

<!-- 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/bernoullif.h"
```

#### stdlib_base_bernoullif( n )

Computes the nth [Bernoulli number][bernoulli-number] as a single-precision floating-point number.

```c
float out = stdlib_base_bernoullif( 0 );
// returns 1.0f

out = stdlib_base_bernoullif( 1 );
// returns 0.5f
```

The function accepts the following arguments:

- **n**: `[in] int32_t` input value.

```c
float stdlib_base_bernoullif( const int32_t n );
```

</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/bernoullif.h"
#include <stdio.h>
#include <stdint.h>

int main( void ) {
int32_t i;
float v;

for ( i = 0; i < 66; i++ ) {
v = stdlib_base_bernoullif( i );
printf( "bernoullif(%d) = %f\n", i, v );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[bernoulli-number]: https://en.wikipedia.org/wiki/Bernoulli_number

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pkg = require( './../package.json' ).name;
var bernoullif = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var x;
var y;
var i;

x = discreteUniform( 100, 0, 500 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = bernoullif( x[ i % x.length ] );
if ( isnanf( y ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnanf( y ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var bernoulli = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( bernoulli instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {
var x;
var y;
var i;

x = discreteUniform( 100, 0, 500 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = bernoulli( x[ i % x.length ] );
if ( isnanf( y ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnanf( y ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Loading