Skip to content

feat: add stats/base/dists/kumaraswamy/stdev #4513

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 26 commits into from
Jun 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
9128f03
feat: add @stdlib/stats/base/dists/kumaraswamy/stdev
ShabiShett07 Jan 3, 2025
44a4fe2
chore: update copyright years
stdlib-bot Jan 3, 2025
526c5dc
remove: multiple examples
ShabiShett07 Apr 4, 2025
52f07eb
chore: add indentation
ShabiShett07 Apr 4, 2025
8081eee
fix: random number generation
ShabiShett07 Apr 4, 2025
ab938e5
fix: random number generation
ShabiShett07 Apr 4, 2025
ed730ad
fix: spelling errors
ShabiShett07 Apr 4, 2025
9a85fc9
fix: spelling errors
ShabiShett07 Apr 4, 2025
fd9c7ff
chore: add private
ShabiShett07 Apr 4, 2025
4493590
chore: add suggestions
ShabiShett07 Apr 4, 2025
076d750
chore: add directories
ShabiShett07 Apr 4, 2025
d4af94e
remove: extra indentations
ShabiShett07 Apr 4, 2025
f19d591
fix: documentation
ShabiShett07 Apr 4, 2025
180a42a
Merge branch 'stdlib-js:develop' into feature/kumaraswamy/stdev
ShabiShett07 Apr 5, 2025
390c0b3
chore: add REQUIRE
ShabiShett07 Apr 5, 2025
28e2d47
chore: add runner.jl
ShabiShett07 Apr 5, 2025
03be5f7
chore: add generated data.json
ShabiShett07 Apr 5, 2025
0acd44c
chore: add fixtures
ShabiShett07 Apr 5, 2025
96f221a
chore: add fixtures
ShabiShett07 Apr 5, 2025
03cdfeb
chore: update copyright years
stdlib-bot Apr 5, 2025
1abbf3d
fix: update benchmark.native.js
ShabiShett07 Apr 5, 2025
c632521
chore: tolerance adjustment
ShabiShett07 Apr 5, 2025
242d976
remove: unused packages
ShabiShett07 Apr 5, 2025
2f7a0ff
Merge remote-tracking branch 'upstream/develop' into feature/kumarasw…
stdlib-bot Jun 23, 2025
2ebcdf4
chore: minor clean-up
Planeshifter Jun 23, 2025
d30b68b
docs: add tolerance explanation in Kumaraswamy `stdev` tests
Planeshifter Jun 23, 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
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,101 @@ 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/kumaraswamy/stdev.h"
```

#### stdlib_base_dists_kumaraswamy_stdev( a, b )

Returns the [standard deviation][standard-deviation] of a [Kumaraswamy's double bounded][kumaraswamy-distribution] distribution with first shape parameter `a` and second shape parameter `b`.

```c
double v = stdlib_base_dists_kumaraswamy_stdev( 0.5, 1.0 );
// returns ~0.298
```

The function accepts the following arguments:

- **a**: `[in] double` first shape parameter.
- **b**: `[in] double` second shape parameter.

```c
double stdlib_base_dists_kumaraswamy_stdev( const double a, const double b );
```

</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/kumaraswamy/stdev.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 a;
double b;
double y;
int i;

for ( i = 0; i < 25; i++ ) {
a = random_uniform( 0.1, 20.0 );
b = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_kumaraswamy_stdev( a, b );
printf( "a: %lf, b: %lf, SD(X;a,b): %lf\n", a, b, y );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- 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. -->

<section class="references">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/**
* @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 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 stdev = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( stdev instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {
var shape1;
var shape2;
var y;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
shape1 = uniform( EPS, 10.0 );
shape2 = uniform( EPS, 10.0 );
y = stdev( shape1, shape2 );
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
Loading