Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[RFC]: Migrate `math/base/special` packages from relative tolerance testing to ULP difference testing (tracking issue)

Abierto
  • ¿Algo no está bien?
#11,352 3 comentarios 2 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@Planeshifter ya está trabajando en esto.

Desde el 1/10/2026.

  • #15262 de @Planeshifter — fusionado
  • #15733 de @Planeshifter — abierto
  • #15872 de @yb175 — abierto

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
68/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
javascript
Área
testing-qa

Línea de trabajo

Comienza estudiando el commit 121f2c0 y la documentación de @stdlib/assert/is-almost-same-value; luego busca en las carpetas test/ bajo math/base/special un paquete que use casos de tolerancia relativa. Migra las pruebas de un solo paquete, conservando el comportamiento y usando valores ULP mínimos. Ejecuta make test TESTS_FILTER="./math/base/special//." y verifica que todos los casos pasen.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Accepted difficulty: 1 Good First Issue JavaScript Math Modernization priority: Normal Tests

Instructions

  1. Read the issue description below.
  2. Read the issue comment which follows the description.
  3. Search for a package in math/base/special having relative tolerance tests which needs updating according to the description below.
  4. Follow any additional guidance specified in this issue.

Description

This RFC proposes migrating from Relative Tolerance testing to ULP Difference testing for math/base/special functions.

In short, this RFC seeks to refactor testing from, for example

var abs = require( '@stdlib/math/base/special/abs' );

var delta = abs( y - expected[ i ] );
var tol = EPS * abs( expected[ i ] );
t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. y: '+y );

to

var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' );

t.strictEqual( isAlmostSameValue( y, expected[ i ], 1 ), true, 'returns expected value' );

The migration is demonstrated in commit 121f2c0

In particular, notice three things:

  1. We add the import @stdlib/assert/is-almost-same-value. See the documentation for @stdlib/assert/is-almost-same-value for supported parameters.
  2. We remove var delta = abs( y - expected[ i ] ); and var tol = EPS * abs( expected[ i ] );
  3. We replace t.ok( ... ); with t.strictEqual( isAlmostSameValue( v, expected[ i ], 1 ), true, 'returns expected value' ); with the returned output, expected value and the minimum required ulp value. Also, make sure the message is 'returns expected value' for every test case.

By performing this refactoring, we facilitate

  1. Measuring error in units of the representable gap at that magnitude, which is the natural accuracy unit for floating-point.
  2. Enables a uniform accuracy budget
  3. Easier to test both real and complex functions, across single-precision and double-precision, with consistent and trustworthy rules.

Note: In certain functions, we may encounter different return values in the JavaScript and C implementation for the same implementation. In that case, refer to this commit 69e1068. This was discussed here in detail FAQ.

Steps

Given the relatively widespread practice of using relative tolerance in testing, this RFC aims to be an open call for any contributor wanting to contribute to the project to do the following:

  1. Study the changes made in commit 121f2c0, as this commit contains the sorts of changes that we are looking for.
  2. Ensure you have setup your local development environment by following the contributing guide, including make install-node-modules and make init.
  3. Study the documentation for @stdlib/assert/is-almost-same-value.
  4. Find a package containing relative tolerance test cases.
  5. Update the test cases for that package, and only that package, to migrate to use ULP difference testing. Make sure that you put the minimum required ULP value possible. Tests can be found in the test/ folder of a package (if it exists).
  6. Run tests locally using the command make test TESTS_FILTER=".*/math/base/special/<package-name>/.*". For example, make test TESTS_FILTER=".*/math/base/special/hyp2f1/.*".
  7. Verify that the updated ULP values pass all the test cases.
  8. Commit your changes.
  9. Submit a PR updating the test for that package (and only that package).
  10. For the PR title, use the following template "test: migrate <package-name> to ULP-based testing" where <package_name> is the name of the package you updated (e.g., math/base/special/hyp2f1).
  11. In the PR body/description, use the phrase "Resolves a part of ", and not "Resolves " or "Closes ", this issue, as this is a tracking issue and your PR only addresses one package of many needing updating.
Related Issues

None

Questions

None.

Other
  • If you are interested in working on this RFC, for each pull request, please only update the tests for a single package.
  • As mentioned above, please do NOT make extraneous changes to test cases. We are not interested in changing tests wholesale. Nor are we interested in new "creative" changes. We are only interested in migrating from relative tolerance testing to ULP diff based testing Failure to match the behavior of the existing tests and to respect this guidance will result in your PRs being automatically closed without review.
  • As this is a "Good First Issue", you are strongly encouraged to avoid using AI when authoring your contribution. One of the primary intents of Good First Issues is to help introduce you to stdlib, its development environment, and the contribution process, as documented in the contributing guide. Most new contributors are unfamiliar with stdlib and its conventions, and thus fail to appropriately use LLMs and AI when authoring contributions, most often generating AI slop and leading to wasted time. Don't be one of those people. :) Take the time to manually author your first several PRs, and, once you are intimately familiar with project conventions, you can consider leveraging AI to augment your dev tasks.
Checklist
  • I have read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.
  • The issue name begins with RFC:.
Lenguaje dominante
JavaScript
Estrellas
6k
Forks
1.3k
Merge medio
1 d 10 h
PR fusionados (30 d)
522

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de stdlib-js/stdlib

Todos los issues de stdlib-js/stdlib

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.