Skip to content

Commit 6e8eb2d

Browse files
anandkaranubcanandkaranubc
committed
feat: add the C benchmark and example files
1 parent 2d05be5 commit 6e8eb2d

File tree

4 files changed

+485
-0
lines changed

4 files changed

+485
-0
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/Makefile‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2025 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# VARIABLES #
20+
21+
ifndef VERBOSE
22+
QUIET := @
23+
else
24+
QUIET :=
25+
endif
26+
27+
# Determine the OS ([1][1], [2][2]).
28+
#
29+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
30+
# [2]: http://stackoverflow.com/a/27776822/2225624
31+
OS ?= $(shell uname)
32+
ifneq (, $(findstring MINGW,$(OS)))
33+
OS := WINNT
34+
else
35+
ifneq (, $(findstring MSYS,$(OS)))
36+
OS := WINNT
37+
else
38+
ifneq (, $(findstring CYGWIN,$(OS)))
39+
OS := WINNT
40+
else
41+
ifneq (, $(findstring Windows_NT,$(OS)))
42+
OS := WINNT
43+
endif
44+
endif
45+
endif
46+
endif
47+
48+
# Define the program used for compiling C source files:
49+
ifdef C_COMPILER
50+
CC := $(C_COMPILER)
51+
else
52+
CC := gcc
53+
endif
54+
55+
# Define the command-line options when compiling C files:
56+
CFLAGS ?= \
57+
-std=c99 \
58+
-O3 \
59+
-Wall \
60+
-pedantic
61+
62+
# Determine whether to generate position independent code ([1][1], [2][2]).
63+
#
64+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
65+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
66+
ifeq ($(OS), WINNT)
67+
fPIC ?=
68+
else
69+
fPIC ?= -fPIC
70+
endif
71+
72+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
73+
INCLUDE ?=
74+
75+
# List of source files:
76+
SOURCE_FILES ?=
77+
78+
# List of libraries (e.g., `-lopenblas -lpthread`):
79+
LIBRARIES ?=
80+
81+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
82+
LIBPATH ?=
83+
84+
# List of C targets:
85+
c_targets := benchmark.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles source files.
92+
#
93+
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
94+
# @param {string} [CFLAGS] - C compiler options
95+
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
96+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
97+
# @param {string} [SOURCE_FILES] - list of source files
98+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
99+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
100+
#
101+
# @example
102+
# make
103+
#
104+
# @example
105+
# make all
106+
#/
107+
all: $(c_targets)
108+
109+
.PHONY: all
110+
111+
#/
112+
# Compiles C source files.
113+
#
114+
# @private
115+
# @param {string} CC - C compiler (e.g., `gcc`)
116+
# @param {string} CFLAGS - C compiler options
117+
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
118+
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
119+
# @param {string} SOURCE_FILES - list of source files
120+
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
121+
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
122+
#/
123+
$(c_targets): %.out: %.c
124+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
125+
126+
#/
127+
# Runs compiled benchmarks.
128+
#
129+
# @example
130+
# make run
131+
#/
132+
run: $(c_targets)
133+
$(QUIET) ./$<
134+
135+
.PHONY: run
136+
137+
#/
138+
# Removes generated files.
139+
#
140+
# @example
141+
# make clean
142+
#/
143+
clean:
144+
$(QUIET) -rm -f *.o *.out
145+
146+
.PHONY: clean

‎lib/node_modules/@stdlib/stats/base/dists/hypergeometric/pmf/benchmark/c/benchmark.c‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#include "stdlib/stats/base/dists/hypergeometric/pmf.h"
20+
#include "stdlib/math/base/special/round.h"
21+
#include <stdlib.h>
22+
#include <stdio.h>
23+
#include <math.h>
24+
#include <time.h>
25+
#include <sys/time.h>
26+
27+
#define NAME "hypergeometric-pmf"
28+
#define ITERATIONS 1000000
29+
#define REPEATS 3
30+
31+
/**
32+
* Prints the TAP version.
33+
*/
34+
static void print_version( void ) {
35+
printf( "TAP version 13\n" );
36+
}
37+
38+
/**
39+
* Prints the TAP summary.
40+
*
41+
* @param total total number of tests
42+
* @param passing total number of passing tests
43+
*/
44+
static void print_summary( int total, int passing ) {
45+
printf( "#\n" );
46+
printf( "1..%d\n", total ); // TAP plan
47+
printf( "# total %d\n", total );
48+
printf( "# pass %d\n", passing );
49+
printf( "#\n" );
50+
printf( "# ok\n" );
51+
}
52+
53+
/**
54+
* Prints benchmarks results.
55+
*
56+
* @param elapsed elapsed time in seconds
57+
*/
58+
static void print_results( double elapsed ) {
59+
double rate = (double)ITERATIONS / elapsed;
60+
printf( " ---\n" );
61+
printf( " iterations: %d\n", ITERATIONS );
62+
printf( " elapsed: %0.9f\n", elapsed );
63+
printf( " rate: %0.9f\n", rate );
64+
printf( " ...\n" );
65+
}
66+
67+
/**
68+
* Returns a clock time.
69+
*
70+
* @return clock time
71+
*/
72+
static double tic( void ) {
73+
struct timeval now;
74+
gettimeofday( &now, NULL );
75+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
76+
}
77+
78+
/**
79+
* Generates a random number on the interval [min,max).
80+
*
81+
* @param min minimum value (inclusive)
82+
* @param max maximum value (exclusive)
83+
* @return random number
84+
*/
85+
static double random_uniform( const double min, const double max ) {
86+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
87+
return min + ( v*(max-min) );
88+
}
89+
90+
/**
91+
* Runs a benchmark.
92+
*
93+
* @return elapsed time in seconds
94+
*/
95+
static double benchmark( void ) {
96+
double elapsed;
97+
double N[ 100 ];
98+
double K[ 100 ];
99+
double n[ 100 ];
100+
double x[ 100 ];
101+
double pmf;
102+
double t;
103+
int i;
104+
105+
for ( i = 0; i < 100; i++ ) {
106+
N[i] = stdlib_base_round(random_uniform(1.0, 100.0));
107+
K[i] = stdlib_base_round(random_uniform(0.0, N[i]));
108+
n[i] = stdlib_base_round(random_uniform(0.0, N[i]));
109+
x[i] = stdlib_base_round(random_uniform(0.0, n[i]));
110+
}
111+
112+
t = tic();
113+
for ( i = 0; i < ITERATIONS; i++ ) {
114+
pmf = stdlib_base_dists_hypergeometric_pmf( x[ i % 100 ], N[ i % 100 ], K[ i % 100 ], n[ i % 100 ] );
115+
if ( pmf != pmf ) {
116+
printf( "should not return NaN\n" );
117+
break;
118+
}
119+
}
120+
elapsed = tic() - t;
121+
if ( pmf != pmf ) {
122+
printf( "should not return NaN\n" );
123+
}
124+
return elapsed;
125+
}
126+
127+
/**
128+
* Main execution sequence.
129+
*/
130+
int main( void ) {
131+
double elapsed;
132+
int i;
133+
134+
// Use the current time to seed the random number generator:
135+
srand( time( NULL ) );
136+
137+
print_version();
138+
for ( i = 0; i < REPEATS; i++ ) {
139+
printf( "# c::%s\n", NAME );
140+
elapsed = benchmark();
141+
print_results( elapsed );
142+
printf( "ok %d benchmark finished\n", i+1 );
143+
}
144+
print_summary( REPEATS, REPEATS );
145+
}

0 commit comments

Comments
 (0)