example PR A #615
Open
example PR A #615
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
and all associated frontend, backend and testing functionality, as a demo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Example PR A
This example PR demonstrates how to add a new, standard QuEST function. As an illustration, it implements
calcAmpSum()(andcalcRealAmpSum()) which returns the sum of all amplitudes in aQureg(or just its real component).The PR combines the changes of the four PRs below which each illustrate an isolated "step" of implementing a new feature.
calcRealAmpSum()frontendcalc(Real)AmpSum()backendcalcRealAmpSum()unit testscalcAmpSum()frontendThese individual PRs document how to expose and document the new function, validate its user inputs, implement its accelerated backends (distributed, multithreaded and GPU-accelerated) and its unit tests. It also demonstrates some extra steps needed to maintain
CandC++agnosticism when the new function returns aqcompdirectly, ascalcAmpSum()does.