From 2e501cdc84fa16f0ce0e44055b49951cfd91d6a8 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 26 Jan 2025 10:20:52 -0500 Subject: [PATCH 1/5] build: tweak permissions and use fine-grained PAT --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .github/workflows/do_not_merge.yml | 3 +- .github/workflows/first_time_greeting.yml | 6 +- .github/workflows/make.yml | 3 + .github/workflows/markdown_equations.yml | 6 +- .github/workflows/markdown_links.yml | 3 + .github/workflows/markdown_pkg_urls.yml | 8 +- .../workflows/markdown_related_packages.yml | 5 +- .github/workflows/markdown_src_attributes.yml | 5 +- .github/workflows/markdown_tocs.yml | 5 +- .github/workflows/namespace_declarations.yml | 5 +- .github/workflows/namespace_exports.yml | 5 +- .../stats/base/dists/planck/stdev/README.md | 89 +++++++++ .../dists/planck/stdev/benchmark/benchmark.js | 12 +- .../stdev/benchmark/benchmark.native.js | 67 +++++++ .../dists/planck/stdev/benchmark/c/Makefile | 146 +++++++++++++++ .../planck/stdev/benchmark/c/benchmark.c | 138 ++++++++++++++ .../stats/base/dists/planck/stdev/binding.gyp | 170 ++++++++++++++++++ .../dists/planck/stdev/examples/c/Makefile | 146 +++++++++++++++ .../dists/planck/stdev/examples/c/example.c | 38 ++++ .../base/dists/planck/stdev/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/planck/stdev.h | 38 ++++ .../base/dists/planck/stdev/lib/native.js | 57 ++++++ .../base/dists/planck/stdev/manifest.json | 91 ++++++++++ .../base/dists/planck/stdev/package.json | 3 + .../base/dists/planck/stdev/src/Makefile | 70 ++++++++ .../stats/base/dists/planck/stdev/src/addon.c | 23 +++ .../stats/base/dists/planck/stdev/src/main.c | 41 +++++ .../dists/planck/stdev/test/test.native.js | 90 ++++++++++ 28 files changed, 1309 insertions(+), 17 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/stdev/test/test.native.js diff --git a/.github/workflows/do_not_merge.yml b/.github/workflows/do_not_merge.yml index 4f8154e81155..9afe2a559e70 100644 --- a/.github/workflows/do_not_merge.yml +++ b/.github/workflows/do_not_merge.yml @@ -43,8 +43,7 @@ jobs: # Define job permissions: permissions: - contents: read - pull-requests: write + pull-requests: read # Define the type of virtual host machine: runs-on: ubuntu-latest diff --git a/.github/workflows/first_time_greeting.yml b/.github/workflows/first_time_greeting.yml index 7fe2362f40d6..c6fc4a1fb583 100644 --- a/.github/workflows/first_time_greeting.yml +++ b/.github/workflows/first_time_greeting.yml @@ -24,8 +24,8 @@ on: [pull_request_target, issues] # Global permissions: permissions: - # Allow read-only access to the repository contents: - contents: read + # Do not give the workflow any permissions: + contents: none # Workflow jobs: jobs: @@ -47,7 +47,7 @@ jobs: # Pin action to full length commit SHA uses: actions/first-interaction@34f15e814fe48ac9312ccf29db4e74fa767cbab7 # v1.3.0 with: - repo-token: ${{ secrets.CHATBOT_GITHUB_TOKEN }} + repo-token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }} issue-message: | :wave: Hi there! :wave: diff --git a/.github/workflows/make.yml b/.github/workflows/make.yml index 2eb892270f61..93aed441f737 100644 --- a/.github/workflows/make.yml +++ b/.github/workflows/make.yml @@ -64,6 +64,9 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false timeout-minutes: 10 # Install Node.js: diff --git a/.github/workflows/markdown_equations.yml b/.github/workflows/markdown_equations.yml index c81fb38d564f..ba34df033d32 100644 --- a/.github/workflows/markdown_equations.yml +++ b/.github/workflows/markdown_equations.yml @@ -64,6 +64,9 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false timeout-minutes: 10 # Install Node.js: @@ -103,7 +106,6 @@ jobs: git_user_signingkey: true git_commit_gpgsign: true - # Generate list of changed Markdown files: - name: 'Find changed Markdown files' run: | @@ -161,7 +163,7 @@ jobs: commit-message: 'docs: update Markdown equation elements' committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>' signoff: true - token: ${{ secrets.PULL_REQUEST_TOKEN }} + token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }} labels: | documentation automated-pr diff --git a/.github/workflows/markdown_links.yml b/.github/workflows/markdown_links.yml index 859df66cb91c..4acad4751a6e 100644 --- a/.github/workflows/markdown_links.yml +++ b/.github/workflows/markdown_links.yml @@ -76,6 +76,9 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false timeout-minutes: 10 # Initialize log files: diff --git a/.github/workflows/markdown_pkg_urls.yml b/.github/workflows/markdown_pkg_urls.yml index ba046255d4c7..12dc2eefe566 100644 --- a/.github/workflows/markdown_pkg_urls.yml +++ b/.github/workflows/markdown_pkg_urls.yml @@ -70,6 +70,10 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false + timeout-minutes: 10 # Install Node.js: @@ -131,7 +135,7 @@ jobs: fi timeout-minutes: 10 - # Create a pull request with the changes: + # Create a pull request with the changes: - name: 'Create pull request' id: cpr if: steps.update-markdown-pkg-urls.outputs.changed == 'true' @@ -147,7 +151,7 @@ jobs: commit-message: 'docs: update Markdown stdlib package URLs' committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>' signoff: true - token: ${{ secrets.PULL_REQUEST_TOKEN }} + token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }} labels: | documentation automated-pr diff --git a/.github/workflows/markdown_related_packages.yml b/.github/workflows/markdown_related_packages.yml index 27a9ce553106..1440cf13d616 100644 --- a/.github/workflows/markdown_related_packages.yml +++ b/.github/workflows/markdown_related_packages.yml @@ -68,6 +68,9 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false timeout-minutes: 10 # Install Node.js: @@ -159,7 +162,7 @@ jobs: commit-message: 'docs: update related packages sections' committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>' signoff: true - token: ${{ secrets.PULL_REQUEST_TOKEN }} + token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }} labels: | documentation automated-pr diff --git a/.github/workflows/markdown_src_attributes.yml b/.github/workflows/markdown_src_attributes.yml index c2cb872c2946..b90263061b03 100644 --- a/.github/workflows/markdown_src_attributes.yml +++ b/.github/workflows/markdown_src_attributes.yml @@ -23,7 +23,7 @@ name: markdown_src_attributes on: schedule: # Run the workflow once a month on the 1st day of every month: - - cron: "0 0 1 * *" + - cron: '0 0 1 * *' # Allow the workflow to be manually run: workflow_dispatch: @@ -73,6 +73,9 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false timeout-minutes: 10 # Initialize log files: diff --git a/.github/workflows/markdown_tocs.yml b/.github/workflows/markdown_tocs.yml index 7700f60b90dc..f5bee73649e7 100644 --- a/.github/workflows/markdown_tocs.yml +++ b/.github/workflows/markdown_tocs.yml @@ -64,6 +64,9 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false timeout-minutes: 10 # Install Node.js: @@ -129,7 +132,7 @@ jobs: commit-message: 'docs: update namespace table of contents' signoff: true committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>' - token: ${{ secrets.PULL_REQUEST_TOKEN }} + token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }} labels: | documentation automated-pr diff --git a/.github/workflows/namespace_declarations.yml b/.github/workflows/namespace_declarations.yml index 0da71e94c179..49dcc3f2574e 100644 --- a/.github/workflows/namespace_declarations.yml +++ b/.github/workflows/namespace_declarations.yml @@ -64,6 +64,9 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false timeout-minutes: 10 # Install Node.js: @@ -124,7 +127,7 @@ jobs: commit-message: 'feat: update namespace TypeScript declarations' committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>' signoff: true - token: ${{ secrets.PULL_REQUEST_TOKEN }} + token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }} labels: | documentation automated-pr diff --git a/.github/workflows/namespace_exports.yml b/.github/workflows/namespace_exports.yml index 1e2c892847b1..e4995b1fd71f 100644 --- a/.github/workflows/namespace_exports.yml +++ b/.github/workflows/namespace_exports.yml @@ -60,6 +60,9 @@ jobs: # Specify whether to download Git-LFS files: lfs: false + + # Avoid storing GitHub token in local Git configuration: + persist-credentials: false timeout-minutes: 10 # Install Node.js: @@ -136,7 +139,7 @@ jobs: commit-message: 'feat: update namespace exports' committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>' signoff: true - token: ${{ secrets.PULL_REQUEST_TOKEN }} + token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }} labels: | automated-pr team-reviewers: | diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md index d5d35e892b8a..282ebe93fa90 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md @@ -120,6 +120,95 @@ for ( i = 0; i < lambda.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/planck/stdev.h" +``` + +#### stdlib_base_dists_planck_stdev( lambda ) + +Evaluates the standard deviation for an planck distribution. + +```c +double out = stdlib_base_dists_planck_stdev( 0.1 ); +// returns ~9.9958 +``` + +The function accepts the following arguments: + +- **lambda**: `[in] double` shape parameter. + +```c +double stdlib_base_dists_planck_stdev( const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples +```c +#include "stdlib/stats/base/dists/planck/stdev.h" +#include +#include +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_stdev( lambda ); + printf( "lambda: %lf, Standard Deviation: %lf\n", lambda, y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js index e3477d4b70f9..4ac9c109eca5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js @@ -21,7 +21,8 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/array/uniform' ); +var randu = require( '@stdlib/random/base/randu' ); +var Float64Array = require( '@stdlib/array/float64' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; var stdev = require( './../lib' ); @@ -31,14 +32,19 @@ var stdev = require( './../lib' ); bench( pkg, function benchmark( b ) { var lambda; + var len; var y; var i; - lambda = uniform( 100, 0.1, 10.0 ); + len = 100; + lambda = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + lambda[ i ] = ( randu() * 10.0 ) + 1.0; + } b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = stdev( lambda[ i % lambda.length ] ); + y = stdev( lambda[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js new file mode 100644 index 000000000000..28db164bd9a6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js @@ -0,0 +1,67 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 randu = require( '@stdlib/random/base/randu' ); +var Float64Array = require( '@stdlib/array/float64' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +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 lambda; + var len; + var y; + var i; + + len = 100; + lambda = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + lambda[ i ] = ( randu() * 10.0 ) + 1.0; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = stdev( 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(); +}); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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 diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/benchmark.c new file mode 100644 index 000000000000..6d114ad6e018 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/benchmark.c @@ -0,0 +1,138 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/stats/base/dists/planck/stdev.h" +#include +#include +#include +#include +#include + +#define NAME "planck-stdev" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmark results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec / 1.0e6; +} + +/** +* Generates a random number on the interval [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ((double)RAND_MAX + 1.0); + return min + (v * (max - min)); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double lambda[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + lambda[i] = random_uniform( 0.1, 10.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_planck_stdev( lambda[ i % 100 ] ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i + 1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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 := example.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 examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/example.c new file mode 100644 index 000000000000..1361036c532b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/example.c @@ -0,0 +1,38 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/stats/base/dists/planck/stdev.h" +#include +#include + +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_stdev( lambda ); + printf( "lambda: %lf, stdev: %lf\n", lambda, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' Date: Tue, 28 Jan 2025 17:16:43 +0530 Subject: [PATCH 2/5] Readme update --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../stats/base/dists/planck/stdev/README.md | 3 +- .../dists/planck/stdev/benchmark/benchmark.js | 4 +- .../stdev/benchmark/benchmark.native.js | 6 +- .../stdlib/stats/base/dists/planck/stdev.h | 2 +- .../base/dists/planck/stdev/manifest.json | 176 +++++++++--------- .../stats/base/dists/planck/stdev/src/main.c | 2 +- 6 files changed, 97 insertions(+), 96 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md index 12a426dd8a08..5e7ecde91b23 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md @@ -148,7 +148,7 @@ for ( i = 0; i < lambda.length; i++ ) { #### stdlib_base_dists_planck_stdev( lambda ) -Evaluates the standard deviation for an planck distribution. +Returns the standard deviation of a Planck distribution with shape parameter `λ`. ```c double out = stdlib_base_dists_planck_stdev( 0.1 ); @@ -180,6 +180,7 @@ double stdlib_base_dists_planck_stdev( const double lambda );
### Examples + ```c #include "stdlib/stats/base/dists/planck/stdev.h" #include diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js index 4ac9c109eca5..d161e7added3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js @@ -21,7 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var Float64Array = require( '@stdlib/array/float64' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; @@ -39,7 +39,7 @@ bench( pkg, function benchmark( b ) { len = 100; lambda = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - lambda[ i ] = ( randu() * 10.0 ) + 1.0; + lambda[ i ] = uniform(0.1, 11); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js index 28db164bd9a6..724031c81c30 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js @@ -22,7 +22,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var Float64Array = require( '@stdlib/array/float64' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -39,7 +39,7 @@ var opts = { // MAIN // -bench( pkg+'::native', opts , function benchmark( b ) { +bench( pkg+'::native', opts, function benchmark( b ) { var lambda; var len; var y; @@ -48,7 +48,7 @@ bench( pkg+'::native', opts , function benchmark( b ) { len = 100; lambda = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - lambda[ i ] = ( randu() * 10.0 ) + 1.0; + lambda[ i ] = uniform(0.1, 11); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h index cb47ee71b16f..0d58cb9b9406 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the standard deviation (stdev) for an planck distribution with shape parameter lambda. +* Returns the standard deviation of a Planck distribution with shape parameter `λ`. */ double stdlib_base_dists_planck_stdev( const double lambda ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json index 2297be74fa17..6c36869ace98 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json @@ -1,91 +1,91 @@ { - "options": { + "options": { + "task": "build", + "wasm": false + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { "task": "build", - "wasm": false + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/unary", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/expm1", + "@stdlib/math/base/special/sqrt", + "@stdlib/math/base/special/exp", + "@stdlib/constants/float64/pi" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/expm1", + "@stdlib/math/base/special/sqrt", + "@stdlib/math/base/special/exp", + "@stdlib/constants/float64/pi" + ] }, - "fields": [ - { - "field": "src", - "resolve": true, - "relative": true - }, - { - "field": "include", - "resolve": true, - "relative": true - }, - { - "field": "libraries", - "resolve": false, - "relative": false - }, - { - "field": "libpath", - "resolve": true, - "relative": false - } - ], - "confs": [ - { - "task": "build", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/napi/unary", - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/abs", - "@stdlib/math/base/special/expm1", - "@stdlib/math/base/special/sqrt", - "@stdlib/math/base/special/exp", - "@stdlib/constants/float64/pi" - ] - }, - { - "task": "benchmark", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/abs", - "@stdlib/math/base/special/expm1", - "@stdlib/math/base/special/sqrt", - "@stdlib/math/base/special/exp", - "@stdlib/constants/float64/pi" - ] - }, - { - "task": "examples", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/abs", - "@stdlib/math/base/special/expm1", - "@stdlib/math/base/special/sqrt", - "@stdlib/math/base/special/exp", - "@stdlib/constants/float64/pi" - ] - } - ] - } + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/expm1", + "@stdlib/math/base/special/sqrt", + "@stdlib/math/base/special/exp", + "@stdlib/constants/float64/pi" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c index 996e50bf7475..2063b3b008ca 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c @@ -23,7 +23,7 @@ #include "stdlib/math/base/special/sqrt.h" /** -* Evaluates the standard deviation of a Planck distribution given a shape parameter `lambda`. +* Returns the standard deviation of a Planck distribution with shape parameter `λ`. * * @param lambda shape parameter * @return standard deviation From af9929fc9b7a8baeb09655476a19563bce6ed8de Mon Sep 17 00:00:00 2001 From: yuvi-mittal Date: Sun, 2 Feb 2025 16:04:21 +0530 Subject: [PATCH 3/5] update boundary condition --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../stats/base/dists/planck/stdev/benchmark/benchmark.js | 2 +- .../@stdlib/stats/base/dists/planck/stdev/src/main.c | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js index d161e7added3..ed279f16d183 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js @@ -39,7 +39,7 @@ bench( pkg, function benchmark( b ) { len = 100; lambda = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - lambda[ i ] = uniform(0.1, 11); + lambda[ i ] = uniform(1, 11); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c index 2063b3b008ca..c80d53ecc6c0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c @@ -36,6 +36,5 @@ double stdlib_base_dists_planck_stdev( const double lambda ) { if ( stdlib_base_is_nan( lambda ) || lambda <= 0.0 ) { return 0.0/0.0; // NaN } - double exp_lambda = stdlib_base_exp( -lambda ) ; - return stdlib_base_sqrt( exp_lambda ) / stdlib_base_abs( stdlib_base_expm1( -lambda ) ); + return stdlib_base_sqrt( stdlib_base_exp( -lambda ) ) / stdlib_base_abs( stdlib_base_expm1( -lambda ) ); } From b902aaa9ecb17e80f913fca1fdadd6abacae7eac Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 15 Feb 2025 14:58:53 -0500 Subject: [PATCH 4/5] chore: minor clean-up --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/planck/stdev/README.md | 4 +++- .../base/dists/planck/stdev/benchmark/benchmark.js | 2 +- .../dists/planck/stdev/benchmark/benchmark.native.js | 4 ++-- .../stats/base/dists/planck/stdev/benchmark/c/Makefile | 2 +- .../base/dists/planck/stdev/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/planck/stdev/binding.gyp | 2 +- .../stats/base/dists/planck/stdev/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/planck/stdev/include.gypi | 2 +- .../include/stdlib/stats/base/dists/planck/stdev.h | 2 +- .../stats/base/dists/planck/stdev/lib/native.js | 3 ++- .../stats/base/dists/planck/stdev/manifest.json | 9 +++------ .../@stdlib/stats/base/dists/planck/stdev/src/Makefile | 2 +- .../@stdlib/stats/base/dists/planck/stdev/src/addon.c | 2 +- .../@stdlib/stats/base/dists/planck/stdev/src/main.c | 4 ++-- .../stats/base/dists/planck/stdev/test/test.native.js | 10 +++++----- 15 files changed, 26 insertions(+), 26 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md index 5e7ecde91b23..2bd3ab9b0e23 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md @@ -185,10 +185,12 @@ double stdlib_base_dists_planck_stdev( const double lambda ); #include "stdlib/stats/base/dists/planck/stdev.h" #include #include + 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; @@ -197,7 +199,7 @@ int main( void ) { for ( i = 0; i < 25; i++ ) { lambda = random_uniform( 0.1, 10.0 ); y = stdlib_base_dists_planck_stdev( lambda ); - printf( "lambda: %lf, Standard Deviation: %lf\n", lambda, y ); + printf( "λ: %lf, SD(X;λ): %lf\n", lambda, y ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js index ed279f16d183..fe1ea89ff2e0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js @@ -39,7 +39,7 @@ bench( pkg, function benchmark( b ) { len = 100; lambda = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - lambda[ i ] = uniform(1, 11); + lambda[ i ] = uniform( 1.0, 11.0 ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js index 724031c81c30..85f33fba8002 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -48,7 +48,7 @@ bench( pkg+'::native', opts, function benchmark( b ) { len = 100; lambda = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - lambda[ i ] = uniform(0.1, 11); + lambda[ i ] = uniform( 0.1, 11.0 ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/benchmark.c index 6d114ad6e018..6a27adafedfe 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/benchmark.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/binding.gyp @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/example.c index 1361036c532b..10c0677a896b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/example.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include.gypi @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h index 0d58cb9b9406..6911b7603188 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/lib/native.js index af15cda55364..4e9760920ce8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/lib/native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -22,6 +22,7 @@ var addon = require( './../src/addon.node' ); + // MAIN // /** diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json index 6c36869ace98..f35d5e61a0be 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json @@ -43,8 +43,7 @@ "@stdlib/math/base/special/abs", "@stdlib/math/base/special/expm1", "@stdlib/math/base/special/sqrt", - "@stdlib/math/base/special/exp", - "@stdlib/constants/float64/pi" + "@stdlib/math/base/special/exp" ] }, { @@ -63,8 +62,7 @@ "@stdlib/math/base/special/abs", "@stdlib/math/base/special/expm1", "@stdlib/math/base/special/sqrt", - "@stdlib/math/base/special/exp", - "@stdlib/constants/float64/pi" + "@stdlib/math/base/special/exp" ] }, { @@ -83,8 +81,7 @@ "@stdlib/math/base/special/abs", "@stdlib/math/base/special/expm1", "@stdlib/math/base/special/sqrt", - "@stdlib/math/base/special/exp", - "@stdlib/constants/float64/pi" + "@stdlib/math/base/special/exp" ] } ] diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/addon.c index bb6e7262ff89..1f279a1a712f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c index c80d53ecc6c0..ab0d895b6161 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -23,7 +23,7 @@ #include "stdlib/math/base/special/sqrt.h" /** -* Returns the standard deviation of a Planck distribution with shape parameter `λ`. +* Returns the standard deviation of a Planck distribution with shape parameter `λ`. * * @param lambda shape parameter * @return standard deviation diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/test/test.native.js index c94bd513b724..2bcecbe68ad5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/test/test.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. @@ -43,19 +43,19 @@ var opts = { // TESTS // -tape( 'main export is a function', opts , function test( t ) { +tape( 'main export is a function', opts, function test( t ) { t.ok( true, __filename ); t.strictEqual( typeof stdev, 'function', 'main export is a function' ); t.end(); }); -tape( 'if provided `NaN` for `lambda`, the function returns `NaN`', opts , function test( t ) { +tape( 'if provided `NaN` for `lambda`, the function returns `NaN`', opts, function test( t ) { var v = stdev( NaN ); t.equal( isnan( v ), true, 'returns expected value' ); t.end(); }); -tape( 'if provided a shape parameter `lambda` which is nonpositive, the function returns `NaN`', opts , function test( t ) { +tape( 'if provided a shape parameter `lambda` which is nonpositive, the function returns `NaN`', opts, function test( t ) { var v; v = stdev( 0.0 ); @@ -66,7 +66,7 @@ tape( 'if provided a shape parameter `lambda` which is nonpositive, the function t.end(); }); -tape( 'the function returns the standard deviation of a Planck distribution', opts , function test( t ) { +tape( 'the function returns the standard deviation of a Planck distribution', opts, function test( t ) { var expected; var lambda; var delta; From 13831afaa816530cebbe07e9e6526b6315ef9532 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 15 Feb 2025 15:04:14 -0500 Subject: [PATCH 5/5] chore: update copyright year to 2025 --- .../@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/examples/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# 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.