rydiqule.atom_utils.match_A_QState¶

rydiqule.atom_utils.match_A_QState(qstate: A_QState, compare_list=[], I: float | None = None) → List[A_QState][source]¶

Function to return all states in a list matching the provided pattern.

States are considered a match for qstate if they are an element of the list returned by calling the expand_qnums() on qstate.

Parameters:

qstate (A_QState) – The state against which elements of the list are compared.
compare_list (list, optional) – List of states to test. Any matching the pattern provided by qstate will be in the returned list, by default []
I (float, optional) – Nuclear spin I of the atom containing the provided states, by default None

Returns:

List of all the elements matching the pattern defined by qstate

Return type:

List of A_QState