Skip to content

feat: add C implementation for stats/base/dists/levy/quantile #4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Mar 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
8600f80
feat: add c implementation for stats/base/dists/levy/quantile
saurabhraghuvanshii Jan 14, 2025
cd46074
chore: update copyright year of include.gypi and fix lint error
saurabhraghuvanshii Jan 14, 2025
9afd62b
chore: update copyright years
stdlib-bot Jan 14, 2025
0320702
refactor: updates file with uniform and values
saurabhraghuvanshii Jan 18, 2025
3ac3b5c
chore: update value in Redame and some in quantile.h
saurabhraghuvanshii Jan 19, 2025
2be0229
Merge branch 'stdlib-js:develop' into levy-quantile
saurabhraghuvanshii Jan 20, 2025
05e9dcd
chore: update benchmark.c
saurabhraghuvanshii Jan 20, 2025
eb857ba
Merge branch 'stdlib-js:develop' into levy-quantile
saurabhraghuvanshii Jan 20, 2025
2e0c64f
chore: update benchmark.js manifest.json
saurabhraghuvanshii Jan 20, 2025
ec1cdfa
Merge branch 'stdlib-js:develop' into levy-quantile
saurabhraghuvanshii Jan 20, 2025
bda8d24
chore: update mainfest.json
saurabhraghuvanshii Jan 20, 2025
f768887
Merge branch 'stdlib-js:develop' into levy-quantile
saurabhraghuvanshii Feb 17, 2025
6f1a799
chore: updates minor mistakes and fix tests
saurabhraghuvanshii Feb 17, 2025
9cab688
Merge branch 'stdlib-js:develop' into levy-quantile
saurabhraghuvanshii Feb 21, 2025
9b266f0
chore: add missing value and revert test.quantile.js
saurabhraghuvanshii Feb 21, 2025
ff6887b
chore: update test.native.js
saurabhraghuvanshii Feb 21, 2025
e0297c5
chore: apply suggestions from code review
Planeshifter Mar 5, 2025
bfb1354
chore: fix indentation
Planeshifter Mar 5, 2025
fb2a9cc
chore: add missing space
Planeshifter Mar 5, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions lib/node_modules/@stdlib/stats/base/dists/levy/quantile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,104 @@ for ( i = 0; i < 10; i++ ) {

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/stats/base/dists/levy/quantile.h"
```

#### stdlib_base_dists_levy_quantile( p, mu, c )

Evaluates the [quantile function][quantile-function] for a [Lévy][levy-distribution] distribution with parameters `mu` (location parameter) and `c` (scale parameter).

```c
double out = stdlib_base_dists_levy_quantile( 0.8, 0.0, 1.0 );
// returns ~15.58
```

The function accepts the following arguments:

- **p**: `[in] double` probability.
- **mu**: `[in] double` location parameter.
- **c**: `[in] double` scale parameter.

```c
double stdlib_base_dists_levy_quantile( const double p, const double mu, const double c );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/stats/base/dists/levy/quantile.h"
#include <stdlib.h>
#include <stdio.h>

static double random_uniform( const double min, const double max ) {
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
return min + ( v*(max-min) );
}

int main( void ) {
double mu;
double p;
double c;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
p = random_uniform( 0.0, 1.0 );
mu = random_uniform( 0.0, 10.0 );
c = random_uniform( 0.0, 10.0 );
y = stdlib_base_dists_levy_quantile( p, mu, c );
printf( "p: %lf, µ: %lf, c: %lf, Q(p;µ,c): %lf\n", p, mu, c, y );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->


<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var Float64Array = require( '@stdlib/array/float64' );
var uniform = require( '@stdlib/random/base/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var EPS = require( '@stdlib/constants/float64/eps' );
var pkg = require( './../package.json' ).name;
Expand All @@ -31,18 +32,26 @@ var quantile = require( './../lib' );
// MAIN //

bench( pkg, function benchmark( b ) {
var len;
var mu;
var c;
var p;
var y;
var i;

len = 100;
p = new Float64Array( len );
mu = new Float64Array( len );
c = new Float64Array( len );
for ( i = 0; i < len; i++ ) {
p[ i ] = uniform( 0.0, 1.0 );
mu[ i ] = uniform( -10.0, 10.0 );
c[ i ] = uniform( EPS, 5.0 );
}

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
p = randu();
mu = ( randu()*20.0 ) - 10.0;
c = ( randu()*5.0 ) + EPS;
y = quantile( p, mu, c );
y = quantile( p[ i % len ], mu[ i % len ], c[ i % len ] );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
Expand All @@ -57,6 +66,7 @@ bench( pkg, function benchmark( b ) {

bench( pkg+':factory', function benchmark( b ) {
var myquantile;
var len;
var mu;
var c;
var p;
Expand All @@ -67,10 +77,16 @@ bench( pkg+':factory', function benchmark( b ) {
c = 4.0;
myquantile = quantile.factory( mu, c );

len = 100;
p = new Float64Array( len );

for ( i = 0; i < len; i++ ) {
p[ i ] = uniform( 0.0, 1.0 );
}

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
p = randu();
y = myquantile( p );
y = myquantile( p[ i % len ] );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var Float64Array = require( '@stdlib/array/float64' );
var tryRequire = require( '@stdlib/utils/try-require' );
var uniform = require( '@stdlib/random/base/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var EPS = require( '@stdlib/constants/float64/eps' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var quantile = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( quantile instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {
var len;
var mu;
var c;
var p;
var y;
var i;

len = 100;
p = new Float64Array( len );
mu = new Float64Array( len );
c = new Float64Array( len );
for ( i = 0; i < len; i++ ) {
p[ i ] = uniform( 0.0, 1.0 );
mu[ i ] = uniform( -10.0, 10.0 );
c[ i ] = uniform( EPS, 5.0 );
}

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = quantile( p[ i % len ], mu[ i % len ], c[ i % len ] );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
#/
# @license Apache-2.0
#
# Copyright (c) 2025 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/

# VARIABLES #

ifndef VERBOSE
QUIET := @
else
QUIET :=
endif

# Determine the OS ([1][1], [2][2]).
#
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
# [2]: http://stackoverflow.com/a/27776822/2225624
OS ?= $(shell uname)
ifneq (, $(findstring MINGW,$(OS)))
OS := WINNT
else
ifneq (, $(findstring MSYS,$(OS)))
OS := WINNT
else
ifneq (, $(findstring CYGWIN,$(OS)))
OS := WINNT
else
ifneq (, $(findstring Windows_NT,$(OS)))
OS := WINNT
endif
endif
endif
endif

# Define the program used for compiling C source files:
ifdef C_COMPILER
CC := $(C_COMPILER)
else
CC := gcc
endif

# Define the command-line options when compiling C files:
CFLAGS ?= \
-std=c99 \
-O3 \
-Wall \
-pedantic

# Determine whether to generate position independent code ([1][1], [2][2]).
#
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
ifeq ($(OS), WINNT)
fPIC ?=
else
fPIC ?= -fPIC
endif

# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
INCLUDE ?=

# List of source files:
SOURCE_FILES ?=

# List of libraries (e.g., `-lopenblas -lpthread`):
LIBRARIES ?=

# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
LIBPATH ?=

# List of C targets:
c_targets := benchmark.out


# RULES #

#/
# Compiles source files.
#
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
# @param {string} [CFLAGS] - C compiler options
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
# @param {string} [SOURCE_FILES] - list of source files
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
#
# @example
# make
#
# @example
# make all
#/
all: $(c_targets)

.PHONY: all

#/
# Compiles C source files.
#
# @private
# @param {string} CC - C compiler (e.g., `gcc`)
# @param {string} CFLAGS - C compiler options
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
# @param {string} SOURCE_FILES - list of source files
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
#/
$(c_targets): %.out: %.c
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)

#/
# Runs compiled benchmarks.
#
# @example
# make run
#/
run: $(c_targets)
$(QUIET) ./$<

.PHONY: run

#/
# Removes generated files.
#
# @example
# make clean
#/
clean:
$(QUIET) -rm -f *.o *.out

.PHONY: clean
Loading