-
Notifications
You must be signed in to change notification settings - Fork 5
docs: quanticstransform missing documentation for error conditions, conventions, and examples #361
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description
Multiple documentation gaps were identified in tensor4all-quanticstransform by automated feature testing with 6 different user personas.
Missing documentation
- No `# Errors` sections on any public function — users cannot discover error conditions without reading source
- Fourier bit-reversal convention undocumented — QFT output uses bit-reversed ordering, which is not mentioned in
quantics_fourier_operatordocstring - Multi-variable indexing convention undocumented — interleaved bit encoding (
s_n = bit_var0 + 2*bit_var1 + ...) for_multivaroperators is not described anywhere in public docs - Index remapping workflow undocumented — the requirement to remap state indices to match operator
get_input_mapping().true_indexbefore callingapply_linear_operatoris only shown in integration tests - Shift operator semantics misleading — docstring says
f(x) = g(x + offset)but the matrix action is(Mg)[x] = g[x - offset]; the operator maps|x> -> |x+offset>which is the transpose direction AffineParamscolumn-major convention easy to miss —[[1, 2], [3, 4]]stored as[1, 3, 2, 4]BinaryCoeffs(-1, -1)restriction unexplained — rejected but no explanation of why
Missing examples
- No
examples/directory for the crate - No Python example for
quanticstransformindocs/examples/python/ - No end-to-end example showing TCI -> create operator -> apply -> verify results
Inconsistencies
- "sites" vs "bits" terminology used interchangeably for parameter
r
Found by
Automated feature testing of tensor4all-quanticstransform with 6 user personas.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation