-
-
Notifications
You must be signed in to change notification settings - Fork 828
feat(stats): add C implementation for stats/base/dists/chisquare/mgf
#4593
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
Merged
Planeshifter
merged 13 commits into
stdlib-js:develop
from
anandkaranubc:rfc/chisquare-mgf
Jan 8, 2025
Merged
Changes from 6 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
31fd9b5
feat: add the C src files
anandkaranubc 24b9448
feat: add the C benchmark and example files
anandkaranubc 802c112
feat: add the JS native files
anandkaranubc 1a5005d
build: added the json and gyp dependency files
anandkaranubc 1b55992
docs: update README with C API documentation
anandkaranubc 60f110c
chore: update copyright years
stdlib-bot a6f5fa0
docs: update README with proper print info in examples
anandkaranubc c18c4f2
refactor: formatting c files
anandkaranubc 73752c6
refactor: formatting dependency files
anandkaranubc b67ad98
chore: update copyright years
stdlib-bot 5267f59
refactor: formatting benchmark.c
anandkaranubc 4f07e8e
docs: reorder declarations in example code
Planeshifter 99670a0
chore: apply suggestions from code review
Planeshifter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -151,6 +151,106 @@ for ( i = 0; i < 10; 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/stats/base/dists/chisquare/mgf.h" | ||||||
``` | ||||||
|
||||||
#### stdlib_base_dists_chisquare_mgf( t, k ) | ||||||
|
||||||
Evaluates the moment-generating function (MGF) for a chi-squared distribution | ||||||
* with degrees of freedom `k` at a value `t`. | ||||||
|
||||||
```c | ||||||
double out = stdlib_base_dists_chisquare_mgf( 0.4, 2.0 ); | ||||||
// returns ~5.0 | ||||||
``` | ||||||
|
||||||
The function accepts the following arguments: | ||||||
|
||||||
- **t**: `[in] double` input value. | ||||||
- **k**: `[in] double` degrees of freedom (must be non-negative). | ||||||
|
||||||
```c | ||||||
double stdlib_base_dists_chisquare_mgf( const double t, const double k ); | ||||||
``` | ||||||
|
||||||
</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/stats/base/dists/chisquare/mgf.h" | ||||||
#include <stdlib.h> | ||||||
#include <stdio.h> | ||||||
|
||||||
static double random_uniform( const double min, const double max ) { | ||||||
double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); | ||||||
return min + ( v * ( max - min ) ); | ||||||
} | ||||||
|
||||||
int main( void ) { | ||||||
double t; | ||||||
double k; | ||||||
double result; | ||||||
int i; | ||||||
|
||||||
for ( i = 0; i < 10; i++ ) { | ||||||
t = random_uniform( -0.5, 0.4 ); | ||||||
k = random_uniform( 0.1, 10.0 ); | ||||||
|
||||||
result = stdlib_base_dists_chisquare_mgf( t, k ); | ||||||
|
||||||
printf( "t: %lf, k: %lf, MGF: %lf \n", t, k, result ); | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See JS example:
Suggested change
|
||||||
} | ||||||
|
||||||
return 0; | ||||||
} | ||||||
``` | ||||||
|
||||||
</section> | ||||||
|
||||||
<!-- /.examples --> | ||||||
|
||||||
</section> | ||||||
|
||||||
<!-- /.c --> | ||||||
|
||||||
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||||||
|
||||||
<section class="references"> | ||||||
|
70 changes: 70 additions & 0 deletions
70
lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/benchmark/benchmark.native.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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 Float64Array = require( '@stdlib/array/float64' ); | ||
var randu = require( '@stdlib/random/base/randu' ); | ||
var isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
var tryRequire = require( '@stdlib/utils/try-require' ); | ||
var pkg = require( './../package.json' ).name; | ||
|
||
|
||
// VARIABLES // | ||
|
||
var mgf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||
var opts = { | ||
'skip': ( mgf instanceof Error ) | ||
}; | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg+'::native', opts, function benchmark( b ) { | ||
var len; | ||
var t; | ||
var k; | ||
var y; | ||
var i; | ||
|
||
len = 100; | ||
t = new Float64Array( len ); | ||
k = new Float64Array( len ); | ||
for ( i = 0; i < len; i++ ) { | ||
t[ i ] = ( randu() * 0.8 ) - 0.4; | ||
k[ i ] = ( randu() * 10.0 ) + 0.1; | ||
} | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
y = mgf( t[ i % len ], k[ i % len ] ); | ||
if ( isnan( y ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnan( y ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
146 changes: 146 additions & 0 deletions
146
lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/benchmark/c/Makefile
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
#/ | ||
# @license Apache-2.0 | ||
# | ||
# Copyright (c) 2025 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 |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.