Merge pull request #235 from StochasticTree/python-ui-parity

Update Python data interface for parity with the R interface

Author: andrewherren

src/py_stochtree.cpp

@@ -182,6 +182,20 @@ class ResidualCpp {
     residual_->OverwriteData(data_ptr, num_row);
   }
 
+  void AddToData(py::array_t<double> update_vector, data_size_t num_row) {
+    // Extract pointer to contiguous block of memory
+    double* data_ptr = static_cast<double*>(update_vector.mutable_data());
+    // Add to data in residual_
+    residual_->AddToData(data_ptr, num_row);
+  }
+
+  void SubtractFromData(py::array_t<double> update_vector, data_size_t num_row) {
+    // Extract pointer to contiguous block of memory
+    double* data_ptr = static_cast<double*>(update_vector.mutable_data());
+    // Subtract from data in residual_
+    residual_->SubtractFromData(data_ptr, num_row);
+  }
+
  private:
   std::unique_ptr<StochTree::ColumnVector> residual_;
 };
@@ -2224,7 +2238,9 @@ PYBIND11_MODULE(stochtree_cpp, m) {
   py::class_<ResidualCpp>(m, "ResidualCpp")
     .def(py::init<py::array_t<double>,data_size_t>())
     .def("GetResidualArray", &ResidualCpp::GetResidualArray)
-    .def("ReplaceData", &ResidualCpp::ReplaceData);
+    .def("ReplaceData", &ResidualCpp::ReplaceData)
+    .def("AddToData", &ResidualCpp::AddToData)
+    .def("SubtractFromData", &ResidualCpp::SubtractFromData);
 
   py::class_<RngCpp>(m, "RngCpp")
     .def(py::init<int>());

stochtree/data.py

@@ -264,3 +264,37 @@ def update_data(self, new_vector: np.array) -> None:
         """
         n = new_vector.size
         self.residual_cpp.ReplaceData(new_vector, n)
+    
+    def add_vector(self, update_vector: np.array) -> None:
+        """
+        Update the current state of the outcome (i.e. partial residual) data by adding each element of `update_vector`
+
+        Parameters
+        ----------
+        update_vector : np.array
+            Univariate numpy array of values to add to the current residual.
+        """
+        if not isinstance(update_vector, np.ndarray):
+            raise ValueError("update_vector must be a numpy array.")
+        update_vector_ = np.squeeze(update_vector)
+        if not update_vector_.ndim == 1:
+            raise ValueError("update_vector must be a 1-dimensional numpy array.")
+        n = update_vector_.size
+        self.residual_cpp.AddToData(update_vector_, n)
+    
+    def subtract_vector(self, update_vector: np.array) -> None:
+        """
+        Update the current state of the outcome (i.e. partial residual) data by subtracting each element of `update_vector`
+
+        Parameters
+        ----------
+        update_vector : np.array
+            Univariate numpy array of values to subtracted from the current residual.
+        """
+        if not isinstance(update_vector, np.ndarray):
+            raise ValueError("update_vector must be a numpy array.")
+        update_vector_ = np.squeeze(update_vector)
+        if not update_vector_.ndim == 1:
+            raise ValueError("update_vector must be a 1-dimensional numpy array.")
+        n = update_vector_.size
+        self.residual_cpp.SubtractFromData(update_vector_, n)