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

Docstring of CosAnneal incorrect? #67

Closed
dpaetzel opened this issue May 13, 2024 · 1 comment · Fixed by #73
Closed

Docstring of CosAnneal incorrect? #67

dpaetzel opened this issue May 13, 2024 · 1 comment · Fixed by #73

Comments

@dpaetzel
Copy link
Contributor

Hi! Thank you for developing and maintaining this library!

I just noticed that the docstring of CosAnneal may be incorrect? Shouldn't it be

t̂ = restart ? mod(t - 1, period) : (t - 1)

instead of

t̂ = restart ? (t - 1) : mod(t - 1, period)

since the latter does not conform to the code whereas the former does?

@darsnack
Copy link
Member

That's correct, thanks for catching the mistake! If you have time to file a PR, then that would be appreciated.

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

Successfully merging a pull request may close this issue.

2 participants