rename apply_on_site_num_num_interaction to apply_on_site_interaction

pyproject.toml

@@ -19,6 +19,7 @@ dependencies = [
     "pyscf>=2.3.0",
     "qiskit >= 1.0.0",
     "scipy",
+    "typing-extensions",
 ]
 
 [project.urls]

python/ffsim/__init__.py

@@ -21,6 +21,7 @@
     apply_num_num_interaction,
     apply_num_op_prod_interaction,
     apply_num_op_sum_evolution,
+    apply_on_site_interaction,
     apply_on_site_num_num_interaction,
     apply_orbital_rotation,
     apply_tunneling_interaction,
@@ -103,6 +104,7 @@
     "apply_num_num_interaction",
     "apply_num_op_prod_interaction",
     "apply_num_op_sum_evolution",
+    "apply_on_site_interaction",
     "apply_on_site_num_num_interaction",
     "apply_orbital_rotation",
     "apply_tunneling_interaction",

python/ffsim/gates/__init__.py

@@ -17,6 +17,7 @@
     apply_num_interaction,
     apply_num_num_interaction,
     apply_num_op_prod_interaction,
+    apply_on_site_interaction,
     apply_on_site_num_num_interaction,
     apply_tunneling_interaction,
 )
@@ -33,6 +34,7 @@
     "apply_num_num_interaction",
     "apply_num_op_prod_interaction",
     "apply_num_op_sum_evolution",
+    "apply_on_site_interaction",
     "apply_on_site_num_num_interaction",
     "apply_orbital_rotation",
     "apply_tunneling_interaction",

python/ffsim/gates/basic_gates.py

@@ -17,6 +17,7 @@
 from collections.abc import Sequence
 
 import numpy as np
+from typing_extensions import deprecated
 
 from ffsim.gates.orbital_rotation import _one_subspace_indices, apply_orbital_rotation
 from ffsim.spin import Spin
@@ -311,6 +312,7 @@ def apply_num_num_interaction(
     return vec
 
 
+@deprecated("Use apply_on_site_interaction instead.")
 def apply_on_site_num_num_interaction(
     vec: np.ndarray,
     theta: float,
@@ -320,9 +322,27 @@ def apply_on_site_num_num_interaction(
     *,
     copy: bool = True,
 ):
-    r"""Apply an on-site number-number interaction gate.
+    r"""Apply an on-site interaction gate.
 
-    The on-site number-number interaction gate is
+    This function is deprecated. Use :func:`ffsim.apply_on_site_interaction` instead.
+    """
+    return apply_on_site_interaction(
+        vec=vec, theta=theta, target_orb=target_orb, norb=norb, nelec=nelec, copy=copy
+    )
+
+
+def apply_on_site_interaction(
+    vec: np.ndarray,
+    theta: float,
+    target_orb: int,
+    norb: int,
+    nelec: tuple[int, int],
+    *,
+    copy: bool = True,
+):
+    r"""Apply an on-site interaction gate.
+
+    The on-site interaction gate is
 
     .. math::
 

tests/python/gates/basic_gates_test.py

@@ -227,16 +227,14 @@ def test_apply_num_num_interaction_eigenvalues(norb: int, nelec: tuple[int, int]
 
 
 @pytest.mark.parametrize("norb, nelec", ffsim.testing.generate_norb_nelec(range(4)))
-def test_apply_on_site_num_num_interaction(norb: int, nelec: tuple[int, int]):
+def test_apply_on_site_interaction(norb: int, nelec: tuple[int, int]):
     """Test applying on-site number-number interaction."""
     dim = ffsim.dim(norb, nelec)
     rng = np.random.default_rng()
     vec = np.array(ffsim.random.random_statevector(dim, seed=rng))
     theta = rng.uniform(-10, 10)
     for i in range(norb):
-        result = ffsim.apply_on_site_num_num_interaction(
-            vec, theta, i, norb=norb, nelec=nelec
-        )
+        result = ffsim.apply_on_site_interaction(vec, theta, i, norb=norb, nelec=nelec)
         generator = ffsim.FermionOperator(
             {
                 (
@@ -351,3 +349,12 @@ def mat(theta: float) -> np.ndarray:
                     norb=norb,
                     spin=spin,
                 )
+
+
+def test_deprecations():
+    """Test deprecation warnings are raised properly."""
+    norb = 2
+    nelec = (1, 1)
+    vec = ffsim.hartree_fock_state(norb, nelec)
+    with pytest.warns(DeprecationWarning):
+        _ = ffsim.apply_on_site_num_num_interaction(vec, 0.1, 0, norb=norb, nelec=nelec)