Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
8f7a4c1
feat: add c implementation of kernal betainc
nirmaljb Feb 14, 2026
725981a
chore: update copyright years
stdlib-bot Feb 14, 2026
4d067da
fix: removed trailing whitespace
nirmaljb Feb 14, 2026
8b09879
fix: removed unnecessary assigned variable
nirmaljb Feb 14, 2026
c9ec37f
test: added fixture
nirmaljb Feb 17, 2026
c398869
style: remove trailing space after ;
nirmaljb Feb 17, 2026
d0f93fa
test: added test, test.native, runner
nirmaljb Feb 18, 2026
a00b9f3
Apply suggestion from @gunjjoshi
nirmaljb Feb 24, 2026
2e13ea5
fix: added format for bench interpolation
nirmaljb Feb 24, 2026
05814a9
fix: added powm1 instead of pow() - 1
nirmaljb Mar 15, 2026
45bb984
test: added test for ibeta
nirmaljb Mar 15, 2026
5281ab1
test: remove some the output.json and it's fixtures, because it range…
nirmaljb Mar 17, 2026
49227ca
test: removed redundant test cases
nirmaljb Mar 17, 2026
de9851e
test: commented out assign method test
nirmaljb Mar 18, 2026
4fc832d
test: changed to isAlmostEqual
nirmaljb Mar 28, 2026
386b749
refactor: made some changes to the implementation
nirmaljb Mar 28, 2026
17edfe9
test: moved from isAlmostEqual to isAlmostSameValue
nirmaljb Mar 31, 2026
8165e41
fix: address changes suggestion
nirmaljb Apr 4, 2026
e6cb1fe
fix: update the namespace to correct convention
nirmaljb Apr 4, 2026
21d3954
test: revert back the date to original file
nirmaljb Apr 8, 2026
e5fdc8d
docs: use correct example and spacing
nirmaljb Apr 8, 2026
167fc92
bench: refactor C benchmark and update main.c formating
Neerajpathak07 Apr 10, 2026
8446c6a
chore: update macro name
Neerajpathak07 Apr 10, 2026
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
107 changes: 106 additions & 1 deletion lib/node_modules/@stdlib/math/base/special/kernel-betainc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ limitations under the License.

-->

# Kernel Betainc
# kernelBetainc

> [Incomplete beta function][incomplete-beta-function] and its first derivative.

Expand Down Expand Up @@ -135,6 +135,111 @@ for ( i = 0; i < 100; i++ ) {

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

#### stdlib_base_kernel_betainc( x, a, b, regularized, upper, &out, &derivative )

Evaluates the incomplete beta function and its first derivative.

```c
double out;
double derivative;

stdlib_base_kernel_betainc( 0.2, 1.0, 2.0, true, false, &out, &derivative );
```

The function accepts the following arguments:

- **x**: `[in] double` input value.
- **a**: `[in] double` input value.
- **b**: `[in] double` input value.
- **regularized**: `[in] bool` indicating if the function should evaluate the regularized incomplete beta function.
- **upper**: `[in] bool` indicating if the function should return the upper tail of the incomplete beta function.
- **out**: `[out] double*` pointer to store the function value.
- **derivative**: `[out] double*` pointer to store the first derivative.

```c
void stdlib_base_kernel_betainc( double x, double a, double b, const bool regularized, bool upper, double *out, double *derivative );
```

</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/kernel_betainc.h"
#include "stdlib/random/base/randu.h"
#include <stdio.h>
#include <stdint.h>
#include <stdbool.h>

int main( void ) {
struct BasePRNGObject *obj = stdlib_base_random_randu_allocate( 0 );
double deriv;
double out;
int32_t i;
double x;
double a;
double b;

for ( i = 0; i < 100; i++ ) {
x = stdlib_base_random_randu( obj );
a = stdlib_base_random_randu( obj ) * 10.0;
b = stdlib_base_random_randu( obj ) * 10.0;
stdlib_base_kernel_betainc( x, a, b, true, false, &out, &deriv );
printf( "x: %lf, \t a: %lf, \t b: %lf, \t f(x,a,b): %lf, \t f^1(x,a,b): %lf", x, a, b, out, deriv );
}

stdlib_base_random_randu_free( obj );
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

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

<section class="related">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@
var uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var EPS = require( '@stdlib/constants/float64/eps' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var kernelBetainc = require( './../lib' );


// MAIN //

bench( pkg+'::regularized,upper', function benchmark( assert ) {
bench( format( '%s::regularized,upper', pkg ), function benchmark( assert ) {
var out;
var x;
var a;
Expand All @@ -44,7 +45,7 @@
out = [ 0.0, 0.0 ];
assert.tic();
for ( i = 0; i < assert.iterations; i++ ) {
out = kernelBetainc( x[ i%x.length ], a[ i%a.length ], b[ i%b.length ], true, true, out, 1, 0 );

Check warning on line 48 in lib/node_modules/@stdlib/math/base/special/kernel-betainc/benchmark/benchmark.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

This line has a length of 104. Maximum allowed is 80
if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) {
assert.fail( 'should not return NaN' );
}
Expand All @@ -57,7 +58,7 @@
assert.end();
});

bench( pkg+'::unregularized,upper', function benchmark( assert ) {
bench( format( '%s::unregularized,upper', pkg ), function benchmark( assert ) {
var out;
var x;
var a;
Expand All @@ -71,7 +72,7 @@
out = [ 0.0, 0.0 ];
assert.tic();
for ( i = 0; i < assert.iterations; i++ ) {
out = kernelBetainc( x[ i%x.length ], a[ i%a.length ], b[ i%b.length ], false, true, out, 1, 0 );

Check warning on line 75 in lib/node_modules/@stdlib/math/base/special/kernel-betainc/benchmark/benchmark.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

This line has a length of 105. Maximum allowed is 80
if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) {
assert.fail( 'should not return NaN' );
}
Expand All @@ -84,7 +85,7 @@
assert.end();
});

bench( pkg+'::regularized,lower', function benchmark( assert ) {
bench( format( '%s::regularized,lower', pkg ), function benchmark( assert ) {
var out;
var x;
var a;
Expand All @@ -98,7 +99,7 @@
out = [ 0.0, 0.0 ];
assert.tic();
for ( i = 0; i < assert.iterations; i++ ) {
out = kernelBetainc( x[ i%x.length ], a[ i%a.length ], b[ i%b.length ], true, false, out, 1, 0 );

Check warning on line 102 in lib/node_modules/@stdlib/math/base/special/kernel-betainc/benchmark/benchmark.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

This line has a length of 105. Maximum allowed is 80
if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) {
assert.fail( 'should not return NaN' );
}
Expand All @@ -111,7 +112,7 @@
assert.end();
});

bench( pkg+'::unregularized,lower', function benchmark( assert ) {
bench( format( '%s::unregularized,lower', pkg ), function benchmark( assert ) {
var out;
var x;
var a;
Expand All @@ -125,7 +126,7 @@
out = [ 0.0, 0.0 ];
assert.tic();
for ( i = 0; i < assert.iterations; i++ ) {
out = kernelBetainc( x[ i%x.length ], a[ i%a.length ], b[ i%b.length ], false, false, out, 1, 0 );

Check warning on line 129 in lib/node_modules/@stdlib/math/base/special/kernel-betainc/benchmark/benchmark.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

This line has a length of 106. Maximum allowed is 80
if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) {
assert.fail( 'should not return NaN' );
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var tryRequire = require( '@stdlib/utils/try-require' );
var format = require( '@stdlib/string/format' );
var EPS = require( '@stdlib/constants/float64/eps' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

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


// MAIN //

bench( format( '%s::regularized,upper', pkg ), opts, function benchmark( assert ) {
var out;
var x;
var a;
var b;
var i;

x = uniform( 100, 0.0, 1.0 );
a = uniform( 100, EPS, 1000.0 );
b = uniform( 100, EPS, 1000.0 );

out = [ 0.0, 0.0 ];
assert.tic();
for ( i = 0; i < assert.iterations; i++ ) {
out = kernelBetainc( x[ i%x.length ], a[ i%a.length ], b[ i%b.length ], true, true );

Check warning on line 57 in lib/node_modules/@stdlib/math/base/special/kernel-betainc/benchmark/benchmark.native.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

This line has a length of 93. Maximum allowed is 80
if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) {
assert.fail( 'should not return NaN' );
}
}
assert.toc();
if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) {
assert.fail( 'should not return NaN' );
}
assert.pass( 'benchmark finished' );
assert.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
#/
# @license Apache-2.0
#
# Copyright (c) 2026 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.
#/

# VARIABLES #

ifndef VERBOSE
QUIET := @
else
QUIET :=
endif

# Determine the OS ([1][1], [2][2]).
#
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
# [2]: http://stackoverflow.com/a/27776822/2225624
OS ?= $(shell uname)
ifneq (, $(findstring MINGW,$(OS)))
OS := WINNT
else
ifneq (, $(findstring MSYS,$(OS)))
OS := WINNT
else
ifneq (, $(findstring CYGWIN,$(OS)))
OS := WINNT
else
ifneq (, $(findstring Windows_NT,$(OS)))
OS := WINNT
endif
endif
endif
endif

# Define the program used for compiling C source files:
ifdef C_COMPILER
CC := $(C_COMPILER)
else
CC := gcc
endif

# Define the command-line options when compiling C files:
CFLAGS ?= \
-std=c99 \
-O3 \
-Wall \
-pedantic

# Determine whether to generate position independent code ([1][1], [2][2]).
#
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
ifeq ($(OS), WINNT)
fPIC ?=
else
fPIC ?= -fPIC
endif

# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
INCLUDE ?=

# List of source files:
SOURCE_FILES ?=

# List of libraries (e.g., `-lopenblas -lpthread`):
LIBRARIES ?=

# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
LIBPATH ?=

# List of C targets:
c_targets := benchmark.out


# RULES #

#/
# Compiles source files.
#
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
# @param {string} [CFLAGS] - C compiler options
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
# @param {string} [SOURCE_FILES] - list of source files
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
#
# @example
# make
#
# @example
# make all
#/
all: $(c_targets)

.PHONY: all

#/
# Compiles C source files.
#
# @private
# @param {string} CC - C compiler (e.g., `gcc`)
# @param {string} CFLAGS - C compiler options
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
# @param {string} SOURCE_FILES - list of source files
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
#/
$(c_targets): %.out: %.c
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)

#/
# Runs compiled benchmarks.
#
# @example
# make run
#/
run: $(c_targets)
$(QUIET) ./$<

.PHONY: run

#/
# Removes generated files.
#
# @example
# make clean
#/
clean:
$(QUIET) -rm -f *.o *.out

.PHONY: clean
Loading