Class Q5mState<TMaterial>`Abstract`

Abstract base class for quantum states with state vector representation.

Type Parameters

TMaterial extends Q5mMaterial<StateVector | DensityMatrix> = Q5mMaterial<StateVector>

Hierarchy (View Summary)

Q5mState
- QubitState

Accessors

`Protected`isDense

get isDense(): boolean
Flag indicating whether dense or sparse representation is currently used (backward compatibility)

Returns boolean
- Defined in src/core/Q5mState.ts:162

Constructors

`Protected`constructor

new Q5mState<
    TMaterial extends
        Q5mMaterial<Matrix | StateVector> = Q5mMaterial<StateVector>,
>(
    numQuantum: number,
    stateVector?: Complex[],
    enableSparse?: boolean,
    material?: TMaterial,
): Q5mState<TMaterial>
Creates a Q5mState with the specified number of quantum units and optional state vector.
Type Parameters
- TMaterial extends Q5mMaterial<Matrix | StateVector> = Q5mMaterial<StateVector>
Parameters
- numQuantum: number
- OptionalstateVector: Complex[]
- OptionalenableSparse: boolean
- Optionalmaterial: TMaterial
Returns Q5mState<TMaterial>
- Defined in src/core/Q5mState.ts:167

Methods

`Abstract`calculateStateCount

calculateStateCount(numQuantum: number): number
Calculates the state space dimension for the given number of quantum units.
Parameters
- numQuantum: number
Returns number
- Defined in src/core/Q5mState.ts:210

quantumCount

quantumCount(): number
Returns the effective number of quantum units (e.g., qubits) in this state.

Returns number
- Defined in src/core/Q5mState.ts:213

`Protected`getRepState

getRepState(): RepState
Type-safe getter for representation state.

Returns RepState
- Defined in src/core/Q5mState.ts:218

amplitudes

amplitudes(): Complex[]
Returns the full array of quantum amplitudes of the quantum state. Uses memoization to reduce memory allocations for repeated access.

Returns Complex[]
Array of quantum amplitudes.

Remarks
Do not modify the returned array directly.
- Defined in src/core/Q5mState.ts:272

`Protected`getAmplitudesFromSparse

getAmplitudesFromSparse(): Complex[]
Reconstruct full state vector from sparse Map representation.

Returns Complex[]
- Defined in src/core/Q5mState.ts:309

`Protected`getAmplitudesFromCSR

getAmplitudesFromCSR(): Complex[]
Reconstruct full state vector from CSR representation.

Returns Complex[]
- Defined in src/core/Q5mState.ts:320

probabilities

probabilities(): number[]
Returns the measurement probabilities for all computational basis states.

Returns number[]
- Defined in src/core/Q5mState.ts:347

probability

probability(basisIndex: number): number
Returns the probability of measuring a specific computational basis state.
Parameters
- basisIndex: number
Returns number
- Defined in src/core/Q5mState.ts:353

amplitude

amplitude(basisIndex: number): Complex
Returns the quantum amplitude for a specific computational basis state.
Parameters
- basisIndex: number
Returns Complex
- Defined in src/core/Q5mState.ts:358

`Protected`getCSRAmplitude

getCSRAmplitude(basisIndex: number): Complex
Get amplitude from CSR representation.
Parameters
- basisIndex: number
Returns Complex
- Defined in src/core/Q5mState.ts:381

`Abstract`apply

apply(unitary: Q5mOperator<Matrix>): Q5mState
Applies a unitary transformation to the quantum state.
Parameters
- unitary: Q5mOperator<Matrix>
Returns Q5mState
- Defined in src/core/Q5mState.ts:409

evolve

evolve(hamiltonian: Q5mOperator<Matrix>, time: number, hbar?: number): Q5mState
Evolves the quantum state in time according to a Hamiltonian operator.
Parameters
- hamiltonian: Q5mOperator<Matrix>
- time: number
- hbar: number = 1
Returns Q5mState
- Defined in src/core/Q5mState.ts:412

`Abstract`normalize

normalize(): Q5mState
Returns a normalized copy of this quantum state.

Returns Q5mState
- Defined in src/core/Q5mState.ts:421

`Abstract`withAmplitudes

withAmplitudes(newAmplitudes: Complex[]): Q5mState
Creates a new quantum state with the specified amplitudes.
Parameters
- newAmplitudes: Complex[]
Returns Q5mState
- Defined in src/core/Q5mState.ts:424

`Protected`invalidateAmplitudesCache

invalidateAmplitudesCache(): void
Invalidates memoized amplitude cache when state changes.

Returns void
- Defined in src/core/Q5mState.ts:427

`Protected`chooseSparseRepresentation

chooseSparseRepresentation(stateVector: Complex[]): void
Selects the appropriate representation for the quantum state.
Parameters
- stateVector: Complex[]
Returns void
- Defined in src/core/Q5mState.ts:433

`Protected`selectRepType

selectRepType(size: number, nonZeroCount: number): RepType
Select the best representation type based on size and sparsity.
Parameters
- size: number
- nonZeroCount: number
Returns RepType
- Defined in src/core/Q5mState.ts:478

`Protected`shouldUseCSRRepresentation

shouldUseCSRRepresentation(
    size: number,
    sparsity: number,
    nonZeroCount: number,
    sparseMemory: number,
    csrMemory: number,
): boolean
Determine if CSR representation should be used.
Parameters
- size: number
- sparsity: number
- nonZeroCount: number
- sparseMemory: number
- csrMemory: number
Returns boolean
- Defined in src/core/Q5mState.ts:514

`Protected`createCSRFromSparse

createCSRFromSparse(
sparseMap: Map<number, Complex>,
totalSize: number,
): CSRFormat
Create CSR format from sparse Map representation.
Parameters
- sparseMap: Map<number, Complex>
- totalSize: number
Returns CSRFormat
- Defined in src/core/Q5mState.ts:537

`Protected`optimizeCSRFormat

optimizeCSRFormat(csr: CSRFormat): OptimizedCSRFormat
Convert CSR format to memory-optimized TypedArray format.
Parameters
- csr: CSRFormat
Returns OptimizedCSRFormat
- Defined in src/core/Q5mState.ts:563

memoryUsage

memoryUsage(): number
Calculates the estimated memory usage for the current quantum state.

Returns number
- Defined in src/core/Q5mState.ts:583

`Protected`calculateCSRMemoryUsage

calculateCSRMemoryUsage(): number
Calculate memory usage for CSR representation.

Returns number
- Defined in src/core/Q5mState.ts:623

`Protected`applyUnitaryCSR

applyUnitaryCSR(unitaryMatrix: Matrix): Complex[]
Perform efficient matrix-vector multiplication for CSR representation.
Parameters
- unitaryMatrix: Matrix
Returns Complex[]
- Defined in src/core/Q5mState.ts:641

`Protected`applyUnitarySparseCSR

applyUnitarySparseCSR(sparseMatrix: OptimizedCSRFormat): Complex[]
Perform efficient sparse matrix-vector multiplication when both matrix and vector are sparse.
Parameters
- sparseMatrix: OptimizedCSRFormat
Returns Complex[]
- Defined in src/core/Q5mState.ts:691

`Protected`applyUnitaryOptimized

applyUnitaryOptimized(
unitaryMatrix: Matrix,
unitaryOperator?: UnitaryOperator,
): Complex[]
Applies unitary matrix multiplication with representation-aware algorithms.
Parameters
- unitaryMatrix: Matrix
- OptionalunitaryOperator: UnitaryOperator
Returns Complex[]
- Defined in src/core/Q5mState.ts:726

`Protected`applyControlledGateCSR

applyControlledGateCSR(controlledMatrix: Matrix): Complex[]
Optimized application of controlled gates for CSR representation.
Parameters
- controlledMatrix: Matrix
Returns Complex[]
- Defined in src/core/Q5mState.ts:770

`Protected`applySingleQubitGateOptimized

applySingleQubitGateOptimized(singleQubitMatrix: Matrix): Complex[]
Optimized application of single-qubit gates to large quantum systems.
Parameters
- singleQubitMatrix: Matrix
Returns Complex[]
- Defined in src/core/Q5mState.ts:812

`Protected`applyBlockStructuredGate

applyBlockStructuredGate(blockMatrix: Matrix): Complex[]
Optimized application of block-structured gates.
Parameters
- blockMatrix: Matrix
Returns Complex[]
- Defined in src/core/Q5mState.ts:817

`Protected`applyUnitaryDense

applyUnitaryDense(unitaryMatrix: Matrix): Complex[]
Protected
Standard dense matrix-vector multiplication. Uses optimized implementation from math/vector-matrix.ts
Parameters
- unitaryMatrix: Matrix
  Dense unitary matrix
Returns Complex[]
New state vector after multiplication
- Defined in src/core/Q5mState.ts:841

`Protected`applyUnitarySparse

applyUnitarySparse(unitaryMatrix: Matrix): Complex[]
Protected
Sparse matrix-vector multiplication for sparse Map representation. Uses optimized implementation from math/vector-matrix.ts
Parameters
- unitaryMatrix: Matrix
  Dense unitary matrix
Returns Complex[]
New state vector after multiplication
- Defined in src/core/Q5mState.ts:854

Properties

`Protected`stateCount

stateCount: number

The total number of basis states in the Hilbert space (its dimension).

`Protected`numQuantum

numQuantum: number

The number of quantum units (e.g., qubits, qutrits) in this state.

`Protected`material

material: TMaterial

The quantum material associated with this state.

`Protected` `Optional`stateVector

stateVector?: Complex[]

The state vector containing quantum amplitudes for each basis state. Optional for sparse representations.

`Protected` `Optional`sparseAmplitudes

sparseAmplitudes?: Map<number, Complex>

Sparse representation using Map for memory optimization

`Protected` `Optional`csrData

csrData?: CSRFormat

CSR (Compressed Sparse Row) representation for large sparse states

`Protected` `Optional`optimizedCSRData

optimizedCSRData?: OptimizedCSRFormat

Optimized CSR representation using TypedArrays

`Protected`rep

rep: RepType = RepType.DENSE

Current representation type

`Protected`sparseConfig

sparseConfig: SparseConfig = DEFAULT_SPARSE_CONFIG

Configuration for sparse optimization

Class Q5mState<TMaterial>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

ProtectedisDense

Returns boolean

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns Q5mState<TMaterial>

Methods

AbstractcalculateStateCount

Parameters

Returns number

quantumCount

Returns number

ProtectedgetRepState

Returns RepState

amplitudes

Returns Complex[]

Remarks

ProtectedgetAmplitudesFromSparse

Returns Complex[]

ProtectedgetAmplitudesFromCSR

Returns Complex[]

probabilities

Returns number[]

probability

Parameters

Returns number

amplitude

Parameters

Returns Complex

ProtectedgetCSRAmplitude

Parameters

Returns Complex

Abstractapply

Parameters

Returns Q5mState

evolve

Parameters

Returns Q5mState

Abstractnormalize

Returns Q5mState

AbstractwithAmplitudes

Parameters

Returns Q5mState

ProtectedinvalidateAmplitudesCache

Returns void

ProtectedchooseSparseRepresentation

Parameters

Returns void

ProtectedselectRepType

Parameters

Returns RepType

ProtectedshouldUseCSRRepresentation

Parameters

Returns boolean

ProtectedcreateCSRFromSparse

Parameters

Returns CSRFormat

ProtectedoptimizeCSRFormat

Parameters

Returns OptimizedCSRFormat

memoryUsage

Returns number

ProtectedcalculateCSRMemoryUsage

Returns number

ProtectedapplyUnitaryCSR

Parameters

Returns Complex[]

ProtectedapplyUnitarySparseCSR

Parameters

Returns Complex[]

Class Q5mState<TMaterial>`Abstract`

`Protected`isDense

`Protected`constructor

`Abstract`calculateStateCount

`Protected`getRepState

`Protected`getAmplitudesFromSparse

`Protected`getAmplitudesFromCSR

`Protected`getCSRAmplitude

`Abstract`apply

`Abstract`normalize

`Abstract`withAmplitudes

`Protected`invalidateAmplitudesCache

`Protected`chooseSparseRepresentation

`Protected`selectRepType

`Protected`shouldUseCSRRepresentation

`Protected`createCSRFromSparse

`Protected`optimizeCSRFormat

`Protected`calculateCSRMemoryUsage

`Protected`applyUnitaryCSR

`Protected`applyUnitarySparseCSR

`Protected`applyUnitaryOptimized

`Protected`applyControlledGateCSR

`Protected`applySingleQubitGateOptimized

`Protected`applyBlockStructuredGate

`Protected`applyUnitaryDense

`Protected`applyUnitarySparse

`Protected`stateCount

`Protected`numQuantum

`Protected`material

`Protected` `Optional`stateVector

`Protected` `Optional`sparseAmplitudes

`Protected` `Optional`csrData

`Protected` `Optional`optimizedCSRData

`Protected`rep

`Protected`sparseConfig