feat: add C implementation for stats/base/dists/planck/stdev

.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

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

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

.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 <[email protected]>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

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

.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 <[email protected]>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

.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 <[email protected]>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

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

.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 <[email protected]>'
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

.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 <[email protected]>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

.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 <[email protected]>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             automated-pr
           team-reviewers: |

lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md

@@ -120,6 +120,95 @@ 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/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 );
+```
+
+</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/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 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 );
+	}
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">

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' );
 		}

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();
+});