Skip to content

feat: add C implementation for stats/base/dists/planck/mode #4911

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 21, 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
501db1b
docs: update related packages sections
stdlib-bot Jan 17, 2025
ade24eb
Add C implementation for @stdlib/stats/base/dists/planck/mode
yuvi-mittal Jan 26, 2025
7f7fb0b
Add C implementation for @stdlib/stats/base/dists/planck/mode
yuvi-mittal Jan 26, 2025
34f87cd
changed file back to normal
yuvi-mittal Feb 11, 2025
16e153a
removed unnecccesary file
yuvi-mittal Feb 11, 2025
4770cb7
updated doc
yuvi-mittal Feb 11, 2025
d73c94a
updated doc
yuvi-mittal Feb 11, 2025
fd0b871
chore: update copyright years
stdlib-bot Feb 15, 2025
7d04c37
fix: remove unused dependencies from `planck/mode`
Planeshifter Jun 20, 2025
17530a4
style: fix spacing in C benchmark for `planck/mode`
Planeshifter Jun 20, 2025
005841f
bench: revert changes
Planeshifter Jun 20, 2025
a346308
chore: minor clean-up
Planeshifter Jun 20, 2025
eeab1f8
style: add spaces
kgryte Jun 20, 2025
5efe346
docs: fix missing decimal
kgryte Jun 20, 2025
8f1ea70
style: fix missing decimal
kgryte Jun 20, 2025
69d14e1
style: combine declaration and assignment
kgryte Jun 20, 2025
da3e1d0
style: fix return annotation
kgryte Jun 20, 2025
bbc40fa
docs: fix missing decimals
kgryte Jun 20, 2025
d22e4e6
Merge remote-tracking branch 'upstream/develop' into feature/planck-mode
stdlib-bot Jun 20, 2025
e814dcc
build: fix file path
kgryte Jun 21, 2025
9bd4845
build: fix path
kgryte Jun 21, 2025
d05d27a
docs: fix missing space
kgryte Jun 21, 2025
8684cf9
docs: remove space
kgryte Jun 21, 2025
d2ff484
docs: fix space
kgryte Jun 21, 2025
6627e0e
docs: remove space
kgryte Jun 21, 2025
05afdf3
style: add empty line
Planeshifter Jun 21, 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
95 changes: 93 additions & 2 deletions lib/node_modules/@stdlib/stats/base/dists/planck/mode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ Returns the [mode][mode] of a Planck distribution with shape parameter `lambda`.

```javascript
var v = mode( 0.1 );
// returns 0
// returns 0.0

v = mode( 1.5 );
// returns 0
// returns 0.0
```

If provided a shape parameter `lambda` is nonpositive or `NaN`, the function returns `NaN`.
Expand Down Expand Up @@ -118,6 +118,97 @@ for ( i = 0; i < lambda.length; i++ ) {

<!-- /.references -->

<!-- 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/planck/mode.h"
```

#### stdlib_base_dists_planck_mode( lambda )

Returns the [mode][mode] of a Planck distribution with shape parameter `lambda`.

```c
double out = stdlib_base_dists_planck_mode( 0.1 );
// returns 0.0
```

The function accepts the following arguments:

- **lambda**: `[in] double` shape parameter.

```c
double stdlib_base_dists_planck_mode( const double lambda );
```

</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/planck/mode.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 lambda;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
lambda = random_uniform( 0.1, 10.0 );
y = stdlib_base_dists_planck_mode( lambda );
printf( "lambda: %lf, mode(X;λ): %lf\n", lambda, 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
@@ -0,0 +1,67 @@
/**
* @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 uniform = require( '@stdlib/random/base/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

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


// MAIN //

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

len = 100;
lambda = new Float64Array( len );
for ( i = 0; i < len; i++ ) {
lambda[ i ] = uniform( 0.1, 11.0 );
}

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = mode( lambda[ 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