Skip to content

Commit 48f947c

Browse files
vivekmaurya001vivekmaurya001
committed
feat(add C implementation): add stats/base/dists/arcsine
1 parent a0ba090 commit 48f947c

File tree

15 files changed

+1316
-0
lines changed

15 files changed

+1316
-0
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/README.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,97 @@ for ( i = 0; i < 25; i++ ) {
147147

148148
<!-- /.examples -->
149149

150+
<!-- C interface documentation. -->
151+
152+
* * *
153+
154+
<section class="c">
155+
156+
## C APIs
157+
158+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
159+
160+
<section class="intro">
161+
162+
</section>
163+
164+
<!-- /.intro -->
165+
166+
<!-- C usage documentation. -->
167+
168+
<section class="usage">
169+
170+
### Usage
171+
172+
```c
173+
#include "stdlib/stats/base/dists/arcsine/logcdf.h"
174+
```
175+
176+
#### stdlib_base_dists_arcsine_logcdf( a, b )
177+
178+
Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for an [arcsine][arcsine-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support).
179+
180+
```c
181+
double out = stdlib_base_dists_arcsine_logcdf( 9.0, 0.0, 10.0 );
182+
// returns ~-0.23
183+
```
184+
185+
The function accepts the following arguments:
186+
187+
- **x**: `[in] double` minimum support
188+
- **a**: `[in] double` minimum support
189+
- **b**: `[in] double` maximum support
190+
191+
```c
192+
double stdlib_base_dists_arcsine_logcdf( const double x, const double a, const double b );
193+
```
194+
</section>
195+
196+
<!-- /.usage -->
197+
198+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
199+
200+
<section class="notes">
201+
202+
</section>
203+
204+
<!-- /.notes -->
205+
206+
<!-- C API usage examples. -->
207+
208+
<section class="examples">
209+
210+
### Examples
211+
212+
```c
213+
#include "stdlib/stats/base/dists/arcsine/logcdf.h"
214+
#include <stdlib.h>
215+
#include <stdio.h>
216+
int main( void ) {
217+
double x;
218+
double a;
219+
double b;
220+
double y;
221+
int i;
222+
223+
for ( i = 0; i < 25; i++ ) {
224+
x = ( (double)rand() / (double)RAND_MAX ) * 20.0 - 10.0;
225+
a = ( (double)rand() / (double)RAND_MAX ) * 20.0 - 20.0;
226+
b = a + ( (double)rand() / (double)RAND_MAX ) * 40.0;
227+
y = stdlib_base_dists_arcsine_logcdf( x, a, b );
228+
printf( "x: %lf ,a: %lf, b: %lf, ln(F;x,a,b): %lf\n", x, a, b, y );
229+
}
230+
}
231+
```
232+
233+
</section>
234+
235+
<!-- /.examples -->
236+
237+
</section>
238+
239+
<!-- /.c -->
240+
150241
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
151242

152243
<section class="related">

‎lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/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) 2024 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/arcsine/logcdf/benchmark/c/benchmark.c‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 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/arcsine/logcdf.h"
20+
#include <stdlib.h>
21+
#include <stdio.h>
22+
#include <math.h>
23+
#include <time.h>
24+
#include <sys/time.h>
25+
26+
#define NAME "arcsine-logcdf"
27+
#define ITERATIONS 1000000
28+
#define REPEATS 3
29+
30+
/**
31+
* Prints the TAP version.
32+
*/
33+
static void print_version( void ) {
34+
printf( "TAP version 13\n" );
35+
}
36+
37+
/**
38+
* Prints the TAP summary.
39+
*
40+
* @param total total number of tests
41+
* @param passing total number of passing tests
42+
*/
43+
static void print_summary( int total, int passing ) {
44+
printf( "#\n" );
45+
printf( "1..%d\n", total ); // TAP plan
46+
printf( "# total %d\n", total );
47+
printf( "# pass %d\n", passing );
48+
printf( "#\n" );
49+
printf( "# ok\n" );
50+
}
51+
52+
/**
53+
* Prints benchmarks results.
54+
*
55+
* @param elapsed elapsed time in seconds
56+
*/
57+
static void print_results( double elapsed ) {
58+
double rate = (double)ITERATIONS / elapsed;
59+
printf( " ---\n" );
60+
printf( " iterations: %d\n", ITERATIONS );
61+
printf( " elapsed: %0.9f\n", elapsed );
62+
printf( " rate: %0.9f\n", rate );
63+
printf( " ...\n" );
64+
}
65+
66+
/**
67+
* Returns a clock time.
68+
*
69+
* @return clock time
70+
*/
71+
static double tic( void ) {
72+
struct timeval now;
73+
gettimeofday( &now, NULL );
74+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
75+
}
76+
77+
/**
78+
* Generates a random number on the interval [0,1).
79+
*
80+
* @return random number
81+
*/
82+
static double rand_double( void ) {
83+
int r = rand();
84+
return (double)r / ( (double)RAND_MAX + 1.0 );
85+
}
86+
87+
/**
88+
* Runs a benchmark.
89+
*
90+
* @return elapsed time in seconds
91+
*/
92+
static double benchmark( void ) {
93+
double elapsed;
94+
double x;
95+
double a;
96+
double b;
97+
double y;
98+
double t;
99+
int i;
100+
101+
t = tic();
102+
for ( i = 0; i < ITERATIONS; i++ ) {
103+
x = ( 20.0 * rand_double() ) - 10.0;
104+
a = ( 20.0 * rand_double() ) - 20.0;
105+
b = a + ( 40.0 * rand_double() );
106+
y = stdlib_base_dists_arcsine_logcdf( x, a, b );
107+
if ( y != y ) {
108+
printf( "should not return NaN\n" );
109+
break;
110+
}
111+
}
112+
elapsed = tic() - t;
113+
if ( y != y ) {
114+
printf( "should not return NaN\n" );
115+
}
116+
return elapsed;
117+
}
118+
119+
/**
120+
* Main execution sequence.
121+
*/
122+
int main( void ) {
123+
double elapsed;
124+
int i;
125+
126+
// Use the current time to seed the random number generator:
127+
srand( time( NULL ) );
128+
129+
print_version();
130+
for ( i = 0; i < REPEATS; i++ ) {
131+
printf( "# c::%s\n", NAME );
132+
elapsed = benchmark();
133+
print_results( elapsed );
134+
printf( "ok %d benchmark finished\n", i+1 );
135+
}
136+
print_summary( REPEATS, REPEATS );
137+
}

0 commit comments

Comments
 (0)