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

Ambiguous output from successful solution using lineax.RESULTS #55

Open
LouisDesdoigts opened this issue Oct 31, 2023 · 1 comment
Open
Labels
refactor Tidy things up

Comments

@LouisDesdoigts
Copy link

I originally encountered this issue in optimistix but realised it originates here.

After a successful solution is found the solution.result value is 0 when it has succeeded, with a series of other values for the various failure modes, all fine so far. However following the docs to get a 'human-readable' interpretation using lineax.RESULTS[sol.result] returns an empty string when it has succeeded. As far as I can tell without knowledge of Enumeration objects or looking at the code directly there is really no way to know that is actually a good thing, rather than some form of 'null result' as I originally interpreted it.

Maybe this is intentional for some deeper reason, but not as far as I can see. I think having the success message print out something as simple a 'success' would go a long way for new users.

Let me know if you're interested and Ill make a PR for this.

@patrick-kidger
Copy link
Owner

Yup, there's no good reason for this. We'd be happy to take a PR changing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Tidy things up
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants