setResidualEquation deprecation

Author: cadenmyers13

docs/examples/crystalpdfall.py

@@ -97,10 +97,10 @@ def makeRecipe(
     xcontribution_sini.set_equation("scale * (xG_sini_ni +  xG_sini_si)")
 
     # As explained in another example, we want to minimize using Rw^2.
-    xcontribution_ni.setResidualEquation("resv")
-    xcontribution_si.setResidualEquation("resv")
-    ncontribution_ni.setResidualEquation("resv")
-    xcontribution_sini.setResidualEquation("resv")
+    xcontribution_ni.set_residual_equation("resv")
+    xcontribution_si.set_residual_equation("resv")
+    ncontribution_ni.set_residual_equation("resv")
+    xcontribution_sini.set_residual_equation("resv")
 
     # Make the FitRecipe and add the FitContributions.
     recipe = FitRecipe()

docs/examples/crystalpdftwodata.py

@@ -105,8 +105,8 @@ def makeRecipe(ciffile, xdatname, ndatname):
     # The contribution's residual can be either chi^2, Rw^2, or custom crafted.
     # In this case, we should minimize Rw^2 of each contribution so that each
     # one can contribute roughly equally to the fit.
-    xcontribution.setResidualEquation("resv")
-    ncontribution.setResidualEquation("resv")
+    xcontribution.set_residual_equation("resv")
+    ncontribution.set_residual_equation("resv")
 
     # Make the FitRecipe and add the FitContributions.
     recipe = FitRecipe()

docs/examples/ellipsoidsas.py

@@ -64,7 +64,7 @@ def makeRecipe(datname):
     # higher-Q information remains significant. There are no I(Q) uncertainty
     # values with the data, so we do not need to worry about the effect this
     # will have on the estimated parameter uncertainties.
-    contribution.setResidualEquation("log(eq) - log(y)")
+    contribution.set_residual_equation("log(eq) - log(y)")
 
     # Make the FitRecipe and add the FitContribution.
     recipe = FitRecipe()

docs/examples/nppdfsas.py

@@ -59,7 +59,7 @@ def makeRecipe(ciffile, grdata, iqdata):
     stru = loadCrystal(ciffile)
     pdfgenerator.setStructure(stru)
     pdfcontribution.add_profile_generator(pdfgenerator)
-    pdfcontribution.setResidualEquation("resv")
+    pdfcontribution.set_residual_equation("resv")
 
     # Create a SAS contribution as well. We assume the nanoparticle is roughly
     # elliptical.
@@ -78,7 +78,7 @@ def makeRecipe(ciffile, grdata, iqdata):
     model = EllipsoidModel()
     sasgenerator = SASGenerator("generator", model)
     sascontribution.add_profile_generator(sasgenerator)
-    sascontribution.setResidualEquation("resv")
+    sascontribution.set_residual_equation("resv")
 
     # Now we set up a characteristic function calculator that depends on the
     # sas model.

src/diffpy/srfit/fitbase/fitcontribution.py

@@ -63,6 +63,13 @@
     removal_version,
 )
 
+setresidualequation_dep_msg = build_deprecation_message(
+    base,
+    "setResidualEquation",
+    "set_residual_equation",
+    removal_version,
+)
+
 
 class FitContribution(ParameterSet):
     """FitContribution class.
@@ -186,7 +193,7 @@ def set_profile(self, profile, xname=None, yname=None, dyname=None):
 
         # If we have _eq, but not _reseq, set the residual
         if self._eq is not None and self._reseq is None:
-            self.setResidualEquation("chiv")
+            self.set_residual_equation("chiv")
 
         return
 
@@ -262,7 +269,7 @@ def set_equation(self, eqstr, ns={}):
 
         This sets the equation that will be used when generating the residual
         for this FitContribution.  The equation will be usable within
-        setResidualEquation as "eq", and it takes no arguments.
+        set_residual_equation as "eq", and it takes no arguments.
 
         Attributes
         ----------
@@ -296,7 +303,7 @@ def set_equation(self, eqstr, ns={}):
 
         # Set the residual if we need to
         if self.profile is not None and self._reseq is None:
-            self.setResidualEquation("chiv")
+            self.set_residual_equation("chiv")
 
         return
 
@@ -334,7 +341,7 @@ def getEquation(self):
         """
         return self.get_equation()
 
-    def setResidualEquation(self, eqstr):
+    def set_residual_equation(self, eqstr):
         """Set the residual equation for the FitContribution.
 
         Attributes
@@ -378,6 +385,18 @@ def setResidualEquation(self, eqstr):
 
         return
 
+    @deprecated(setresidualequation_dep_msg)
+    def setResidualEquation(self, eqstr):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use
+        diffpy.srfit.fitbase.FitContribution.set_residual_equation
+        instead.
+        """
+        self.set_residual_equation(eqstr)
+        return
+
     def getResidualEquation(self):
         """Get math expression string for the active residual equation.
 
@@ -402,7 +421,7 @@ def residual(self):
         chiv = (eq() - self.profile.y) / self.profile.dy
         The value that is optimized is dot(chiv, chiv).
 
-        The residual equation can be changed with the setResidualEquation
+        The residual equation can be changed with the set_residual_equation
         method.
         """
         # Assign the calculated profile

src/diffpy/srfit/fitbase/simplerecipe.py

@@ -288,8 +288,8 @@ def set_equation(self, eqstr, ns={}):
         """Set the profile equation for the FitContribution.
 
         This sets the equation that will be used when generating the residual.
-        The equation will be usable within setResidualEquation as "eq", and it
-        takes no arguments.
+        The equation will be usable within set_residual_equation as "eq", and
+        it takes no arguments.
 
         Attributes
         ----------

tests/test_contribution.py

@@ -155,6 +155,17 @@ def testReplacements(self):
         self.assertEqual(len(xobs2), len(fc.residual()))
         return
 
+    def test_get_residual_equation(self):
+        """Check getting the current formula for residual equation."""
+        fc = self.fitcontribution
+        self.assertEqual("", fc.getResidualEquation())
+        fc.set_profile(self.profile)
+        fc.set_equation("A * x + B")
+        self.assertEqual("((eq - y) / dy)", fc.getResidualEquation())
+        fc.set_residual_equation("2 * (eq - y)")
+        self.assertEqual("(2 * (eq - y))", fc.getResidualEquation())
+        return
+
     def test_getResidualEquation(self):
         """Check getting the current formula for residual equation."""
         fc = self.fitcontribution
@@ -175,7 +186,7 @@ def test_releaseOldEquations(self):
         self.assertEqual(1, len(fc._eqfactory.equations))
         fc.set_profile(self.profile)
         for i in range(5):
-            fc.setResidualEquation("chiv")
+            fc.set_residual_equation("chiv")
         self.assertEqual(2, len(fc._eqfactory.equations))
         return
 
@@ -258,26 +269,26 @@ def testResidual(noObserversInGlobalBuilders):
 
     # Choose a new residual.
     fc.set_equation("2*I")
-    fc.setResidualEquation("resv")
+    fc.set_residual_equation("resv")
     chiv = fc.residual()
     assert dot(chiv, chiv) == pytest.approx(
         sum((2 * xobs - yobs) ** 2) / sum(yobs**2)
     )
 
     # Make a custom residual.
-    fc.setResidualEquation("abs(eq-y)**0.5")
+    fc.set_residual_equation("abs(eq-y)**0.5")
     chiv = fc.residual()
     assert dot(chiv, chiv) == pytest.approx(sum(abs(2 * xobs - yobs)))
 
     # Test configuration checks
     fc1 = FitContribution("test1")
     with pytest.raises(SrFitError):
-        fc1.setResidualEquation("chiv")
+        fc1.set_residual_equation("chiv")
     fc1.set_profile(profile)
     with pytest.raises(SrFitError):
-        fc1.setResidualEquation("chiv")
+        fc1.set_residual_equation("chiv")
     fc1.set_equation("A * x")
-    fc1.setResidualEquation("chiv")
+    fc1.set_residual_equation("chiv")
     assert noObserversInGlobalBuilders
     return