Skip to content

Commit 61706f6

Browse files
committed
Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop
2 parents c1805ef + 8557c81 commit 61706f6

File tree

17 files changed

+1404
-7
lines changed

17 files changed

+1404
-7
lines changed

lib/node_modules/@stdlib/stats/base/dists/normal/logpdf/README.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,104 @@ for ( i = 0; i < 10; i++ ) {
142142

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

145+
<!-- C interface documentation. -->
146+
147+
* * *
148+
149+
<section class="c">
150+
151+
## C APIs
152+
153+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
154+
155+
<section class="intro">
156+
157+
</section>
158+
159+
<!-- /.intro -->
160+
161+
<!-- C usage documentation. -->
162+
163+
<section class="usage">
164+
165+
### Usage
166+
167+
```c
168+
#include "stdlib/stats/base/dists/normal/logpdf.h"
169+
```
170+
171+
#### stdlib_base_dists_normal_logpdf( x, mu, sigma )
172+
173+
Evaluates the natural logarithm of the probability density function (logPDF) for a normal distribution.
174+
175+
```c
176+
double out = stdlib_base_dists_normal_pdf( 2.0, 0.0, 1.0 );
177+
// returns ~-2.919
178+
```
179+
180+
The function accepts the following arguments:
181+
182+
- **x**: `[in] double` input value.
183+
- **mu**: `[in] double` mean.
184+
- **sigma**: `[in] double` standard deviation.
185+
186+
```c
187+
double stdlib_base_dists_normal_logpdf( cconst double x, const double mu, const double sigma );
188+
```
189+
190+
</section>
191+
192+
<!-- /.usage -->
193+
194+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
195+
196+
<section class="notes">
197+
198+
</section>
199+
200+
<!-- /.notes -->
201+
202+
<!-- C API usage examples. -->
203+
204+
<section class="examples">
205+
206+
### Examples
207+
208+
```c
209+
#include "stdlib/stats/base/dists/normal/logpdf.h"
210+
#include <stdlib.h>
211+
#include <stdio.h>
212+
213+
static double random_uniform( const double min, const double max ) {
214+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
215+
return min + ( v*(max-min) );
216+
}
217+
218+
int main( void ) {
219+
double sigma;
220+
double mu;
221+
double x;
222+
double y;
223+
int i;
224+
225+
for ( i = 0; i < 10; i++ ) {
226+
x = random_uniform( 0.0, 10.0 );
227+
mu = random_uniform( -5.0, 5.0 );
228+
sigma = random_uniform( 0.1, 20.0 );
229+
y = stdlib_base_dists_normal_logpdf( x, mu, sigma );
230+
printf( "x: %lf, µ: %lf, σ: %lf, ln(f(x;µ,σ)): %lf\n", x, mu, sigma, y );
231+
}
232+
}
233+
```
234+
235+
</section>
236+
237+
<!-- /.examples -->
238+
239+
</section>
240+
241+
<!-- /.c -->
242+
145243
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
146244

147245
<section class="related">

lib/node_modules/@stdlib/stats/base/dists/normal/logpdf/benchmark/benchmark.js

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2626
var EPS = require( '@stdlib/constants/float64/eps' );
2727
var pkg = require( './../package.json' ).name;
@@ -32,17 +32,20 @@ var logpdf = require( './../lib' );
3232

3333
bench( pkg, function benchmark( b ) {
3434
var sigma;
35+
var len;
3536
var mu;
3637
var x;
3738
var y;
3839
var i;
3940

41+
len = 100;
42+
x = uniform( len, -100.0, 100.0 );
43+
mu = uniform( len, -50.0, 50.0 );
44+
sigma = uniform( len, EPS, 20.0 );
45+
4046
b.tic();
4147
for ( i = 0; i < b.iterations; i++ ) {
42-
x = ( randu()*200.0 ) - 100;
43-
mu = ( randu()*100.0 ) - 50.0;
44-
sigma = ( randu()*20.0 ) + EPS;
45-
y = logpdf( x, mu, sigma );
48+
y = logpdf( x[ i % len ], mu[ i % len ], sigma[ i % len ] );
4649
if ( isnan( y ) ) {
4750
b.fail( 'should not return NaN' );
4851
}
@@ -66,11 +69,11 @@ bench( pkg+':factory', function benchmark( b ) {
6669
mu = 0.0;
6770
sigma = 1.5;
6871
mylogpdf = logpdf.factory( mu, sigma );
72+
x = uniform( 100, -3.0, 3.0 );
6973

7074
b.tic();
7175
for ( i = 0; i < b.iterations; i++ ) {
72-
x = ( randu()*6.0 ) - 3.0;
73-
y = mylogpdf( x );
76+
y = mylogpdf( x[ i % x.length ] );
7477
if ( isnan( y ) ) {
7578
b.fail( 'should not return NaN' );
7679
}
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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+
'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 uniform = require( '@stdlib/random/base/uniform' );
27+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
28+
var tryRequire = require( '@stdlib/utils/try-require' );
29+
var EPS = require( '@stdlib/constants/float64/eps' );
30+
var pkg = require( './../package.json' ).name;
31+
32+
33+
// VARIABLES //
34+
35+
var logpdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
36+
var opts = {
37+
'skip': ( logpdf instanceof Error )
38+
};
39+
40+
41+
// MAIN //
42+
43+
bench( pkg, opts, function benchmark( b ) {
44+
var sigma;
45+
var len;
46+
var mu;
47+
var x;
48+
var y;
49+
var i;
50+
51+
len = 100;
52+
x = new Float64Array( len );
53+
mu = new Float64Array( len );
54+
sigma = new Float64Array( len );
55+
for ( i = 0; i < len; i++ ) {
56+
x[ i ] = uniform( -100.0, 100.0 );
57+
mu[ i ] = uniform( -50.0, 50.0 );
58+
sigma[ i ] = uniform( EPS, 20.0 );
59+
}
60+
61+
b.tic();
62+
for ( i = 0; i < b.iterations; i++ ) {
63+
y = logpdf( x[ i % len ], mu[ i % len ], sigma[ i % len ]);
64+
if ( isnan( y ) ) {
65+
b.fail( 'should not return NaN' );
66+
}
67+
}
68+
b.toc();
69+
if ( isnan( y ) ) {
70+
b.fail( 'should not return NaN' );
71+
}
72+
b.pass( 'benchmark finished' );
73+
b.end();
74+
});
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+
# VARIABLES #
19+
20+
ifndef VERBOSE
21+
QUIET := @
22+
else
23+
QUIET :=
24+
endif
25+
26+
# Determine the OS ([1][1], [2][2]).
27+
#
28+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
29+
# [2]: http://stackoverflow.com/a/27776822/2225624
30+
OS ?= $(shell uname)
31+
ifneq (, $(findstring MINGW,$(OS)))
32+
OS := WINNT
33+
else
34+
ifneq (, $(findstring MSYS,$(OS)))
35+
OS := WINNT
36+
else
37+
ifneq (, $(findstring CYGWIN,$(OS)))
38+
OS := WINNT
39+
else
40+
ifneq (, $(findstring Windows_NT,$(OS)))
41+
OS := WINNT
42+
endif
43+
endif
44+
endif
45+
endif
46+
47+
# Define the program used for compiling C source files:
48+
ifdef C_COMPILER
49+
CC := $(C_COMPILER)
50+
else
51+
CC := gcc
52+
endif
53+
54+
# Define the command-line options when compiling C files:
55+
CFLAGS ?= \
56+
-std=c99 \
57+
-O3 \
58+
-Wall \
59+
-pedantic
60+
61+
# Determine whether to generate position independent code ([1][1], [2][2]).
62+
#
63+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
64+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
65+
ifeq ($(OS), WINNT)
66+
fPIC ?=
67+
else
68+
fPIC ?= -fPIC
69+
endif
70+
71+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
72+
INCLUDE ?=
73+
74+
# List of source files:
75+
SOURCE_FILES ?=
76+
77+
# List of libraries (e.g., `-lopenblas -lpthread`):
78+
LIBRARIES ?=
79+
80+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
81+
LIBPATH ?=
82+
83+
# List of C targets:
84+
c_targets := benchmark.out
85+
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)