PySparQ.pysparq 源代码

"""PySparQ type stubs - re-exports all public API from the _core module."""
from __future__ import annotations

import pysparq._core as _core
from pysparq._core import __all__ as __all__

from pysparq._core import (
    SparseState,
    System,
    StateStorage,
    StateStorageType,
    UnsignedInteger,
    SignedInteger,
    Boolean,
    Rational,
    SparseMatrix,
    DenseMatrix_complex,
    DenseMatrix_float64,
    BaseOperator,
    SelfAdjointOperator,
    AddRegister,
    AddRegisterWithHadamard,
    RemoveRegister,
    MoveBackRegister,
    SplitRegister,
    CombineRegister,
    Push,
    Pop,
    ClearZero,
    Normalize,
    Init_Unsafe,
    ModuleInheritance_Test,
    ModuleInheritance_Test_SelfAdjoint,
    CheckNormalization,
    CheckNan,
    ViewNormalization,
    TestRemovable,
    CheckDuplicateKey,
    Hadamard_Int,
    Hadamard_Int_Full,
    Hadamard_Bool,
    Hadamard_Partial,
    ZeroConditionalPhaseFlip,
    Reflection_Bool,
    GlobalPhase,
    PartialTrace,
    PartialTraceSelect,
    PartialTraceSelectRange,
    QFT,
    InverseQFT,
    QRAMCircuit_qutrit,
    QRAMLoad,
    QRAMLoadFast,
    X_Bool,
    FlipBools,
    Swap_Bool_Bool,
    ShiftLeft_InPlace,
    ShiftRight_InPlace,
    Mult_UInt_ConstUInt,
    Add_Mult_UInt_ConstUInt_InPlace,
    Mod_Mult_UInt_ConstUInt_InPlace,
    Add_UInt_UInt,
    Add_UInt_UInt_InPlace,
    Add_UInt_ConstUInt,
    Add_ConstUInt_InPlace,
    Div_Sqrt_Arccos_UInt_UInt,
    Sqrt_Div_Arccos_Int_UInt,
    GetRotateAngle_Int_Int,
    Sub_UInt_UInt,
    Neg_UInt,
    Abs_SInt,
    Mul_UInt_UInt,
    Div_UInt_UInt,
    Sqrt_UInt,
    Select_Bool_UInt_UInt,
    And_UInt_UInt,
    Or_UInt_UInt,
    Xor_UInt_UInt,
    Less_SInt_SInt,
    Carry_UInt_UInt,
    Overflow_SInt_SInt,
    MulOverflow_UInt_UInt,
    IsZero_UInt,
    Negative_SInt,
    Add_AnyInt_AnyInt_InPlace,
    Assign,
    Compare_UInt_UInt,
    Less_UInt_UInt,
    Swap_General_General,
    GetMid_UInt_UInt,
    CustomArithmetic,
    StateHashExceptKey,
    StateHashExceptQubits,
    StateEqualExceptKey,
    StateEqualExceptQubits,
    StateLessExceptKey,
    StateLessExceptQubits,
    Rot_GeneralUnitary,
    Rot_GeneralStatePrep,
    stateprep_unitary_build_schmidt,
    SortExceptKey,
    SortByKey,
    SortExceptBit,
    SortExceptKeyHadamard,
    SortUnconditional,
    SortByAmplitude,
    SortByKey2,
    Phase_Bool,
    Rot_Bool,
    Y_Bool,
    Z_Bool,
    S_Bool,
    T_Bool,
    RX_Bool,
    RY_Bool,
    RZ_Bool,
    SX_Bool,
    U2_Bool,
    U3_Bool,
    CondRot_Rational_Bool,
    CondRot_Fixed_Bool,
    CondRot_General_Bool_QW_fast,
    GetQWRotateAngle_Int_Int_Int,
    PlusOneAndOverflow,
    split_systems,
    combine_systems,
    merge_system,
    remove_system,
    StatePrintDisplay,
)


# Deprecated aliases kept for backward compatibility; resolved at runtime by
# the module-level __getattr__ in __init__.py (emits DeprecationWarning).
# See docs/naming_conventions.md; remove in the next major version.


Xgate_Bool: type[X_Bool]



Ygate_Bool: type[Y_Bool]



Zgate_Bool: type[Z_Bool]



Sgate_Bool: type[S_Bool]



Tgate_Bool: type[T_Bool]



RXgate_Bool: type[RX_Bool]



RYgate_Bool: type[RY_Bool]



RZgate_Bool: type[RZ_Bool]



SXgate_Bool: type[SX_Bool]



U2gate_Bool: type[U2_Bool]



U3gate_Bool: type[U3_Bool]



inverseQFT: type[InverseQFT]



GlobalPhase_Int: type[GlobalPhase]



AddAssign_AnyInt_AnyInt_InPlace: type[Add_AnyInt_AnyInt_InPlace]



Div_Sqrt_Arccos_Int_Int: type[Div_Sqrt_Arccos_UInt_UInt]



Sqrt_Div_Arccos_Int_Int: type[Sqrt_Div_Arccos_Int_UInt]



Hadamard_PartialQubit: type[Hadamard_Partial]



QuantumBinarySearchFast: type[QuantumBinarySearch_Fast]



# Python-only functions and classes


def StatePrint(
    state: SparseState,
    mode: int | "StatePrintDisplay" = 1,
    precision: int = 0,
) -> str:
    """Return a formatted string representation of a SparseState."""
    ...





def to_string(
    state: SparseState,
    mode: int | "StatePrintDisplay" = 1,
    precision: int = 0,
) -> str:
    """Return a formatted string representation of a SparseState (alias for StatePrint)."""
    ...





def print(state: SparseState, mode: int | "StatePrintDisplay" = 1, precision: int = 0) -> None:
    """Print a SparseState to stdout in Detail mode."""
    ...





def test_import() -> None:
    """Test that the PySparQ import works correctly."""
    ...





class StatePrinter:
    """Reusable state formatter with configurable default mode."""

    def __init__(
        self,
        mode: int | "StatePrintDisplay" = 1,
        precision: int = 0,
    ) -> None:
        ...
    def __call__(
        self,
        state: SparseState,
        mode: int | "StatePrintDisplay" | None = None,
    ) -> str:
        """Format a state using this printer's mode (or override it)."""
        ...
    def __str__(self) -> str: ...
    def __repr__(self) -> str: ...


    mode: int



    precision: int