Auto-generated commit

Author: stdlib-bot

.gitignore

@@ -188,7 +188,12 @@ jsconfig.json
 # Other editor files #
 ######################
 .idea/
-
-# Cursor #
-##########
+.cursor
 .cursorignore
+.windsurfrules
+.clinerules
+
+# AI coding agents #
+####################
+CLAUDE.md
+GEMINI.md

CHANGELOG.md

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-09-01)
+## Unreleased (2025-11-07)
 
 <section class="features">
 
 ### Features
 
+-   [`f114dad`](https://github.com/stdlib-js/stdlib/commit/f114dad17c4ab240701b7c67aeb313aac7831eb7) - update `number/float64/base/assert` TypeScript declarations
 -   [`0cf2dd6`](https://github.com/stdlib-js/stdlib/commit/0cf2dd65ae1a209d306184a82c4226742bfa6103) - add `isAlmostEqual` exports to namespaces
 -   [`d10932c`](https://github.com/stdlib-js/stdlib/commit/d10932c2a1f70d4b26332abd0bc80ea09848618a) - add `number/float64/base/assert/is-almost-equal`
 -   [`e38f5ec`](https://github.com/stdlib-js/stdlib/commit/e38f5ecf382db6ed19fc3b66d75801fbf9909843) - add `number/float64/base/assert/is-almost-equal-value` [(#7473)](https://github.com/stdlib-js/stdlib/pull/7473)
@@ -24,6 +25,8 @@
 
 <details>
 
+-   [`5f5bb2d`](https://github.com/stdlib-js/stdlib/commit/5f5bb2d4277a24000b57fb07bc28d821500cd7e8) - **docs:** update namespace table of contents [(#8425)](https://github.com/stdlib-js/stdlib/pull/8425) _(by stdlib-bot, Athan Reines)_
+-   [`f114dad`](https://github.com/stdlib-js/stdlib/commit/f114dad17c4ab240701b7c67aeb313aac7831eb7) - **feat:** update `number/float64/base/assert` TypeScript declarations _(by Philipp Burckhardt)_
 -   [`0cf2dd6`](https://github.com/stdlib-js/stdlib/commit/0cf2dd65ae1a209d306184a82c4226742bfa6103) - **feat:** add `isAlmostEqual` exports to namespaces _(by Philipp Burckhardt)_
 -   [`7483bef`](https://github.com/stdlib-js/stdlib/commit/7483bef13b1d3241347266d25a02957269419825) - **test:** use .strictEqual() instead of .equal() _(by Philipp Burckhardt)_
 -   [`6eee151`](https://github.com/stdlib-js/stdlib/commit/6eee15199727d04e3757e66f38384e97b8a333da) - **style:** fix indentation in JSON files _(by Philipp Burckhardt)_

CONTRIBUTORS

@@ -3,7 +3,7 @@
 # Contributors listed in alphabetical order.
 
 Aadish Jain <[email protected]>
-Aarya Balwadkar <[email protected].com>
+Aarya Balwadkar <aaryabalwadkar2005@gmail.com>
 Aayush Khanna <[email protected]>
 Abdelrahman Samir <[email protected]>
 Abdul Kaium <[email protected]>
@@ -20,23 +20,23 @@ Ahmed Khaled <[email protected]>
 Aksshay Balasubramanian <[email protected]>
 Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
-AlyAbdelmoneim <[email protected]>
-Aman Bhansali <[email protected]>
-AmanBhadkariya <[email protected].com>
-Amisha Chhajed <[email protected].com>
+Aly Abdelmoneim <[email protected]>
+Aman Bhadkariya <[email protected]>
+Aman Bhansali <amanbhansali65@gmail.com>
+Amisha Chhajed <amishhhaaaa@gmail.com>
 Amit Jimiwal <[email protected]>
-Anmol Sah <[email protected].com>
+Anmol Sah <annifind010@gmail.com>
 Annamalai Prabu <[email protected]>
-Anshu Kumar <[email protected]>
 Anshu Kumar <[email protected]>
+Anshuman Singh <[email protected]>
 Anudeep Sanapala <[email protected]>
 Arihant Pal <[email protected]>
 Aryan Bhirud <[email protected]>
-AryanJ18 <[email protected]>
+Aryan J <[email protected]>
 Athan Reines <[email protected]>
-Atharva Patil <[email protected].com>
-Ayaka <[email protected].com>
-Bhavishy Agrawal <[email protected]>
+Atharva Patil <anpatil.1223@gmail.com>
+Bhavishy Agrawal <bhavishyrocker2801@gmail.com>
+Bhupesh Kumar <[email protected]>
 Brendan Graetz <[email protected]>
 Bruno Fenzl <[email protected]>
 Bryan Elee <[email protected]>
@@ -47,68 +47,77 @@ Daniel Hernandez Gomez <[email protected]>
 Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
 Debashis Maharana <[email protected]>
-Deep Trivedi <[email protected].com>
+Deep Trivedi <deepbtrivedi04@gmail.com>
 Deepak Singh <[email protected]>
 Deepak Singh <[email protected]>
-Desh Deepak Kant <[email protected].com>
+Desh Deepak Kant <deshdeepakkant@gmail.com>
 Dev Goel <[email protected]>
-Dhanyabad behera <[email protected]>
+Devshree Bhati <[email protected]>
+Dhanyabad Behera <[email protected]>
 Dhruv Arvind Singh <[email protected]>
-Dhruvil Mehta <[email protected]>
-Dipjyoti Das <[email protected]>
-Divyansh Seth <[email protected]>
+Dhruvil Mehta <[email protected]>
+Dipjyoti Das <[email protected]>
+Ditsu S <[email protected]>
+Divyansh Seth <[email protected]>
 Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
-EuniceSim142 <[email protected]>
+Dudhat Hemil Pravinkumar <[email protected]>
+Ekampreet Singh Bains <[email protected]>
+Eunice Sim <[email protected]>
+Fadio <[email protected]>
 Frank Kovacs <[email protected]>
-GK Bishnoi <[email protected]>
-GURU PRASAD SHARMA <[email protected]>
-Gaurav <[email protected]>
+Gaurav Jadhav <[email protected]>
+Gaurav Kaushik <[email protected]>
 Gautam Kaushik <[email protected]>
 Gautam sharma <[email protected]>
-GeoDaoyu <[email protected]>
+Geo Daoyu <[email protected]>
 Girish Garg <[email protected]>
+Gitty Harsha <[email protected]>
 Golden Kumar <[email protected]>
+Gopi Kishan <[email protected]>
 Gunj Joshi <[email protected]>
+Guru Prasad Sharma <[email protected]>
 Gururaj Gurram <[email protected]>
 Harishchandra Reddy <[email protected]>
 Haroon Rasheed <[email protected]>
-Harsh <[email protected]>
-HarshaNP <[email protected]>
+Harsh Yadav <[email protected]>
 Harshita Kalani <[email protected]>
 Hemang Choudhary <[email protected]>
 Hemant M Mehta <[email protected]>
 Hridyanshu <[email protected]>
+Iryna Andrushko <[email protected]>
 Jaimin Godhani <[email protected]>
-Jaison D Souza <[email protected].com>
+Jaison Dsouza <jaisondz9360@gmail.com>
 Jalaj Kumar <[email protected]>
 James Gelok <[email protected]>
 Jay Soni <[email protected]>
 Jaysukh Makvana <[email protected]>
+Jenish <[email protected]>
 Jenish Thapa <[email protected]>
 Jithin KS <[email protected]>
 Joel Mathew Koshy <[email protected]>
 Joey Reed <[email protected]>
 Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
+jsai28 <[email protected]>
 Justin Dennison <[email protected]>
 Justyn Shelby <[email protected]>
 Karan Anand <[email protected]>
 Karan Vasudevamurthy <[email protected]>
 Karan Yadav <[email protected]>
 Karthik Prakash <[email protected]>
-Kaushikgtm <[email protected]>
 Kavyansh-Bagdi <[email protected]>
 Kohantika Nath <[email protected]>
 Krishnam Agarwal <[email protected]>
 Krishnendu Das <[email protected]>
 Kshitij-Dale <[email protected]>
 Lalit Narayan Yadav <[email protected]>
+lohithganni <[email protected]>
 Lokesh Ranjan <[email protected]>
 Lovelin Dhoni J B <[email protected]>
-MANI <[email protected]>
 Mahfuza Humayra Mohona <[email protected]>
+MANI <[email protected]>
 Manik Sharma <[email protected]>
 Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
@@ -117,14 +126,17 @@ Mihir Pandit <[email protected]>
 Milan Raj <[email protected]>
 Mohammad Bin Aftab <[email protected]>
 Mohammad Kaif <[email protected]>
+Mohsin <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
 Muhammad Taaha Tariq <[email protected]>
 Muhmmad Saad <[email protected]>
-NEEKUorAAYUSH <[email protected]>
 Nakul Krishnakumar <[email protected]>
 Naresh Jagadeesan <[email protected]>
 Naveen Kumar <[email protected]>
+Navyansh Kesarwani <[email protected]>
+navyansh007 <[email protected]>
+NEEKUorAAYUSH <[email protected]>
 Neeraj Pathak <[email protected]>
 NirvedMishra <[email protected]>
 Nishant Shinde <[email protected]>
@@ -133,14 +145,18 @@ Nishchay Rajput <[email protected]>
 Nithin Katta <[email protected]>
 Nourhan Hasan <[email protected]>
 Ognjen Jevremović <[email protected]>
+olenkabilonizhka <[email protected]>
 Oneday12323 <[email protected]>
 Ori Miles <[email protected]>
+Payal Goswami <[email protected]>
 Philipp Burckhardt <[email protected]>
 Pierre Forstmann <[email protected]>
+Piyush Goel <[email protected]>
 Pradyumn Prasad <[email protected]>
 Prajjwal Bajpai <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
+pranav-1720 <[email protected]>
 Pranjal Jha <[email protected]>
 Prashant Kumar Yadav <[email protected]>
 PrathamBhamare <[email protected]>
@@ -152,37 +168,44 @@ Priyanshu Agarwal <[email protected]>
 Pulkit Gupta <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
 Rahul Kumar <[email protected]>
+rahulrangers <[email protected]>
+rainn <[email protected]>
 Raunak Kumar Gupta <[email protected]>
+rei2hu <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
 Ridam Garg <[email protected]>
 Rishav <[email protected]>
 Rishav Tarway <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
+RudrakshRaina07 <[email protected]>
 Rupa <[email protected]>
 Rutam Kathale <[email protected]>
 Ruthwik Chikoti <[email protected]>
 Ryan Seal <[email protected]>
 Rylan Yang <[email protected]>
-SAHIL KUMAR <[email protected]>
-SAUJANYA MAGARDE <[email protected]>
-SHIVAM YADAV <[email protected]>
 Sachin Raj <[email protected]>
 Sahil Goyal <[email protected]>
+SAHIL KUMAR <[email protected]>
 Sai Avinash <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
 Sanchay Ketan Sinha <[email protected]>
 Sarthak Paandey <[email protected]>
 Satyajeet Chavan <[email protected]>
+SAUJANYA MAGARDE <[email protected]>
 Saurabh Singh <[email protected]>
+Seth-Banker <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shabareesh Shetty <[email protected]>
 Shashank Shekhar Singh <[email protected]>
+Shaswata Panda <[email protected]>
 Shivam Ahir <[email protected]>
+SHIVAM YADAV <[email protected]>
 Shivansh <[email protected]>
 Shraddheya Shendre <[email protected]>
 Shubh Mehta <[email protected]>
+Shubham <[email protected]>
 Shubham Mishra <[email protected]>
 Siddhesh waje <[email protected]>
 Sivam Das <[email protected]>
@@ -199,6 +222,8 @@ Tirtadwipa Manunggal <[email protected]>
 Tudor Pagu <[email protected]>
 Tufailahmed Bargir <[email protected]>
 Tushar Bhardwaj <[email protected]>
+Tushar Bharti <[email protected]>
+Tyson Cung <[email protected]>
 Uday Kakade <[email protected]>
 Ujjwal Kirti <[email protected]>
 Utkarsh <http://[email protected]>
@@ -214,19 +239,7 @@ Wendy Yuchen Sun <[email protected]>
 Xiaochuan Ye <[email protected]>
 Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
+youzi-forge <[email protected]>
 Yugal Kaushik <[email protected]>
 Yuvi Mittal <[email protected]>
-deepak427 <[email protected]>
-devshree-bhati <[email protected]>
-ditsu <[email protected]>
-ekambains <[email protected]>
-fadiothman22 <[email protected]>
-iraandrushko <[email protected]>
-jsai28 <[email protected]>
-lohithganni <[email protected]>
-olenkabilonizhka <[email protected]>
-pranav-1720 <[email protected]>
-rahulrangers <[email protected]>
-rainn <[email protected]>
-rei2hu <[email protected]>
-zhanggy <[email protected]>
+Zuhair Ahmad <[email protected]>

README.md

@@ -78,6 +78,7 @@ The namespace contains the following functions:
 
 <div class="namespace-toc">
 
+-   <span class="signature">[`isAlmostEqual( a, b, maxULP )`][@stdlib/number/float64/base/assert/is-almost-equal]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).</span>
 -   <span class="signature">[`isSameValueZero( a, b )`][@stdlib/number/float64/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are the same value.</span>
 -   <span class="signature">[`isSameValue( a, b )`][@stdlib/number/float64/base/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two double-precision floating-point numbers are the same value.</span>
 
@@ -198,6 +199,8 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 <!-- <toc-links> -->
 
+[@stdlib/number/float64/base/assert/is-almost-equal]: https://github.com/stdlib-js/number-float64-base-assert-is-almost-equal
+
 [@stdlib/number/float64/base/assert/is-same-value-zero]: https://github.com/stdlib-js/number-float64-base-assert-is-same-value-zero
 
 [@stdlib/number/float64/base/assert/is-same-value]: https://github.com/stdlib-js/number-float64-base-assert-is-same-value

docs/types/index.d.ts

@@ -20,13 +20,53 @@
 
 /* eslint-disable max-lines */
 
+import isAlmostEqual = require( '@stdlib/number-float64-base-assert-is-almost-equal' );
 import isSameValue = require( '@stdlib/number-float64-base-assert-is-same-value' );
 import isSameValueZero = require( '@stdlib/number-float64-base-assert-is-same-value-zero' );
 
 /**
 * Interface describing the `assert` namespace.
 */
 interface Namespace {
+	/**
+	* Tests if two double-precision floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).
+	*
+	* ## Notes
+	*
+	* -   The function returns `false` if either input value is `NaN`.
+	* -   The function does not distinguish between `-0` and `+0`, treating them as equal.
+	*
+	* @param a - first input value
+	* @param b - second input value
+	* @param maxULP - maximum allowed ULP difference
+	* @returns boolean indicating whether two double-precision floating-point numbers are approximately equal within a specified number of ULPs
+	*
+	* @example
+	* var EPS = require( '@stdlib/constants-float64-eps' );
+	*
+	* var bool = ns.isAlmostEqual( 1.0, 1.0+EPS, 1 );
+	* // returns true
+	*
+	* bool = ns.isAlmostEqual( 1.0+EPS, 1.0, 1 );
+	* // returns true
+	*
+	* bool = ns.isAlmostEqual( 1.0, 1.0+EPS+EPS, 1 );
+	* // returns false
+	*
+	* bool = ns.isAlmostEqual( 1.0, 1.0+EPS, 0 );
+	* // returns false
+	*
+	* bool = ns.isAlmostEqual( 0.0, -0.0, 0 );
+	* // returns true
+	*
+	* bool = ns.isAlmostEqual( 1.0, NaN, 1 );
+	* // returns false
+	*
+	* bool = ns.isAlmostEqual( NaN, NaN, 1 );
+	* // returns false
+	*/
+	isAlmostEqual: typeof isAlmostEqual;
+
 	/**
 	* Tests if two double-precision floating-point numbers are the same value.
 	*