Modified `LambertW.eval` to not use `match`(1.13 branch) #26841

haru-44 · 2024-07-20T13:21:53Z

References to other Issues or PRs

Backport of #26840 for 1.13 branch

Brief description of what is fixed or changed

Other comments

Release Notes

functions
- Fixed a bug that caused LambertW to hang on specific inputs.

Essentially, I reverted the changes from sympy#26741, but I kept the fix for the redundant `x.is_zero` check.

sympy-bot · 2024-07-20T13:21:59Z

✅

Hi, I am the SymPy bot. I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

Your release notes are in good order.

Here is what the release notes will look like:

functions
- Fixed a bug that caused LambertW to hang on specific inputs. (#26841 by @haru-44)

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.13.2.

Click here to see the pull request description that was parsed.

<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->
#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->
Backport of #26840 for 1.13 branch
#### Brief description of what is fixed or changed
#### Other comments
#### Release Notes
<!-- Write the release notes for this release below between the BEGIN and END
statements. The basic format is a bulleted list with the name of the subpackage
and the release note for this PR. For example:
* solvers
  * Added a new solver for logarithmic equations.
* functions
  * Fixed a bug with log of integers. Formerly, `log(-x)` incorrectly gave `-log(x)`.
* physics.units
  * Corrected a semantical error in the conversion between volt and statvolt which
    reported the volt as being larger than the statvolt.
or if no release note(s) should be included use:
NO ENTRY
See https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more
information on how to write release notes. The bot will check your release
notes automatically to see if they are formatted correctly. -->
<!-- BEGIN RELEASE NOTES -->
* functions
  * Fixed a bug that caused `LambertW` to hang on specific inputs.
<!-- END RELEASE NOTES -->

oscarbenjamin · 2024-07-20T13:56:26Z

This looks good.

sympy-bot · 2024-07-20T14:09:39Z

🚨🚨🚨ERROR🚨🚨🚨 There was an error automatically updating the release notes. Normally it should not have been possible to merge this pull request. You might want to open an issue about this at https://github.com/sympy/sympy-bot/issues.

In the meantime, you will need to update the release notes on the wiki manually.

The error message was: Not all changelog entries were added. Make sure there is a header called ## Authors at the end of the release notes.

github-actions · 2024-07-20T14:11:53Z

Benchmark results from GitHub Actions

Lower numbers are good, higher numbers are bad. A ratio less than 1
means a speed up and greater than 1 means a slowdown. Green lines
beginning with + are slowdowns (the PR is slower then master or
master is slower than the previous release). Red lines beginning
with - are speedups.

Significantly changed benchmark results (PR vs master)

Significantly changed benchmark results (master vs previous release)

| Change   | Before [a36a8b23] <sympy-1.12.1^0>   | After [022c8976]    |   Ratio | Benchmark (Parameter)                                                |
|----------|--------------------------------------|---------------------|---------|----------------------------------------------------------------------|
| -        | 69.3±2ms                             | 43.8±0.3ms          |    0.63 | integrate.TimeIntegrationRisch02.time_doit(10)                       |
| -        | 66.6±0.5ms                           | 42.4±0.8ms          |    0.64 | integrate.TimeIntegrationRisch02.time_doit_risch(10)                 |
| +        | 17.7±0.5μs                           | 29.8±0.3μs          |    1.68 | integrate.TimeIntegrationRisch03.time_doit(1)                        |
| -        | 5.43±0.02ms                          | 2.93±0.03ms         |    0.54 | logic.LogicSuite.time_load_file                                      |
| -        | 71.7±1ms                             | 28.7±0.1ms          |    0.4  | polys.TimeGCD_GaussInt.time_op(1, 'dense')                           |
| -        | 71.5±0.9ms                           | 28.3±0.5ms          |    0.4  | polys.TimeGCD_GaussInt.time_op(1, 'sparse')                          |
| -        | 249±3ms                              | 121±0.4ms           |    0.49 | polys.TimeGCD_GaussInt.time_op(2, 'dense')                           |
| -        | 251±1ms                              | 123±1ms             |    0.49 | polys.TimeGCD_GaussInt.time_op(2, 'sparse')                          |
| -        | 645±7ms                              | 365±3ms             |    0.57 | polys.TimeGCD_GaussInt.time_op(3, 'dense')                           |
| -        | 638±8ms                              | 370±2ms             |    0.58 | polys.TimeGCD_GaussInt.time_op(3, 'sparse')                          |
| -        | 487±5μs                              | 291±0.7μs           |    0.6  | polys.TimeGCD_LinearDenseQuadraticGCD.time_op(1, 'dense')            |
| -        | 1.79±0.01ms                          | 1.05±0.01ms         |    0.59 | polys.TimeGCD_LinearDenseQuadraticGCD.time_op(2, 'dense')            |
| -        | 5.91±0.08ms                          | 2.94±0.06ms         |    0.5  | polys.TimeGCD_LinearDenseQuadraticGCD.time_op(3, 'dense')            |
| -        | 441±10μs                             | 227±2μs             |    0.51 | polys.TimeGCD_QuadraticNonMonicGCD.time_op(1, 'dense')               |
| -        | 1.45±0ms                             | 670±7μs             |    0.46 | polys.TimeGCD_QuadraticNonMonicGCD.time_op(2, 'dense')               |
| -        | 4.85±0.04ms                          | 1.65±0.01ms         |    0.34 | polys.TimeGCD_QuadraticNonMonicGCD.time_op(3, 'dense')               |
| -        | 377±2μs                              | 209±2μs             |    0.55 | polys.TimeGCD_SparseGCDHighDegree.time_op(1, 'dense')                |
| -        | 2.43±0.01ms                          | 1.22±0.03ms         |    0.5  | polys.TimeGCD_SparseGCDHighDegree.time_op(3, 'dense')                |
| -        | 9.98±0.07ms                          | 4.29±0.07ms         |    0.43 | polys.TimeGCD_SparseGCDHighDegree.time_op(5, 'dense')                |
| -        | 361±5μs                              | 168±1μs             |    0.47 | polys.TimeGCD_SparseNonMonicQuadratic.time_op(1, 'dense')            |
| -        | 2.46±0.01ms                          | 891±4μs             |    0.36 | polys.TimeGCD_SparseNonMonicQuadratic.time_op(3, 'dense')            |
| -        | 9.24±0.2ms                           | 2.65±0.07ms         |    0.29 | polys.TimeGCD_SparseNonMonicQuadratic.time_op(5, 'dense')            |
| -        | 998±20μs                             | 418±2μs             |    0.42 | polys.TimePREM_LinearDenseQuadraticGCD.time_op(3, 'dense')           |
| -        | 1.70±0.07ms                          | 499±8μs             |    0.29 | polys.TimePREM_LinearDenseQuadraticGCD.time_op(3, 'sparse')          |
| -        | 5.71±0.07ms                          | 1.75±0.01ms         |    0.31 | polys.TimePREM_LinearDenseQuadraticGCD.time_op(5, 'dense')           |
| -        | 8.32±0.2ms                           | 1.49±0.01ms         |    0.18 | polys.TimePREM_LinearDenseQuadraticGCD.time_op(5, 'sparse')          |
| -        | 295±0.3μs                            | 65.1±0.6μs          |    0.22 | polys.TimePREM_QuadraticNonMonicGCD.time_op(1, 'sparse')             |
| -        | 3.38±0.01ms                          | 373±8μs             |    0.11 | polys.TimePREM_QuadraticNonMonicGCD.time_op(3, 'dense')              |
| -        | 3.95±0.03ms                          | 282±1μs             |    0.07 | polys.TimePREM_QuadraticNonMonicGCD.time_op(3, 'sparse')             |
| -        | 6.86±0.2ms                           | 1.22±0.01ms         |    0.18 | polys.TimePREM_QuadraticNonMonicGCD.time_op(5, 'dense')              |
| -        | 8.62±0.04ms                          | 819±10μs            |    0.1  | polys.TimePREM_QuadraticNonMonicGCD.time_op(5, 'sparse')             |
| -        | 5.06±0.02ms                          | 2.95±0.07ms         |    0.58 | polys.TimeSUBRESULTANTS_LinearDenseQuadraticGCD.time_op(2, 'sparse') |
| -        | 12.1±0.3ms                           | 6.27±0.2ms          |    0.52 | polys.TimeSUBRESULTANTS_LinearDenseQuadraticGCD.time_op(3, 'dense')  |
| -        | 22.1±0.3ms                           | 9.14±0.06ms         |    0.41 | polys.TimeSUBRESULTANTS_LinearDenseQuadraticGCD.time_op(3, 'sparse') |
| -        | 5.36±0.04ms                          | 871±4μs             |    0.16 | polys.TimeSUBRESULTANTS_QuadraticNonMonicGCD.time_op(1, 'sparse')    |
| -        | 12.4±0.2ms                           | 7.01±0.04ms         |    0.56 | polys.TimeSUBRESULTANTS_QuadraticNonMonicGCD.time_op(2, 'sparse')    |
| -        | 98.8±0.8ms                           | 25.4±0.3ms          |    0.26 | polys.TimeSUBRESULTANTS_QuadraticNonMonicGCD.time_op(3, 'dense')     |
| -        | 167±0.9ms                            | 52.9±1ms            |    0.32 | polys.TimeSUBRESULTANTS_QuadraticNonMonicGCD.time_op(3, 'sparse')    |
| -        | 173±0.9μs                            | 109±3μs             |    0.63 | polys.TimeSUBRESULTANTS_SparseGCDHighDegree.time_op(1, 'dense')      |
| -        | 363±2μs                              | 208±2μs             |    0.57 | polys.TimeSUBRESULTANTS_SparseGCDHighDegree.time_op(1, 'sparse')     |
| -        | 4.25±0.08ms                          | 806±10μs            |    0.19 | polys.TimeSUBRESULTANTS_SparseGCDHighDegree.time_op(3, 'dense')      |
| -        | 5.16±0.06ms                          | 381±8μs             |    0.07 | polys.TimeSUBRESULTANTS_SparseGCDHighDegree.time_op(3, 'sparse')     |
| -        | 19.3±0.2ms                           | 2.81±0.01ms         |    0.15 | polys.TimeSUBRESULTANTS_SparseGCDHighDegree.time_op(5, 'dense')      |
| -        | 22.4±0.2ms                           | 626±9μs             |    0.03 | polys.TimeSUBRESULTANTS_SparseGCDHighDegree.time_op(5, 'sparse')     |
| -        | 479±6μs                              | 134±1μs             |    0.28 | polys.TimeSUBRESULTANTS_SparseNonMonicQuadratic.time_op(1, 'sparse') |
| -        | 4.54±0.06ms                          | 616±1μs             |    0.14 | polys.TimeSUBRESULTANTS_SparseNonMonicQuadratic.time_op(3, 'dense')  |
| -        | 5.21±0.05ms                          | 136±4μs             |    0.03 | polys.TimeSUBRESULTANTS_SparseNonMonicQuadratic.time_op(3, 'sparse') |
| -        | 12.6±0.1ms                           | 1.26±0.03ms         |    0.1  | polys.TimeSUBRESULTANTS_SparseNonMonicQuadratic.time_op(5, 'dense')  |
| -        | 13.6±0.1ms                           | 136±5μs             |    0.01 | polys.TimeSUBRESULTANTS_SparseNonMonicQuadratic.time_op(5, 'sparse') |
| -        | 133±2μs                              | 73.9±0.4μs          |    0.56 | solve.TimeMatrixOperations.time_rref(3, 0)                           |
| -        | 252±0.7μs                            | 87.2±0.6μs          |    0.35 | solve.TimeMatrixOperations.time_rref(4, 0)                           |
| -        | 23.9±0.09ms                          | 10.2±0.02ms         |    0.43 | solve.TimeSolveLinSys189x49.time_solve_lin_sys                       |
| -        | 28.2±0.2ms                           | 15.4±0.1ms          |    0.55 | solve.TimeSparseSystem.time_linsolve_Aaug(20)                        |
| -        | 54.3±0.3ms                           | 24.6±0.4ms          |    0.45 | solve.TimeSparseSystem.time_linsolve_Aaug(30)                        |
| -        | 27.9±0.6ms                           | 14.6±0.3ms          |    0.53 | solve.TimeSparseSystem.time_linsolve_Ab(20)                          |
| -        | 54.8±0.3ms                           | 24.3±0.2ms          |    0.44 | solve.TimeSparseSystem.time_linsolve_Ab(30)                          |

Full benchmark results can be found as artifacts in GitHub Actions
(click on checks at the top of the PR).

haru-44 added 2 commits July 20, 2024 22:11

Modified LambertW.eval to not use match

cfd8f20

Essentially, I reverted the changes from sympy#26741, but I kept the fix for the redundant `x.is_zero` check.

Delete unnecessary import

99eb5ae

haru-44 added the functions label Jul 20, 2024

oscarbenjamin enabled auto-merge July 20, 2024 13:56

oscarbenjamin mentioned this pull request Jul 20, 2024

Modified LambertW.eval to not use match #26840

Merged

oscarbenjamin merged commit 5b2c92a into sympy:1.13 Jul 20, 2024
52 checks passed

haru-44 deleted the revert_26471_113 branch February 8, 2025 13:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Modified `LambertW.eval` to not use `match`(1.13 branch) #26841

Modified `LambertW.eval` to not use `match`(1.13 branch) #26841

Uh oh!

haru-44 commented Jul 20, 2024

Uh oh!

sympy-bot commented Jul 20, 2024

Uh oh!

oscarbenjamin commented Jul 20, 2024

Uh oh!

Uh oh!

sympy-bot commented Jul 20, 2024

Uh oh!

github-actions bot commented Jul 20, 2024

Uh oh!

Uh oh!

Uh oh!

Modified LambertW.eval to not use match(1.13 branch) #26841

Modified LambertW.eval to not use match(1.13 branch) #26841

Uh oh!

Conversation

haru-44 commented Jul 20, 2024

References to other Issues or PRs

Brief description of what is fixed or changed

Other comments

Release Notes

Uh oh!

sympy-bot commented Jul 20, 2024

Uh oh!

oscarbenjamin commented Jul 20, 2024

Uh oh!

Uh oh!

sympy-bot commented Jul 20, 2024

Uh oh!

github-actions bot commented Jul 20, 2024

Uh oh!

Uh oh!

Modified `LambertW.eval` to not use `match`(1.13 branch) #26841

Modified `LambertW.eval` to not use `match`(1.13 branch) #26841