Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

solve raises error on duplicate symbols #23891

Merged
merged 5 commits into from Aug 8, 2022
Merged

Conversation

smichr
Copy link
Member

@smichr smichr commented Aug 8, 2022

References to other Issues or PRs

Brief description of what is fixed or changed

Rather than deal in some unique way with a solve request that contains duplicate symbols, the presence of duplicates now raises an error. This seems like a good idea because there is no reason to include duplicates and it might indicate a typo of the person entering the request. Disallowing duplicates matches the behvior of nonlinsolve and linsolve

Other comments

There are lots of stray extra lines fixed in the first commit. Please review commits starting at 2 instead of looking at "Files changed" if that much noise is bothersome.

Release Notes

  • solvers
    • solve now raises an error if duplicate symbols are given in the unknowns to be solved for such as solve(equations, [x, y, x]).

@sympy-bot
Copy link

sympy-bot commented Aug 8, 2022

Hi, I am the SymPy bot (v167). 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:

  • solvers
    • solve now raises an error if duplicate symbols are given in the unknowns to be solved for such as solve(equations, [x, y, x]). (#23891 by @smichr)

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

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. -->


#### Brief description of what is fixed or changed

Rather than deal in some unique way with a solve request that contains duplicate symbols, the presence of duplicates now raises an error. This seems like a good idea because there is no reason to include duplicates and it *might* indicate a typo of the person entering the request. Disallowing duplicates matches the behvior of `nonlinsolve` and `linsolve`

#### Other comments

There are lots of stray extra lines fixed in the first commit. Please review commits starting at 2 instead of looking at "Files changed" if that much noise is bothersome.

#### 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.

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 -->
* solvers
  * `solve` now raises an error if duplicate symbols are given in the unknowns to be solved for such as `solve(equations, [x, y, x])`.
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

@github-actions
Copy link

github-actions bot commented Aug 8, 2022

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)

       before           after         ratio
     [ac3b08a6]       [3d85b8bd]
-     1.23±0.03ms         747±20μs     0.61  solve.TimeSparseSystem.time_linear_eq_to_matrix(10)
-     3.52±0.06ms      1.41±0.03ms     0.40  solve.TimeSparseSystem.time_linear_eq_to_matrix(20)
-     7.09±0.06ms      2.07±0.03ms     0.29  solve.TimeSparseSystem.time_linear_eq_to_matrix(30)

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

@oscarbenjamin
Copy link
Contributor

This doesn't catch the case of duplicated symbols when the input is not a list:

In [4]: solve(x, x, y, x)
Out[4]: [{x: 0}, {x: 0}]

In [5]: solve([x], x, y, x)
---------------------------------------------------------------------------
GeneratorsError

sympy/solvers/solvers.py Outdated Show resolved Hide resolved
@smichr
Copy link
Member Author

smichr commented Aug 8, 2022

Thanks for the catch, @oscarbenjamin. This is ready to go.

@oscarbenjamin
Copy link
Contributor

Looks good!

@oscarbenjamin oscarbenjamin merged commit ebe3c40 into sympy:master Aug 8, 2022
@smichr smichr deleted the s5b branch August 10, 2022 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants