toqito.states.dicke¶

Dicke states are an equal-weight superposition of all n-qubit states with Hamming Weight k.

Module Contents¶

toqito.states.dicke.dicke(num_qubit, num_exfootcited, return_dm=False)[source]¶

Produce a Dicke state with specified excitations.

The Dicke state is a quantum state with a fixed number of excitations (i.e., num_exfootcited) distributed across the given number of qubits (i.e., num_qubit). It is symmetric and represents an equal superposition of all possible states with the specified number of exfootcited qubits.

Example Consider generating a Dicke state with 3 qubits and 1 excitation:

`python exec="1" source="above" from toqito.states import dicke print(dicke(3, 1)) `

If we request the density matrix for this state, the return value is:

`python exec="1" source="above" from toqito.states import dicke print(dicke(3, 1, return_dm=True)) `

Raises:

ValueError – If the number of excitations exceeds the number of qubits.

Parameters:

num_qubit (int) – The total number of qubits in the system.
num_exfootcited (int) – The number of qubits that are in the exfootcited state.
return_dm (bool) – If True, returns the state as a density matrix (default is False).

Returns:

The Dicke state vector or density matrix as a NumPy array.

Return type:

numpy.ndarray