added calcRealAmpSum frontend #607
Closed
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
Sub PR 1
This PR demonstrates how to add the user-facing frontend of a new function to the QuEST API. To do so:
quest/include/header file.quest/src/api/file.This API function should contain only simple logic, and call other internal functions defined in
quest/src/core/files as necessary. It typically resembleswhere
validate_userInput()is a function declared invalidation.hppwhich verifies the user's input satisfies necessary preconditions. The so-far undefined functionlocaliser_myFunction()is the entry-point to the backend of the new function, as explained in the next PR (#608).It is sometimes necessary to define new internal functions needed by the new API function. These will typically be added to
validation.cpputilities.cppparser.cppprinter.cpprandomiser.cppmemory.cppIn this PR, it was necessary to define a new validation function in
validation.cpp, and declare it invalidation.hpp