Skip to content

Commit ef57275

Browse files
Neerajpathak07Neerajpathak07
committed
feat: add-betaprime-pdf
1 parent 8785e54 commit ef57275

File tree

16 files changed

+1510
-0
lines changed

16 files changed

+1510
-0
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/betaprime/pdf/README.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,131 @@ for ( i = 0; i < 10; i++ ) {
159159

160160
<!-- /.examples -->
161161

162+
<!-- C interface documentation. -->
163+
164+
* * *
165+
166+
<section class="c">
167+
168+
## C APIs
169+
170+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
171+
172+
<section class="intro">
173+
174+
</section>
175+
176+
<!-- /.intro -->
177+
178+
<!-- C usage documentation. -->
179+
180+
<section class="usage">
181+
182+
### Usage
183+
184+
```c
185+
#include "stdlib/stats/base/dists/betaprime/pdf.h"
186+
```
187+
188+
#### stdlib_base_dists_betaprime_pdf( x, alpha, beta )
189+
190+
Evaluates the probability density function (PDF) for a beta prime distribution with first shape parameter `alpha` and second shape parameter `beta` at a value `x`.
191+
192+
```c
193+
double y = stdlib_base_dists_betaprime_pdf( 0.5, 1.0, 1.0 );
194+
// returns ~0.444
195+
196+
y = stdlib_base_dists_betaprime_pdf( 0.5, 2.0, 4.0 );
197+
// returns ~0.878
198+
199+
y = stdlib_base_dists_betaprime_pdf( 0.2, 2.0, 2.0 );
200+
// returns ~0.579
201+
202+
y = stdlib_base_dists_betaprime_pdf( 0.8, 4.0, 4.0 );
203+
// returns ~0.65
204+
205+
y = stdlib_base_dists_betaprime_pdf( -0.5, 4.0, 2.0 );
206+
// returns ~0.0
207+
208+
y = stdlib_base_dists_betaprime_pdf( 1.5, 4.0, 2.0 );
209+
// returns ~NaN
210+
211+
y = stdlib_base_dists_betaprime_pdf( 0.5, -1.0, 0.5 );
212+
// returns NaN
213+
214+
y = stdlib_base_dists_betaprime_pdf( 0.5, 0.5, -1.0 );
215+
// returns NaN
216+
217+
y = stdlib_base_dists_betaprime_pdf( NaN, 1.0, 1.0 );
218+
// returns NaN
219+
220+
y = stdlib_base_dists_betaprime_pdf( 0.5, NaN, 1.0 );
221+
// returns NaN
222+
223+
y = stdlib_base_dists_betaprime_pdf( 0.5, 1.0, NaN );
224+
// returns NaN
225+
```
226+
227+
The function accepts the following arguments:
228+
229+
- **x**: `[in] double` input value
230+
- **alpha**: `[in] double` first shape parameter
231+
- **beta**: `[in] double` second shape parameter
232+
233+
```c
234+
double stdlib_base_dists_betaprime_pdf( const double x, double alpha, const double beta );
235+
```
236+
237+
</section>
238+
239+
<!-- /.usage -->
240+
241+
<!-- C API usage notes. Make sure to keep an empty line after the `section`
242+
element and another before the `/section` close. -->
243+
244+
<section class="notes">
245+
246+
</section>
247+
248+
<!-- /.notes -->
249+
250+
<!-- C API usage examples. -->
251+
252+
<section class="examples">
253+
254+
### Examples
255+
256+
```c
257+
#include "stdlib/stats/base/dists/betaprime/pdf.h"
258+
#include "stdlib/constants/float64/eps.h"
259+
#include <stdlib.h>
260+
#include <stdio.h>
261+
262+
int main( void ) {
263+
double alpha;
264+
double beta;
265+
double x;
266+
double y;
267+
int i;
268+
269+
for ( i = 0; i < 10; i++ ) {
270+
x = ( (double)rand() / (double)RAND_MAX );
271+
alpha = ( ( (double)rand() / (double)RAND_MAX )*5.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
272+
beta = ( ( (double)rand() / (double)RAND_MAX )*5.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
273+
y = stdlib_base_dists_betaprime_pdf( x, alpha, beta );
274+
printf( "x: %1f, α: %1f, β: %1f, f(x;α,β): %lf\n", x, alpha, beta, y );
275+
}
276+
}
277+
```
278+
279+
</section>
280+
281+
<!-- /.examples -->
282+
283+
</section>
284+
285+
<!-- /.c -->
286+
162287
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
163288

164289
<section class="related">

‎lib/node_modules/@stdlib/stats/base/dists/betaprime/pdf/benchmark/benchmark.native.js‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
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 randu = require( '@stdlib/random/base/randu' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var tryRequire = require( '@stdlib/utils/try-require' );
28+
var EPS = require( '@stdlib/constants/float64/eps' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var pdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( pdf instanceof Error )
37+
};
38+
39+
40+
// MAIN //
41+
42+
bench( pkg+'::native', opts, function benchmark( b ) {
43+
var alpha;
44+
var beta;
45+
var x;
46+
var y;
47+
var i;
48+
49+
b.tic();
50+
for ( i = 0; i < b.iterations; i++ ) {
51+
x = ( randu()*2.0 ) + EPS;
52+
alpha = ( randu()*100.0 ) + EPS;
53+
beta = ( randu()*100.0 ) + EPS;
54+
y = pdf( x, alpha, beta );
55+
if ( isnan( y ) ) {
56+
b.fail( 'should not return NaN' );
57+
}
58+
}
59+
b.toc();
60+
if ( isnan( y ) ) {
61+
b.fail( 'should not return NaN' );
62+
}
63+
b.pass( 'benchmark finished' );
64+
b.end();
65+
});
66+
67+
bench( pkg+':factory', opts, function benchmark( b ) {
68+
var mypdf;
69+
var alpha;
70+
var beta;
71+
var x;
72+
var y;
73+
var i;
74+
75+
alpha = 100.56789;
76+
beta = 55.54321;
77+
mypdf = pdf.factory( alpha, beta );
78+
79+
b.tic();
80+
for ( i = 0; i < b.iterations; i++ ) {
81+
x = ( randu()*2.0 ) + EPS;
82+
y = mypdf( x );
83+
if ( isnan( y ) ) {
84+
b.fail( 'should not return NaN' );
85+
}
86+
}
87+
b.toc();
88+
if ( isnan( y ) ) {
89+
b.fail( 'should not return NaN' );
90+
}
91+
b.pass( 'benchmark finished' );
92+
b.end();
93+
});

‎lib/node_modules/@stdlib/stats/base/dists/betaprime/pdf/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

0 commit comments

Comments
 (0)