Learn more about our quantum error correction milestone

openfermion.linalg.jw_sz_restrict_state

Restrict a Jordan-Wigner encoded state to a given Sz value

openfermion.linalg.jw_sz_restrict_state(
    state,
    sz_value,
    n_electrons=None,
    n_qubits=None,
    up_index=openfermion.utils.up_index,
    down_index=openfermion.utils.down_index
)

state(ndarray or sparse): Numpy vector in the space of n_qubits. sz_value(float): Desired Sz value. Should be an integer or half-integer. n_electrons(int, optional): Number of particles to restrict the operator to, if such a restriction is desired. n_qubits(int, optional): Number of qubits defining the total state up_index (Callable, optional): Function that maps a spatial index to the index of the corresponding up site down_index (Callable, optional): Function that maps a spatial index to the index of the corresponding down site

new_operator(ndarray or sparse): Numpy vector restricted to states with the desired Sz value. May not be normalized.