-
-
Notifications
You must be signed in to change notification settings - Fork 817
feat: add C implementation for stats/base/dists/planck/logpmf
#5001
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
base: develop
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -101,7 +101,7 @@ y = mylogpmf( 1.0 ); | |||||||||||||||||||
|
||||||||||||||||||||
## Notes | ||||||||||||||||||||
|
||||||||||||||||||||
- In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow. | ||||||||||||||||||||
In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow. | ||||||||||||||||||||
|
||||||||||||||||||||
</section> | ||||||||||||||||||||
|
||||||||||||||||||||
|
@@ -133,6 +133,104 @@ for ( i = 0; i < lambda.length; 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/planck/logpmf.h" | ||||||||||||||||||||
``` | ||||||||||||||||||||
|
||||||||||||||||||||
#### stdlib_base_dists_planck_logpmf( x, lambda ) | ||||||||||||||||||||
|
||||||||||||||||||||
Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`. | ||||||||||||||||||||
|
||||||||||||||||||||
```c | ||||||||||||||||||||
double out = stdlib_base_dists_planck_logpmf( 4.0 , 0.3 ); | ||||||||||||||||||||
// returns ~-2.5502 | ||||||||||||||||||||
``` | ||||||||||||||||||||
|
||||||||||||||||||||
The function accepts the following arguments: | ||||||||||||||||||||
|
||||||||||||||||||||
- **x**: `[in] double` input value. | ||||||||||||||||||||
- **lambda**: `[in] double` shape parameter. | ||||||||||||||||||||
|
||||||||||||||||||||
```c | ||||||||||||||||||||
double stdlib_base_dists_planck_logpmf( const double x, const double lambda ); | ||||||||||||||||||||
``` | ||||||||||||||||||||
|
||||||||||||||||||||
</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/planck/logpmf.h" | ||||||||||||||||||||
#include <stdlib.h> | ||||||||||||||||||||
#include <stdio.h> | ||||||||||||||||||||
static int random_discrete_uniform( const int min, const int max ) { | ||||||||||||||||||||
return min + ( rand() % ( max - min + 1 ) ); | ||||||||||||||||||||
} | ||||||||||||||||||||
Comment on lines
+201
to
+204
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.
Suggested change
|
||||||||||||||||||||
|
||||||||||||||||||||
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 lambda; | ||||||||||||||||||||
double y; | ||||||||||||||||||||
int x; | ||||||||||||||||||||
int i; | ||||||||||||||||||||
|
||||||||||||||||||||
for ( i = 0; i < 10; i++ ) { | ||||||||||||||||||||
x = random_discrete_uniform( 0, 5 ); | ||||||||||||||||||||
lambda = random_uniform( 0.1, 5.0 ); | ||||||||||||||||||||
y = stdlib_base_dists_planck_logpmf( x, lambda ); | ||||||||||||||||||||
printf( "x: %d, lambda: %lf, F(x; lambda): %lf\n", x, lambda ,y ); | ||||||||||||||||||||
} | ||||||||||||||||||||
} | ||||||||||||||||||||
``` | ||||||||||||||||||||
|
||||||||||||||||||||
</section> | ||||||||||||||||||||
|
||||||||||||||||||||
<!-- /.examples --> | ||||||||||||||||||||
|
||||||||||||||||||||
</section> | ||||||||||||||||||||
|
||||||||||||||||||||
<!-- /.c --> | ||||||||||||||||||||
|
||||||||||||||||||||
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||||||||||||||||||||
|
||||||||||||||||||||
<section class="related"> | ||||||||||||||||||||
|
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -21,8 +21,10 @@ | |||
// MODULES // | ||||
|
||||
var bench = require( '@stdlib/bench' ); | ||||
var Float64Array = require( '@stdlib/array/float64' ); | ||||
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||||
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.
Suggested change
should be removed as it is not used in the file anywhere 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 comment for the native file as well 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. actually it is been used in pkg+':factory'(benchmark 2) , as it uses random/array/discrete-uniform , so i made two variable one for array and one for base . 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. Yeah, but the the |
||||
var uniform = require( '@stdlib/random/array/uniform' ); | ||||
var uniformBase = require( '@stdlib/random/base/uniform' ); | ||||
var discreteUniformBase = require( '@stdlib/random/base/discrete-uniform' ); | ||||
var isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||||
var pkg = require( './../package.json' ).name; | ||||
var logpmf = require( './../lib' ); | ||||
|
@@ -32,16 +34,22 @@ var logpmf = require( './../lib' ); | |||
|
||||
bench( pkg, function benchmark( b ) { | ||||
var lambda; | ||||
var len; | ||||
var x; | ||||
var y; | ||||
var i; | ||||
|
||||
x = discreteUniform( 100, 0, 40 ); | ||||
lambda = uniform( 100, 0.1, 10.0 ); | ||||
len = 100; | ||||
x = new Float64Array( len ); | ||||
lambda = new Float64Array( len ); | ||||
for ( i = 0; i < len; i++ ) { | ||||
x[i] = discreteUniformBase(0, 40); | ||||
lambda[i] = uniformBase(1.0, 10.0); | ||||
} | ||||
|
||||
b.tic(); | ||||
for ( i = 0; i < b.iterations; i++ ) { | ||||
y = logpmf( x[ i % x.length ], lambda[ i % lambda.length ] ); | ||||
y = logpmf( x[ i % len ], lambda[ i % len ] ); | ||||
if ( isnan( y ) ) { | ||||
b.fail( 'should not return NaN' ); | ||||
} | ||||
|
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,71 @@ | ||||||||||
/** | ||||||||||
* @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 uniformBase = require( '@stdlib/random/base/uniform' ); | ||||||||||
var discreteUniformBase = require( '@stdlib/random/base/discrete-uniform' ); | ||||||||||
var isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||||||||||
var tryRequire = require( '@stdlib/utils/try-require' ); | ||||||||||
var pkg = require( './../package.json' ).name; | ||||||||||
|
||||||||||
|
||||||||||
// VARIABLES // | ||||||||||
|
||||||||||
var logpmf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||||||||||
var opts = { | ||||||||||
'skip': ( logpmf instanceof Error ) | ||||||||||
}; | ||||||||||
|
||||||||||
|
||||||||||
// MAIN // | ||||||||||
|
||||||||||
bench( pkg+'::native', opts, function benchmark( b ) { | ||||||||||
var lambda; | ||||||||||
var len; | ||||||||||
var x; | ||||||||||
var y; | ||||||||||
var i; | ||||||||||
|
||||||||||
len = 100; | ||||||||||
x = new Float64Array( len ); | ||||||||||
lambda = new Float64Array( len ); | ||||||||||
for ( i = 0; i < len; i++ ) { | ||||||||||
x[i] = discreteUniformBase(0, 40); | ||||||||||
lambda[i] = uniformBase(1.0, 10.0); | ||||||||||
Comment on lines
+54
to
+55
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.
Suggested change
|
||||||||||
} | ||||||||||
|
||||||||||
b.tic(); | ||||||||||
for ( i = 0; i < b.iterations; i++ ) { | ||||||||||
y = logpmf( x[ i % len ], lambda[ 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(); | ||||||||||
}); |
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 |
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.