Skip to content

updated doc#621

Merged
TysonRayJones merged 21 commits intodevelfrom
more-api-doc
May 22, 2025
Merged

updated doc#621
TysonRayJones merged 21 commits intodevelfrom
more-api-doc

Conversation

@TysonRayJones
Copy link
Member

No description provided.

replacing with a temporary @validationerror doxygen ALIAS while we figure out how to refer to the new user-set error function
since the section gives a list of equivalent functions
where it's urgent to give their explicit formula to avoid ambiguity
another embarrassing commit
from e.g. notdoced to notyetdoced, to reflect that this command _should_ be later replaced and removed (as opposed to neverdoced)
for:
- setQuregToSuperposition
- applyRotateX
- applyRotateY
- applyRotateZ
- applyRotateAroundAxis
- applyPauliGadget
- applyPhaseGadget
- applyPhaseShift
- applyTwoQubitPhaseShift
- applyMultiQubitPhaseShift
- applyPhaseFlip
- applyTwoQubitPhaseFlip
- applyMultiQubitPhaseFlip
- applyTrotterizedPauliStrSumGadget

I believe this concludes the formulae for all functions with conventional parameterisations
which defines "multiply" as oppose to"apply"
which defines what is meant by "multi state controlled".
since there were two kinds of meaningfully distinct @cpponly functions:
- those which were identical to the agnostic functions except for accepting a vector in lieu of a pointer and length parameter (mostly in operations.h)
- those which were notably distinct, e.g. returning vectors or requiring different initialisations of the arguments.

The former have been @cppvectoroverload while the latter remain @cpponly
since they differ trivially from the language-agnostic functions (ptr,len vs vector) yet clutter the API documentation
@TysonRayJones TysonRayJones merged commit c474226 into devel May 22, 2025
130 checks passed
@TysonRayJones TysonRayJones deleted the more-api-doc branch May 22, 2025 18:13
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 this pull request may close these issues.

1 participant