Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -2,6 +2,63 @@
 
 > Package changelog.
 
+<section class="release" id="unreleased">
+
+## Unreleased (2024-12-16)
+
+<section class="features">
+
+### Features
+
+-   [`ad7c388`](https://github.com/stdlib-js/stdlib/commit/ad7c3880af37bccd159b6623f92d4b0212eaf0db) - add C implementation for `stats/base/dists/t/logpdf` [(#3934)](https://github.com/stdlib-js/stdlib/pull/3934)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+### Closed Issues
+
+This release closes the following issue:
+
+[#3873](https://github.com/stdlib-js/stdlib/issues/3873)
+
+</section>
+
+<!-- /.issues -->
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`ad7c388`](https://github.com/stdlib-js/stdlib/commit/ad7c3880af37bccd159b6623f92d4b0212eaf0db) - **feat:** add C implementation for `stats/base/dists/t/logpdf` [(#3934)](https://github.com/stdlib-js/stdlib/pull/3934) _(by Aadish Jain, Philipp Burckhardt)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 2 people contributed to this release. Thank you to the following contributors:
+
+-   Aadish Jain
+-   Philipp Burckhardt
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
 <section class="release" id="v0.2.2">
 
 ## 0.2.2 (2024-07-28)

CHANGELOG.md

@@ -2,11 +2,14 @@
 #
 # Contributors listed in alphabetical order.
 
+Aadish Jain <[email protected]>
 Aayush Khanna <[email protected]>
 Abhijit Raut <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
-AgPriyanshu18 <[email protected]>
+Ahmed Atwa <[email protected]>
+Ahmed Kashkoush <[email protected]>
+Ahmed Khaled <[email protected]>
 Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
 Aman Bhansali <[email protected]>
@@ -45,12 +48,12 @@ Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
 Karthik Prakash <[email protected]>
-Khaldon <[email protected]>
 Kohantika Nath <[email protected]>
 Krishnendu Das <[email protected]>
 Kshitij-Dale <[email protected]>
-Lovelin <[email protected]>
+Lovelin Dhoni J B <[email protected]>
 Manik Sharma <[email protected]>
+Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
 Matt Cochrane <[email protected]>
 Mihir Pandit <[email protected]>
@@ -59,37 +62,40 @@ Mohammad Kaif <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
 Naresh Jagadeesan <[email protected]>
+Naveen Kumar <[email protected]>
 Neeraj Pathak <[email protected]>
-NightKnight <Ahmedatwa866@yahoo.com>
+Nishant Shinde <[email protected].com>
 Nithin Katta <[email protected]>
 Nourhan Hasan <[email protected]>
 Ognjen Jevremović <[email protected]>
 Oneday12323 <[email protected]>
+Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
-Praneki <[email protected]>
-Pratik <[email protected]>
+Pranjal Jha <[email protected]>
+Pratik Singh <[email protected]>
 Pratyush Kumar Chouhan <[email protected]>
-Priyansh <[email protected]>
+Priyansh Prajapati <[email protected]>
+Priyanshu Agarwal <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
-RISHAV <[email protected]>
 Raunak Kumar Gupta <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
 Ridam Garg <[email protected]>
+Rishav <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
-Rutam <[email protected]>
+Rutam Kathale <[email protected]>
 Ruthwik Chikoti <[email protected]>
 Ryan Seal <[email protected]>
 Rylan Yang <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
-SarthakPaandey <[email protected]>
+Sarthak Paandey <[email protected]>
 Saurabh Singh <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shashank Shekhar Singh <[email protected]>
-Shivam <[email protected]>
+Shivam Ahir <[email protected]>
 Shraddheya Shendre <[email protected]>
 Shubh Mehta <[email protected]>
 Shubham Mishra <[email protected]>
@@ -98,7 +104,7 @@ Snehil Shah <[email protected]>
 Soumajit Chatterjee <[email protected]>
 Spandan Barve <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
-Suraj kumar <[email protected]>
+Suraj Kumar <[email protected]>
 Tirtadwipa Manunggal <[email protected]>
 Tudor Pagu <[email protected]>
 Tufailahmed Bargir <[email protected]>
@@ -108,12 +114,10 @@ UtkershBasnet <[email protected]>
 Vaibhav Patel <[email protected]>
 Varad Gupta <[email protected]>
 Vinit Pandit <[email protected]>
+Vivek maurya <[email protected]>
 Xiaochuan Ye <[email protected]>
+Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
-naveen <[email protected]>
-nishant-s7 <[email protected]>
 olenkabilonizhka <[email protected]>
-orimiles5 <[email protected]>
 rainn <[email protected]>
 rei2hu <[email protected]>
-yaswanth <[email protected]>

CONTRIBUTORS

@@ -175,6 +175,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/t/logpdf.h"
+```
+
+#### stdlib_base_dists_t_logpdf( x, a, b )
+
+Evaluates the natural logarithm of the [PDF][pdf] for a [Student's t][t-distribution] distribution with degree of freedom `v`.
+
+```c
+double out = stdlib_base_dists_t_logpdf( 0.5, 1.0 );
+// returns ~-1.368
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] double` input value.
+-   **v**: `[in] double` degrees of freedom.
+
+```c
+double stdlib_base_dists_t_logpdf( const double x, const double v );
+```
+
+</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/t/logpdf.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 x;
+    double v;
+    double y;
+    int i;
+    
+    for ( i = 0; i < 25; i++ ) {
+        x = random_uniform( -10.0, 10.0 );
+        v = random_uniform( 1.0, 100.0 );
+        y = stdlib_base_dists_t_logpdf( x, v );
+        printf( "x: %lf, v: %lf, logPDF(x;v): %lf\n", x, v, y );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">

README.md

@@ -21,7 +21,8 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-var ceil = require( '@stdlib/math-base-special-ceil' );
+var Float64Array = require( '@stdlib/array-float64' );
+var uniform = require( '@stdlib/random-array-uniform' );
 var randu = require( '@stdlib/random-base-randu' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pkg = require( './../package.json' ).name;
@@ -31,16 +32,23 @@ var logpdf = require( './../lib' );
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
-	var v;
+	var len;
 	var x;
+	var v;
 	var y;
 	var i;
 
+	len = 100;
+	x = new Float64Array( len );
+	v = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		x[ i ] = ( randu() * 20.0 ) - 10.0;
+		v[ i ] = ( randu() * 100.0 ) + 1.0; // degrees of freedom > 0
+	}
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu()*100.0 ) - 100;
-		v = ceil( randu()*100.0 );
-		y = logpdf( x, v );
+		y = logpdf( x[ i % len ], v[ i % len ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
@@ -53,20 +61,20 @@ bench( pkg, function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':factory', function benchmark( b ) {
-	var mypdf;
+bench( pkg + ':factory', function benchmark( b ) {
+	var mylogpdf;
 	var v;
 	var x;
 	var y;
 	var i;
 
-	v = 3.0;
-	mypdf = logpdf.factory( v );
+	v = 10.0;
+	mylogpdf = logpdf.factory( v );
+	x = uniform( 100, -2.0, 2.0 );
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu()*100.0 ) - 50.0;
-		y = mypdf( x );
+		y = mylogpdf( x[ i % x.length ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}