Skip to content

Commit eaf7676

Browse files
vivekmaurya001vivekmaurya001
authored
feat: add C implementation for stats/base/dists/invgamma/skewness
PR-URL: #4119 Closes: #3678 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent dd6359a commit eaf7676

File tree

17 files changed

+1334
-3
lines changed

17 files changed

+1334
-3
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/invgamma/skewness/README.md

+96
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,102 @@ for ( i = 0; i < 10; i++ ) {
141141

142142
<!-- /.examples -->
143143

144+
<!-- C interface documentation. -->
145+
146+
* * *
147+
148+
<section class="c">
149+
150+
## C APIs
151+
152+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
153+
154+
<section class="intro">
155+
156+
</section>
157+
158+
<!-- /.intro -->
159+
160+
<!-- C usage documentation. -->
161+
162+
<section class="usage">
163+
164+
### Usage
165+
166+
```c
167+
#include "stdlib/stats/base/dists/invgamma/skewness.h"
168+
```
169+
170+
#### stdlib_base_dists_invgamma_skewness( alpha, beta )
171+
172+
Evaluates the [skewness][skewness] of a [inverse gamma][invgamma-distribution] distribution with parameters `alpha` (shape parameter) and `beta` (rate parameter).
173+
174+
```c
175+
double out = stdlib_base_dists_invgamma_skewness( 4.0, 12.0 );
176+
// returns ~5.657
177+
```
178+
179+
The function accepts the following arguments:
180+
181+
- **alpha**: `[in] double` shape parameter.
182+
- **beta**: `[in] double` rate parameter.
183+
184+
```c
185+
double stdlib_base_dists_invgamma_skewness( const double alpha, const double beta );
186+
```
187+
188+
</section>
189+
190+
<!-- /.usage -->
191+
192+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
193+
194+
<section class="notes">
195+
196+
</section>
197+
198+
<!-- /.notes -->
199+
200+
<!-- C API usage examples. -->
201+
202+
<section class="examples">
203+
204+
### Examples
205+
206+
```c
207+
#include "stdlib/stats/base/dists/invgamma/skewness.h"
208+
#include "stdlib/constants/float64/eps.h"
209+
#include <stdlib.h>
210+
#include <stdio.h>
211+
212+
static double random_uniform( const double min, const double max ) {
213+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
214+
return min + ( v*(max-min) );
215+
}
216+
217+
int main( void ) {
218+
double alpha;
219+
double beta;
220+
double y;
221+
int i;
222+
223+
for ( i = 0; i < 25; i++ ) {
224+
alpha = random_uniform( 0.0, 10.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
225+
beta = random_uniform( 0.0, 10.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
226+
y = stdlib_base_dists_invgamma_skewness( alpha, beta );
227+
printf( "α: %lf, β: %lf, skew(X;α,β): %lf\n", alpha, beta, y );
228+
}
229+
}
230+
```
231+
232+
</section>
233+
234+
<!-- /.examples -->
235+
236+
</section>
237+
238+
<!-- /.c -->
239+
144240
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
145241

146242
<section class="references">

‎lib/node_modules/@stdlib/stats/base/dists/invgamma/skewness/benchmark/benchmark.js

+11-3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
var bench = require( '@stdlib/bench' );
2424
var randu = require( '@stdlib/random/base/randu' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var Float64Array = require( '@stdlib/array/float64' );
2627
var EPS = require( '@stdlib/constants/float64/eps' );
2728
var pkg = require( './../package.json' ).name;
2829
var skewness = require( './../lib' );
@@ -33,14 +34,21 @@ var skewness = require( './../lib' );
3334
bench( pkg, function benchmark( b ) {
3435
var alpha;
3536
var beta;
37+
var len;
3638
var y;
3739
var i;
3840

41+
len = 100;
42+
alpha = new Float64Array( len );
43+
beta = new Float64Array( len );
44+
for ( i = 0; i < len; i++ ) {
45+
alpha[ i ] = ( randu()*10.0 ) + 3.0 + EPS;
46+
beta[ i ] = ( randu()*10.0 ) + EPS;
47+
}
48+
3949
b.tic();
4050
for ( i = 0; i < b.iterations; i++ ) {
41-
alpha = ( randu()*10.0 ) + 3.0 + EPS;
42-
beta = ( randu()*10.0 ) + EPS;
43-
y = skewness( alpha, beta );
51+
y = skewness( alpha[ i % len ], beta[ i % len ] );
4452
if ( isnan( y ) ) {
4553
b.fail( 'should not return NaN' );
4654
}

‎lib/node_modules/@stdlib/stats/base/dists/invgamma/skewness/benchmark/benchmark.native.js

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
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+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var Float64Array = require( '@stdlib/array/float64' );
26+
var randu = require( '@stdlib/random/base/randu' );
27+
var EPS = require( '@stdlib/constants/float64/eps' );
28+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
29+
var tryRequire = require( '@stdlib/utils/try-require' );
30+
var pkg = require( './../package.json' ).name;
31+
32+
33+
// VARIABLES //
34+
35+
var skewness = tryRequire( resolve( __dirname, './../lib/native.js' ) );
36+
var opts = {
37+
'skip': ( skewness instanceof Error )
38+
};
39+
40+
41+
// MAIN //
42+
43+
bench( pkg+'::native', opts, function benchmark( b ) {
44+
var alpha;
45+
var beta;
46+
var len;
47+
var y;
48+
var i;
49+
50+
len = 100;
51+
alpha = new Float64Array( len );
52+
beta = new Float64Array( len );
53+
for ( i = 0; i < len; i++ ) {
54+
alpha[ i ] = ( randu()*10.0 ) + 3.0 + EPS;
55+
beta[ i ] = ( randu()*10.0 ) + EPS;
56+
}
57+
58+
b.tic();
59+
for ( i = 0; i < b.iterations; i++ ) {
60+
y = skewness( alpha[ i % len ], beta[ i % len ] );
61+
if ( isnan( y ) ) {
62+
b.fail( 'should not return NaN' );
63+
}
64+
}
65+
b.toc();
66+
if ( isnan( y ) ) {
67+
b.fail( 'should not return NaN' );
68+
}
69+
b.pass( 'benchmark finished' );
70+
b.end();
71+
});

‎lib/node_modules/@stdlib/stats/base/dists/invgamma/skewness/benchmark/c/Makefile

+146
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

0 commit comments

Comments
 (0)