-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add C implementation for stats/base/dists/f/pdf
#10136
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
Open
nirmaljb
wants to merge
2
commits into
stdlib-js:develop
Choose a base branch
from
nirmaljb:feat/f-pdf
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 |
|---|---|---|
|
|
@@ -143,6 +143,106 @@ logEachMap( 'x: %0.4f, d1: %0.4f, d2: %0.4f, f(x;d1,d2): %0.4f', x, d1, d2, pdf | |
|
|
||
| <!-- /.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/f/pdf.h" | ||
| ``` | ||
|
|
||
| #### stdlib_base_dists_f_pdf( x, d1, d2 ) | ||
|
|
||
| Evaluates the probability density function (PDF) for an F distribution with numerator degrees of freedom `d1` and denominator degrees of freedom `d2` at a value `x`. | ||
|
|
||
|
|
||
| ```c | ||
| double out = stdlib_base_dists_f_pdf( 2.0, 0.5, 1.0 ); | ||
| // returns ~0.057 | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **x**: `[in] double` input value. | ||
| - **d1**: `[in] double` numerator degrees of freedom. | ||
| - **d2**: `[in] double` denominator degrees of freedom. | ||
|
|
||
| ```c | ||
| double stdlib_base_dists_f_pdf( const double x, const double d1, const double d2 ); | ||
| ``` | ||
|
|
||
| </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/f/pdf.h" | ||
| #include <stdlib.h> | ||
| #include <stdio.h> | ||
| #include <stdint.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 x; | ||
| double d1; | ||
| double d2; | ||
| double y; | ||
| int32_t i; | ||
|
Member
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. Same as |
||
|
|
||
| for ( i = 0; i < 10; i++ ) { | ||
| x = random_uniform( 0.0, 4.0 ); | ||
| d1 = random_uniform( 0.0, 10.0 ); | ||
| d2 = random_uniform( 0.0, 10.0 ); | ||
| y = stdlib_base_dists_f_pdf( x, d1, d2 ); | ||
| printf( "x: %lf, d1: %lf, d2: %lf, F(x;d1,d2): %lf\n", x, d1, d2, y ); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.c --> | ||
|
|
||
| <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
|
||
| <section class="related"> | ||
|
|
||
76 changes: 76 additions & 0 deletions
76
lib/node_modules/@stdlib/stats/base/dists/f/pdf/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,76 @@ | ||||||
| /** | ||||||
| * @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 tryRequire = require( '@stdlib/utils/try-require' ); | ||||||
| var bench = require( '@stdlib/bench' ); | ||||||
| var Float64Array = require( '@stdlib/array/float64' ); | ||||||
| var uniform = require( '@stdlib/random/base/uniform' ); | ||||||
| var discreteUniform = require( '@stdlib/random/base/discrete-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; | ||||||
|
|
||||||
|
|
||||||
| // VARIABLES // | ||||||
|
|
||||||
| var pdf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||||||
| var opts = { | ||||||
| 'skip': ( pdf instanceof Error ) | ||||||
| }; | ||||||
|
|
||||||
|
|
||||||
| // MAIN // | ||||||
|
|
||||||
| bench( format( '%s::native', pkg ), opts, function benchmark( b ) { | ||||||
| var len; | ||||||
| var d1; | ||||||
| var d2; | ||||||
| var x; | ||||||
| var y; | ||||||
| var i; | ||||||
|
|
||||||
| len = 100; | ||||||
| x = new Float64Array( len ); | ||||||
| d1 = new Float64Array( len ); | ||||||
| d2 = new Float64Array( len ); | ||||||
| for ( i = 0; i < len; i++ ) { | ||||||
| x[ i ] = uniform( EPS, 100.0 ); | ||||||
| d1[ i ] = discreteUniform( 1, 100 ); | ||||||
| d2[ i ] = discreteUniform( 1, 100 ); | ||||||
| } | ||||||
|
|
||||||
| b.tic(); | ||||||
| for ( i = 0; i < b.iterations; i++ ) { | ||||||
| y = pdf( x[ i % len ], d1[ i % len ], d2[ i % len ]); | ||||||
|
Member
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. Missing space before the closing
Suggested change
|
||||||
| 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/f/pdf/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) 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 |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Drop the double blank line between the description and the code block; should be a single blank line.