API Reference

Complete API documentation for the qig package.

Core Modules

• qig.core
  • partial_trace()
  • von_neumann_entropy()
  • create_lme_state()
  • marginal_entropies()
  • generic_decomposition()
• qig.exponential_family
  • pauli_basis()
  • gell_mann_matrices()
  • qutrit_basis()
  • create_operator_basis()
  • QuantumExponentialFamily
• qig.dynamics
  • InaccessibleGameDynamics
  • GenericDynamics
• qig.pair_operators
  • gell_mann_generators()
  • pair_basis_generators()
  • bell_state()
  • bell_state_density_matrix()
  • multi_pair_basis()
  • product_of_bell_states()
• qig.duhamel
  • Method Selection
  • References
• qig.analysis
• Structure Constants Module
  • compute_structure_constants()
  • verify_lie_algebra()
  • verify_jacobi_identity()
  • verify_antisymmetry()
  • get_cached_structure_constants()
  • cache_structure_constants()
  • compute_and_cache_structure_constants()
  • verify_all_properties()
  • Overview
  • Examples
  • Mathematical Properties
  • See Also
• qig.generic
  • GENERIC Decomposition Components
  • Examples
  • See Also
• qig.generic_decomposition
  • High-Level GENERIC Decomposition Interface
  • Classes
  • Functions
  • The 12-Step Procedure
  • Examples
  • See Also
• Module: qig.symbolic
  • Overview
  • Submodules
  • Example Usage
  • See Also
• Validation Module
  • ValidationCheck
  • ValidationReport
  • compare_matrices()
  • check_hermitian()
  • check_symmetric()
  • check_antisymmetric()
  • check_traceless()
  • check_commutator()
  • finite_difference_jacobian()
  • check_constraint_tangency()
  • check_entropy_monotonicity()
  • check_positive_semidefinite()
• Reference Data Module
  • get_su2_structure_constants()
  • get_su3_structure_constants()
  • verify_structure_constant_properties()
  • get_reference_structure_constants()
  • print_reference_verification()