Skip to content

Commit 960fd26

Browse files
rautelaKamalrautelaKamal
committed
feat: add C implementation for @stdlib/stats/base/dists/lognormal/logcdf
- Add standalone C implementation using erfc, erfcx, log1p - Add native.js binding, header, addon.c, Makefile, binding.gyp - Add test.native.js, benchmark.native.js with variable sorting - Fix max-length bounds in all benchmarks - Fix C APIs formatting in README Signed-off-by: Kamal Singh Rautela <e22cseu1624@bennett.edu.in>
1 parent eee306a commit 960fd26

File tree

18 files changed

+5339
-5
lines changed

18 files changed

+5339
-5
lines changed

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

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,78 @@ logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(F(x;µ,σ)): %0.4f', x, mu, sigm
124124

125125
<!-- /.examples -->
126126

127+
<!-- C usage documentation. -->
128+
129+
<section class="c">
130+
131+
<section class="usage">
132+
133+
### Usage
134+
135+
```c
136+
#include "stdlib/stats/base/dists/lognormal/logcdf.h"
137+
```
138+
139+
#### stdlib_base_dists_lognormal_logcdf( x, mu, sigma )
140+
141+
Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [lognormal][lognormal-distribution] distribution with mean `mu` and standard deviation `sigma` at a value `x`.
142+
143+
```c
144+
double y = stdlib_base_dists_lognormal_logcdf( 2.0, 0.0, 1.0 );
145+
// returns ~-0.2799
146+
```
147+
148+
The function accepts the following arguments:
149+
150+
- **x**: `[in] double` input value.
151+
- **mu**: `[in] double` mean.
152+
- **sigma**: `[in] double` standard deviation.
153+
154+
```c
155+
double stdlib_base_dists_lognormal_logcdf( const double x, const double mu, const double sigma );
156+
```
157+
158+
</section>
159+
160+
<!-- /.usage -->
161+
162+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
163+
164+
<section class="notes">
165+
166+
</section>
167+
168+
<!-- /.notes -->
169+
170+
<section class="examples">
171+
172+
### Examples
173+
174+
```c
175+
#include "stdlib/stats/base/dists/lognormal/logcdf.h"
176+
#include <stdio.h>
177+
178+
int main( void ) {
179+
double y;
180+
int i;
181+
182+
for ( i = 0; i < 25; i++ ) {
183+
y = stdlib_base_dists_lognormal_logcdf( (double)i, 0.0, 1.0 );
184+
printf( "x: %d, logcdf: %lf\n", i, y );
185+
}
186+
return 0;
187+
}
188+
```
189+
190+
</section>
191+
192+
<!-- /.examples -->
193+
194+
</section>
195+
196+
<!-- /.c -->
197+
198+
127199
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
128200

129201
<section class="related">

‎lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/benchmark/benchmark.js‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,11 @@ var logcdf = require( './../lib' );
3434
bench( pkg, function benchmark( b ) {
3535
var sigma;
3636
var opts;
37+
var len;
3738
var mu;
39+
var i;
3840
var x;
3941
var y;
40-
var i;
4142

4243
opts = {
4344
'dtype': 'float64'
@@ -46,9 +47,10 @@ bench( pkg, function benchmark( b ) {
4647
mu = uniform( 100, -50.0, 50.0, opts );
4748
sigma = uniform( 100, EPS, 20.0, opts );
4849

50+
len = x.length;
4951
b.tic();
5052
for ( i = 0; i < b.iterations; i++ ) {
51-
y = logcdf( x[ i % x.length ], mu[ i % mu.length ], sigma[ i % sigma.length ] );
53+
y = logcdf( x[ i % len ], mu[ i % len ], sigma[ i % len ] );
5254
if ( isnan( y ) ) {
5355
b.fail( 'should not return NaN' );
5456
}
@@ -65,10 +67,11 @@ bench( format( '%s:factory', pkg ), function benchmark( b ) {
6567
var mylogcdf;
6668
var sigma;
6769
var opts;
70+
var len;
6871
var mu;
72+
var i;
6973
var x;
7074
var y;
71-
var i;
7275

7376
mu = 0.0;
7477
sigma = 1.5;
@@ -79,9 +82,10 @@ bench( format( '%s:factory', pkg ), function benchmark( b ) {
7982
};
8083
x = uniform( 100, -3.0, 3.0, opts );
8184

85+
len = x.length;
8286
b.tic();
8387
for ( i = 0; i < b.iterations; i++ ) {
84-
y = mylogcdf( x[ i % x.length ] );
88+
y = mylogcdf( x[ i % len ] );
8589
if ( isnan( y ) ) {
8690
b.fail( 'should not return NaN' );
8791
}

‎lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/benchmark/benchmark.native.js‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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 uniform = require( '@stdlib/random/array/uniform' );
26+
var format = require( '@stdlib/string/format' );
27+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
28+
var tryRequire = require( '@stdlib/utils/try-require' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var logcdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( logcdf instanceof Error )
37+
};
38+
39+
40+
// MAIN //
41+
42+
bench( format( '%s::native', pkg ), opts, function benchmark( b ) {
43+
var sigma;
44+
var opts;
45+
var len;
46+
var mu;
47+
var i;
48+
var x;
49+
var y;
50+
51+
opts = {
52+
'dtype': 'float64'
53+
};
54+
x = uniform( 100, 0.1, 100.0, opts );
55+
mu = uniform( 100, -10.0, 10.0, opts );
56+
sigma = uniform( 100, 0.1, 10.0, opts );
57+
58+
len = x.length;
59+
b.tic();
60+
for ( i = 0; i < b.iterations; i++ ) {
61+
y = logcdf( x[ i % len ], mu[ i % len ], sigma[ i % len ] );
62+
if ( isnan( y ) ) {
63+
b.fail( 'should not return NaN' );
64+
}
65+
}
66+
b.toc();
67+
if ( isnan( y ) ) {
68+
b.fail( 'should not return NaN' );
69+
}
70+
b.pass( 'benchmark finished' );
71+
b.end();
72+
});

‎lib/node_modules/@stdlib/stats/base/dists/lognormal/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) 2026 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)