state

Model.state(quantum_nums, basis='product', coeffs_basis='product')

Return the state of the model corresponding to the given quantum numbers.

Parameters:

• quantum_nums (Dict[str, float] | Tuple[float, ...]) –

  Quantum numbers. It can be specified by two different ways:

  • By a dict whose keys correspond to the spin names and values correspond to the quantum numbers.

  • By a tuple containing the quantum numbers in the same order as indicated by the spin_names.

• basis (str) – Specifies that the quantum numbers correspond to the product-basis state ('product') or the eigenstate ('eigen') of the model.

• coeffs_basis (str) – Basis in which the returned coefficients are expanded. Must be 'product' or 'eigen'.

Return type:

ndarray

Returns:

state (coefficients either in the product basis or in the eigenbasis)