Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

DecomposeIntoTimeStepsCA doc bug #170

Closed
jgukelberger opened this issue Oct 24, 2019 · 2 comments
Closed

DecomposeIntoTimeStepsCA doc bug #170

jgukelberger opened this issue Oct 24, 2019 · 2 comments
Assignees
Labels
Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Bug Something isn't working

Comments

@jgukelberger
Copy link
Member

Current documentation for DecomposeIntoTimeStepsCA says the only Trotter-Suzuki orders supported are one and two:

    /// ## trotterOrder
    /// Selects the order of the Trotter–Suzuki integrator to be used.
    /// Order 1 and 2 are currently supported.

Looking at the implementation, it appears though like arbitrary even orders are supported, too.

The documentation should hence be updated if higher orders are in fact supported. In case the code handling higher orders were not supported/known buggy(?), a comment to this effect should be added to the code.

@jgukelberger jgukelberger added Kind-Bug Something isn't working Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. labels Oct 24, 2019
@anpaz
Copy link
Member

anpaz commented Oct 24, 2019

@guanghaolow could you comment on this?

@guanghaolow
Copy link
Contributor

@jgukelberger Thanks for pointing this out. Even orders are supported. I've updated the documentation to reflect this.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants