-
-
Notifications
You must be signed in to change notification settings - Fork 907
feat: add C implementation for stats/base/dists/pareto-type1/pdf
#4452
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 15 commits into
stdlib-js:develop
from
ShabiShett07:feature/pareto-type1
Jun 23, 2025
Merged
Changes from 11 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
062ae2c
feat: add @stdlib/stats/base/dists/pareto-type1/pdf
ShabiShett07 78fbb29
chore: update copyright years
stdlib-bot dbf38da
fix: resolve lint errors
stdlib-bot 8320037
chore: update implementation
ShabiShett07 260ca3e
fix: modernize PRNG usage and fix parameter constraints in pareto-typ…
Planeshifter bd72178
fix: simplify example and benchmark in `pareto-type1/pdf`
Planeshifter fb86adf
Merge branch 'develop' into feature/pareto-type1
Planeshifter 8cbffc9
bench: restore benchmark
Planeshifter d8f9897
chore: minor clean-up
Planeshifter ac3ad2b
chore: minor clean-up
Planeshifter ea0ade7
fix: add missing dependency
Planeshifter d6bbc15
fix: remove trailing comma
Planeshifter eca6e8e
fix: add missing `package.json` fields
Planeshifter f6b3116
style: remove extra trailing newline
Planeshifter 85ac676
style: turn spaces to tab
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
72 changes: 72 additions & 0 deletions
72
lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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,72 @@ | ||
/** | ||
* @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 tryRequire = require( '@stdlib/utils/try-require' ); | ||
var bench = require( '@stdlib/bench' ); | ||
var uniform = require( '@stdlib/random/array/uniform' ); | ||
var isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
var EPS = require( '@stdlib/constants/float64/eps' ); | ||
var pkg = require( './../package.json' ).name; | ||
|
||
|
||
// VARIABLES // | ||
|
||
var pdf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||
var opts = { | ||
'skip': ( pdf instanceof Error ) | ||
}; | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg+'::native', opts, function benchmark( b ) { | ||
var options; | ||
var alpha; | ||
var beta; | ||
var len; | ||
var x; | ||
var y; | ||
var i; | ||
|
||
options = { | ||
'dtype': 'float64' | ||
}; | ||
len = 100; | ||
alpha = uniform( len, EPS, 5.0, options ); | ||
beta = uniform( len, 1.0, 5.0, options ); | ||
x = uniform( len, 2.0, 10.0, options ); | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
y = pdf( x[ i % len ], alpha[ i % len ], beta[ 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/pareto-type1/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) 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 |
142 changes: 142 additions & 0 deletions
142
lib/node_modules/@stdlib/stats/base/dists/pareto-type1/pdf/benchmark/c/benchmark.c
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,142 @@ | ||
/** | ||
* @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. | ||
*/ | ||
|
||
#include "stdlib/stats/base/dists/pareto-type1/pdf.h" | ||
#include <stdlib.h> | ||
#include <stdio.h> | ||
#include <math.h> | ||
#include <time.h> | ||
#include <sys/time.h> | ||
|
||
#define NAME "pareto-type1-stdev" | ||
#define ITERATIONS 1000000 | ||
#define REPEATS 3 | ||
|
||
/** | ||
* Prints the TAP version. | ||
*/ | ||
static void print_version( void ) { | ||
printf( "TAP version 13\n" ); | ||
} | ||
|
||
/** | ||
* Prints the TAP summary. | ||
* | ||
* @param total total number of tests | ||
* @param passing total number of passing tests | ||
*/ | ||
static void print_summary( int total, int passing ) { | ||
printf( "#\n" ); | ||
printf( "1..%d\n", total ); // TAP plan | ||
printf( "# total %d\n", total ); | ||
printf( "# pass %d\n", passing ); | ||
printf( "#\n" ); | ||
printf( "# ok\n" ); | ||
} | ||
|
||
/** | ||
* Prints benchmarks results. | ||
* | ||
* @param elapsed elapsed time in seconds | ||
*/ | ||
static void print_results( double elapsed ) { | ||
double rate = (double)ITERATIONS / elapsed; | ||
printf( " ---\n" ); | ||
printf( " iterations: %d\n", ITERATIONS ); | ||
printf( " elapsed: %0.9f\n", elapsed ); | ||
printf( " rate: %0.9f\n", rate ); | ||
printf( " ...\n" ); | ||
} | ||
|
||
/** | ||
* Returns a clock time. | ||
* | ||
* @return clock time | ||
*/ | ||
static double tic( void ) { | ||
struct timeval now; | ||
gettimeofday( &now, NULL ); | ||
return (double)now.tv_sec + (double)now.tv_usec/1.0e6; | ||
} | ||
|
||
/** | ||
* Generates a random number on the interval [min,max). | ||
* | ||
* @param min minimum value (inclusive) | ||
* @param max maximum value (exclusive) | ||
* @return random number | ||
*/ | ||
static double random_uniform( const double min, const double max ) { | ||
double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); | ||
return min + ( v*(max-min) ); | ||
} | ||
|
||
/** | ||
* Runs a benchmark. | ||
* | ||
* @return elapsed time in seconds | ||
*/ | ||
static double benchmark( void ) { | ||
double elapsed; | ||
double x[ 100 ]; | ||
double alpha[ 100 ]; | ||
double beta[ 100 ]; | ||
double y; | ||
double t; | ||
int i; | ||
|
||
for ( i = 0; i < 100; i++ ) { | ||
x[ i ] = random_uniform( 0.0, 10.0 ); | ||
alpha[ i ] = random_uniform( 0.1, 10.0 ); | ||
beta[ i ] = random_uniform( 2.1, 10.0 ); | ||
} | ||
|
||
t = tic(); | ||
for ( i = 0; i < ITERATIONS; i++ ) { | ||
y = stdlib_base_dists_pareto_type1_pdf( x[ i % 100 ], alpha[ i % 100 ], beta[ i % 100 ] ); | ||
if ( y != y ) { | ||
printf( "should not return NaN\n" ); | ||
break; | ||
} | ||
} | ||
elapsed = tic() - t; | ||
if ( y != y ) { | ||
printf( "should not return NaN\n" ); | ||
} | ||
return elapsed; | ||
} | ||
|
||
/** | ||
* Main execution sequence. | ||
*/ | ||
int main( void ) { | ||
double elapsed; | ||
int i; | ||
|
||
// Use the current time to seed the random number generator: | ||
srand( time( NULL ) ); | ||
|
||
print_version(); | ||
for ( i = 0; i < REPEATS; i++ ) { | ||
printf( "# c::%s\n", NAME ); | ||
elapsed = benchmark(); | ||
print_results( elapsed ); | ||
printf( "ok %d benchmark finished\n", i+1 ); | ||
} | ||
print_summary( REPEATS, REPEATS ); | ||
} |
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.