@stdlib/number-float32-base-ulp-difference 0.1.0

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/NOTICE

@@ -0,0 +1 @@
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -0,0 +1,237 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
+# ulpdiff
+
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
+
+> Compute the number of representable [single-precision][single-precision] floating-point values that separate two [single-precision][single-precision] floating-point numbers along the real number line.
+
+<!-- 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 -->
+
+<!-- Package usage documentation. -->
+
+<section class="installation">
+
+## Installation
+
+```bash
+npm install @stdlib/number-float32-base-ulp-difference
+```
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var ulpdiff = require( '@stdlib/number-float32-base-ulp-difference' );
+```
+
+#### ulpdiff( x, y )
+
+Computes the number of representable [single-precision][single-precision] floating-point values that separate two [single-precision][single-precision] floating-point numbers along the real number line.
+
+```javascript
+var EPS = require( '@stdlib/constants-float32-eps' );
+
+var d = ulpdiff( 1.0, 1.0+EPS );
+// returns 1.0
+
+d = ulpdiff( 1.0+EPS, 1.0 );
+// returns 1.0
+
+d = ulpdiff( 1.0, 1.0+EPS+EPS );
+// returns 2.0
+
+d = ulpdiff( 1.0, NaN );
+// returns NaN
+
+d = ulpdiff( NaN, 1.0 );
+// returns NaN
+
+d = ulpdiff( NaN, NaN );
+// returns NaN
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   Adjacent [single-precision][single-precision] floating-point numbers differ by `1` [ulp][ulp] (unit in the last place).
+-   Signed zeros differ only in the sign bit but are considered numerically equal, and thus their ULP difference is `0`.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var EPS = require( '@stdlib/constants-float32-eps' );
+var SMALLEST_SUBNORMAL = require( '@stdlib/constants-float32-smallest-subnormal' );
+var ulpdiff = require( '@stdlib/number-float32-base-ulp-difference' );
+
+var d = ulpdiff( 1.0, 1.0+EPS );
+console.log( d );
+// => 1.0
+
+d = ulpdiff( 5.8364e-31, 5.8367e-31 );
+console.log( d );
+// => 638.0
+
+d = ulpdiff( 0.0, SMALLEST_SUBNORMAL );
+console.log( d );
+// => 1.0
+
+d = ulpdiff( 0.0, -0.0 );
+console.log( d );
+// => 0.0
+
+d = ulpdiff( SMALLEST_SUBNORMAL, -SMALLEST_SUBNORMAL );
+console.log( d );
+// => 2.0
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+
+<section class="main-repo" >
+
+* * *
+
+## Notice
+
+This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
+
+For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
+
+#### Community
+
+[![Chat][chat-image]][chat-url]
+
+---
+
+## License
+
+See [LICENSE][stdlib-license].
+
+
+## Copyright
+
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
+
+</section>
+
+<!-- /.stdlib -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[npm-image]: http://img.shields.io/npm/v/@stdlib/number-float32-base-ulp-difference.svg
+[npm-url]: https://npmjs.org/package/@stdlib/number-float32-base-ulp-difference
+
+[test-image]: https://github.com/stdlib-js/number-float32-base-ulp-difference/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/number-float32-base-ulp-difference/actions/workflows/test.yml?query=branch:v0.1.0
+
+[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/number-float32-base-ulp-difference/main.svg
+[coverage-url]: https://codecov.io/github/stdlib-js/number-float32-base-ulp-difference?branch=main
+
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/number-float32-base-ulp-difference.svg
+[dependencies-url]: https://david-dm.org/stdlib-js/number-float32-base-ulp-difference/main
+
+-->
+
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
+
+[stdlib]: https://github.com/stdlib-js/stdlib
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/number-float32-base-ulp-difference/tree/deno
+[deno-readme]: https://github.com/stdlib-js/number-float32-base-ulp-difference/blob/deno/README.md
+[umd-url]: https://github.com/stdlib-js/number-float32-base-ulp-difference/tree/umd
+[umd-readme]: https://github.com/stdlib-js/number-float32-base-ulp-difference/blob/umd/README.md
+[esm-url]: https://github.com/stdlib-js/number-float32-base-ulp-difference/tree/esm
+[esm-readme]: https://github.com/stdlib-js/number-float32-base-ulp-difference/blob/esm/README.md
+[branches-url]: https://github.com/stdlib-js/number-float32-base-ulp-difference/blob/main/branches.md
+
+[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/number-float32-base-ulp-difference/main/LICENSE
+
+[single-precision]: https://en.wikipedia.org/wiki/Single-precision_floating-point_format
+
+[ulp]: https://en.wikipedia.org/wiki/Unit_in_the_last_place
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import ulpdiff from '../docs/types/index';
+export = ulpdiff;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var o=v(function(m,s){
+var u=require('@stdlib/math-base-assert-is-nanf/dist'),n=require('@stdlib/constants-float32-sign-mask/dist'),a=require('@stdlib/number-float32-base-to-word/dist'),q=require('@stdlib/math-base-special-abs/dist');function f(r){return r&n?~r+1:(r|n)>>>0}function c(r,e){var i,t;return u(r)||u(e)?NaN:(i=a(r),t=a(e),i=f(i),t=f(t),q(i-t))}s.exports=c
+});var p=o();module.exports=p;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isnanf = require( '@stdlib/math-base-assert-is-nanf' );\nvar SIGN_MASK = require( '@stdlib/constants-float32-sign-mask' );\nvar toWordf = require( '@stdlib/number-float32-base-to-word' );\nvar abs = require( '@stdlib/math-base-special-abs' );\n\n\n// FUNCTIONS //\n\n/**\n* Converts an unsigned 32-bit integer corresponding to the IEEE 754 binary representation of a single-precision floating-point number to a lexicographically ordered integer.\n*\n* @private\n* @param {unsigned32} word - unsigned 32-bit integer\n* @returns {integer} lexicographically ordered integer\n*/\nfunction monotoneKey( word ) {\n\tif ( word & SIGN_MASK ) { // x < 0\n\t\treturn ( ~word + 1 ); // two's-complement negation\n\t}\n\t// x >= 0\n\treturn ( word | SIGN_MASK ) >>> 0; // push +0 to just above -0\n}\n\n\n// MAIN //\n\n/**\n* Computes the number of representable single-precision floating-point values that separate two single-precision floating-point numbers along the real number line.\n*\n* ## Notes\n*\n* -   Adjacent single-precision floating-point numbers differ by 1 ulp (unit in the last place).\n* -   Signed zeros differ only in the sign bit but are considered numerically equal, and thus their ULP difference is 0.\n*\n* @param {number} x - first value\n* @param {number} y - second value\n* @returns {number} result\n*\n* @example\n* var EPS = require( '@stdlib/constants-float32-eps' );\n*\n* var d = ulpdiff( 1.0, 1.0+EPS );\n* // returns 1.0\n*\n* d = ulpdiff( 1.0+EPS, 1.0 );\n* // returns 1.0\n*\n* d = ulpdiff( 1.0, 1.0+EPS+EPS );\n* // returns 2.0\n*\n* d = ulpdiff( 1.0, NaN );\n* // returns NaN\n*\n* d = ulpdiff( NaN, 1.0 );\n* // returns NaN\n*\n* d = ulpdiff( NaN, NaN );\n* // returns NaN\n*/\nfunction ulpdiff( x, y ) {\n\tvar wx;\n\tvar wy;\n\n\tif ( isnanf( x ) || isnanf( y ) ) {\n\t\treturn NaN;\n\t}\n\t// Convert input values to unsigned 32-bit integers corresponding to the IEEE 754 binary representation of single-precision floating-point numbers:\n\twx = toWordf( x );\n\twy = toWordf( y );\n\n\t// Convert the words to lexicographically ordered integers:\n\twx = monotoneKey( wx );\n\twy = monotoneKey( wy );\n\n\t// Return a double as a result, which can exactly represent the ULP difference for all representable single-precision floating-point numbers:\n\treturn abs( wx - wy );\n}\n\n\n// EXPORTS //\n\nmodule.exports = ulpdiff;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute the number of representable single-precision floating-point values that separate two single-precision floating-point numbers along the real number line.\n*\n* @module @stdlib/number-float32-base-ulp-difference\n*\n* @example\n* var EPS = require( '@stdlib/constants-float32-eps' );\n* var ulpdiff = require( '@stdlib/number-float32-base-ulp-difference' );\n*\n* var d = ulpdiff( 1.0, 1.0+EPS );\n* // returns 1.0\n*\n* d = ulpdiff( 1.0+EPS, 1.0 );\n* // returns 1.0\n*\n* d = ulpdiff( 1.0, 1.0+EPS+EPS );\n* // returns 2.0\n*\n* d = ulpdiff( 1.0, NaN );\n* // returns NaN\n*\n* d = ulpdiff( NaN, 1.0 );\n* // returns NaN\n*\n* d = ulpdiff( NaN, NaN );\n* // returns NaN\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,kCAAmC,EACrDC,EAAY,QAAS,qCAAsC,EAC3DC,EAAU,QAAS,qCAAsC,EACzDC,EAAM,QAAS,+BAAgC,EAYnD,SAASC,EAAaC,EAAO,CAC5B,OAAKA,EAAOJ,EACF,CAACI,EAAO,GAGTA,EAAOJ,KAAgB,CACjC,CAsCA,SAASK,EAASC,EAAGC,EAAI,CACxB,IAAIC,EACAC,EAEJ,OAAKV,EAAQO,CAAE,GAAKP,EAAQQ,CAAE,EACtB,KAGRC,EAAKP,EAASK,CAAE,EAChBG,EAAKR,EAASM,CAAE,EAGhBC,EAAKL,EAAaK,CAAG,EACrBC,EAAKN,EAAaM,CAAG,EAGdP,EAAKM,EAAKC,CAAG,EACrB,CAKAX,EAAO,QAAUO,ICrDjB,IAAIK,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isnanf", "SIGN_MASK", "toWordf", "abs", "monotoneKey", "word", "ulpdiff", "x", "y", "wx", "wy", "main"]
+}

package/docs/types/index.d.ts

@@ -0,0 +1,59 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Computes the number of representable single-precision floating-point values that separate two single-precision floating-point numbers along the real number line.
+*
+* ## Notes
+*
+* -   Adjacent single-precision floating-point numbers differ by 1 ulp (unit in the last place).
+* -   Signed zeros differ only in the sign bit but are considered numerically equal, and thus their ULP difference is 0.
+*
+* @param x - first input value
+* @param y - second input value
+* @returns result
+*
+* @example
+* var EPS = require( '@stdlib/constants-float32-eps' );
+*
+* var d = ulpdiff( 1.0, 1.0+EPS );
+* // returns 1.0
+*
+* d = ulpdiff( 1.0+EPS, 1.0 );
+* // returns 1.0
+*
+* d = ulpdiff( 1.0, 1.0+EPS+EPS );
+* // returns 2.0
+*
+* d = ulpdiff( 1.0, NaN );
+* // returns NaN
+*
+* d = ulpdiff( NaN, 1.0 );
+* // returns NaN
+*
+* d = ulpdiff( NaN, NaN );
+* // returns NaN
+*/
+declare function ulpdiff( x: number, y: number ): number;
+
+
+// EXPORTS //
+
+export = ulpdiff;

package/lib/index.js

@@ -0,0 +1,56 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+/**
+* Compute the number of representable single-precision floating-point values that separate two single-precision floating-point numbers along the real number line.
+*
+* @module @stdlib/number-float32-base-ulp-difference
+*
+* @example
+* var EPS = require( '@stdlib/constants-float32-eps' );
+* var ulpdiff = require( '@stdlib/number-float32-base-ulp-difference' );
+*
+* var d = ulpdiff( 1.0, 1.0+EPS );
+* // returns 1.0
+*
+* d = ulpdiff( 1.0+EPS, 1.0 );
+* // returns 1.0
+*
+* d = ulpdiff( 1.0, 1.0+EPS+EPS );
+* // returns 2.0
+*
+* d = ulpdiff( 1.0, NaN );
+* // returns NaN
+*
+* d = ulpdiff( NaN, 1.0 );
+* // returns NaN
+*
+* d = ulpdiff( NaN, NaN );
+* // returns NaN
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/main.js

@@ -0,0 +1,104 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var isnanf = require( '@stdlib/math-base-assert-is-nanf' );
+var SIGN_MASK = require( '@stdlib/constants-float32-sign-mask' );
+var toWordf = require( '@stdlib/number-float32-base-to-word' );
+var abs = require( '@stdlib/math-base-special-abs' );
+
+
+// FUNCTIONS //
+
+/**
+* Converts an unsigned 32-bit integer corresponding to the IEEE 754 binary representation of a single-precision floating-point number to a lexicographically ordered integer.
+*
+* @private
+* @param {unsigned32} word - unsigned 32-bit integer
+* @returns {integer} lexicographically ordered integer
+*/
+function monotoneKey( word ) {
+	if ( word & SIGN_MASK ) { // x < 0
+		return ( ~word + 1 ); // two's-complement negation
+	}
+	// x >= 0
+	return ( word | SIGN_MASK ) >>> 0; // push +0 to just above -0
+}
+
+
+// MAIN //
+
+/**
+* Computes the number of representable single-precision floating-point values that separate two single-precision floating-point numbers along the real number line.
+*
+* ## Notes
+*
+* -   Adjacent single-precision floating-point numbers differ by 1 ulp (unit in the last place).
+* -   Signed zeros differ only in the sign bit but are considered numerically equal, and thus their ULP difference is 0.
+*
+* @param {number} x - first value
+* @param {number} y - second value
+* @returns {number} result
+*
+* @example
+* var EPS = require( '@stdlib/constants-float32-eps' );
+*
+* var d = ulpdiff( 1.0, 1.0+EPS );
+* // returns 1.0
+*
+* d = ulpdiff( 1.0+EPS, 1.0 );
+* // returns 1.0
+*
+* d = ulpdiff( 1.0, 1.0+EPS+EPS );
+* // returns 2.0
+*
+* d = ulpdiff( 1.0, NaN );
+* // returns NaN
+*
+* d = ulpdiff( NaN, 1.0 );
+* // returns NaN
+*
+* d = ulpdiff( NaN, NaN );
+* // returns NaN
+*/
+function ulpdiff( x, y ) {
+	var wx;
+	var wy;
+
+	if ( isnanf( x ) || isnanf( y ) ) {
+		return NaN;
+	}
+	// Convert input values to unsigned 32-bit integers corresponding to the IEEE 754 binary representation of single-precision floating-point numbers:
+	wx = toWordf( x );
+	wy = toWordf( y );
+
+	// Convert the words to lexicographically ordered integers:
+	wx = monotoneKey( wx );
+	wy = monotoneKey( wy );
+
+	// Return a double as a result, which can exactly represent the ULP difference for all representable single-precision floating-point numbers:
+	return abs( wx - wy );
+}
+
+
+// EXPORTS //
+
+module.exports = ulpdiff;

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@stdlib/number-float32-base-ulp-difference",
+  "version": "0.1.0",
+  "description": "Compute the number of representable single-precision floating-point values that separate two single-precision floating-point numbers along the real number line.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "doc": "./docs",
+    "lib": "./lib",
+    "dist": "./dist"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/number-float32-base-ulp-difference.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/constants-float32-sign-mask": "^0.2.2",
+    "@stdlib/math-base-assert-is-nanf": "^0.2.2",
+    "@stdlib/math-base-special-abs": "^0.2.2",
+    "@stdlib/number-float32-base-to-word": "^0.2.2"
+  },
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdmath",
+    "mathematics",
+    "math",
+    "relative",
+    "difference",
+    "abs",
+    "diff",
+    "error",
+    "distance",
+    "dist",
+    "numbers",
+    "ulp",
+    "float32",
+    "float"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}