ArrayProxy updated to use the new API functions

The new functions move some operations to the engine and reduce memory allocations.

Author: PMeira

altdss/ArrayProxy.py

@@ -10,7 +10,7 @@ def to_array(self):
         return self._batch._get_batch_float_prop(self._idx)
 
     def to_list(self):
-        return self._batch._get_batch_float_prop(self._idx)
+        return self._batch._get_batch_float_prop_as_list(self._idx)
 
     def __call__(self):
         return self.to_array()
@@ -60,11 +60,11 @@ def __iadd__(self, other, flags=0):
         if len(other) != len(batch):
             raise ValueError(f"Number of elements ({len(other)}) doesn't match the batch size ({len(batch)})")
 
-        data = self.to_array() + other
-        data, data_ptr, _ = batch._prepare_float64_array(data)
-        batch._lib.Batch_SetFloat64Array(
+        data, data_ptr, _ = batch._prepare_float64_array(other)
+        batch._lib.Batch_Float64Array(
             *ptr_cnt,
             self._idx,
+            self._lib.BatchOperation_Increment,
             data_ptr,
             flags
         )
@@ -77,7 +77,7 @@ def __isub__(self, other, flags=0):
 
         Use `isub` instead of the `-=` operator in order to specify SetterFlags.
         '''
-        return self.__iadd__(-other, flags)
+        return self.__iadd__(-np.asarray(other), flags)
 
     def __imul__(self, other, flags=0):
         '''
@@ -100,18 +100,18 @@ def __imul__(self, other, flags=0):
         if len(other) != len(batch):
             raise ValueError(f"Number of elements ({len(other)}) doesn't match the batch size ({len(batch)})")
 
-        data = self.to_array() * other
-        data, data_ptr, _ = batch._prepare_float64_array(data)
-        batch._lib.Batch_SetFloat64Array(
+        data, data_ptr, _ = batch._prepare_float64_array(other)
+        batch._lib.Batch_Float64Array(
             *ptr_cnt,
             self._idx,
+            self._lib.BatchOperation_Multiply,
             data_ptr,
             flags
         )
         batch._check_for_error()
         return self
 
-    def __idiv__(self, other, flags=0):
+    def __itruediv__(self, other, flags=0):
         '''
         Inplace modification of the array. When possible, it runs the operation in the engine.
 
@@ -123,27 +123,29 @@ def __idiv__(self, other, flags=0):
             self._lib.Batch_Float64(
                 *ptr_cnt,
                 self._idx,
-                self._lib.BatchOperation_Multiply,
-                1 / other,
+                self._lib.BatchOperation_Divide,
+                other,
                 flags
             )
             return self
 
         if len(other) != len(batch):
             raise ValueError(f"Number of elements ({len(other)}) doesn't match the batch size ({len(batch)})")
 
-        data = self.to_array() / other
-        data, data_ptr, _ = batch._prepare_float64_array(data)
-        batch._lib.Batch_SetFloat64Array(
+        data, data_ptr, _ = batch._prepare_float64_array(other)
+        batch._lib.Batch_Float64Array(
             *ptr_cnt,
             self._idx,
+            self._lib.BatchOperation_Divide,
             data_ptr,
             flags
         )
         batch._check_for_error()
         return self
 
-    idiv = __idiv__
+
+
+    idiv = __itruediv__
     imul = __imul__
     iadd = __iadd__
     isub = __isub__
@@ -209,11 +211,11 @@ def __iadd__(self, other, flags=0):
         if len(other) != len(batch):
             raise ValueError(f"Number of elements ({len(other)}) doesn't match the batch size ({len(batch)})")
 
-        data = self.to_array() + other
-        data, data_ptr, _ = batch._api_util.prepare_int32_array(data)
-        batch._lib.Batch_SetInt32Array(
+        data, data_ptr, _ = batch._api_util.prepare_int32_array(other)
+        batch._lib.Batch_Int32Array(
             *ptr_cnt,
             self._idx,
+            self._lib.BatchOperation_Increment,
             data_ptr,
             flags
         )
@@ -226,7 +228,7 @@ def __isub__(self, other, flags=0):
 
         Use `isub` instead of the `-=` operator in order to specify SetterFlags.
         '''
-        return self.__iadd__(-other, flags)
+        return self.__iadd__(-np.asarray(other), flags)
 
     def __imul__(self, other, flags=0):
         '''
@@ -249,18 +251,18 @@ def __imul__(self, other, flags=0):
         if len(other) != len(batch):
             raise ValueError(f"Number of elements ({len(other)}) doesn't match the batch size ({len(batch)})")
 
-        data = self.to_array() * other
-        data, data_ptr, _ = batch._prepare_int32_array(data)
-        batch._lib.Batch_SetInt32Array(
+        data, data_ptr, _ = batch._prepare_int32_array(other)
+        batch._lib.Batch_Int32Array(
             *ptr_cnt,
             self._idx,
+            self._lib.BatchOperation_Multiply,
             data_ptr,
             flags
         )
         batch._check_for_error()
         return self
 
-    def __idiv__(self, other, flags=0):
+    def __ifloordiv__(self, other, flags=0):
         '''
         Inplace modification of the array. When possible, it runs the operation in the engine.
 
@@ -272,27 +274,27 @@ def __idiv__(self, other, flags=0):
             self._lib.Batch_Int32(
                 *ptr_cnt,
                 self._idx,
-                self._lib.BatchOperation_Multiply,
-                1 / other,
+                self._lib.BatchOperation_Divide,
+                other,
                 flags
             )
             return self
 
         if len(other) != len(batch):
             raise ValueError(f"Number of elements ({len(other)}) doesn't match the batch size ({len(batch)})")
 
-        data = self.to_array() / other
-        data, data_ptr, _ = batch._prepare_int32_array(data)
-        self._lib.Batch_SetInt32Array(
+        data, data_ptr, _ = batch._prepare_int32_array(other)
+        self._lib.Batch_Int32Array(
             *ptr_cnt,
             self._idx,
+            self._lib.BatchOperation_Divide,
             data_ptr,
             flags
         )
         batch._check_for_error()
         return self
 
-    idiv = __idiv__
+    idiv = __floordiv__
     imul = __imul__
     iadd = __iadd__
     isub = __isub__

altdss/Batch.py

@@ -31,7 +31,7 @@ def FullName(self) -> List[str]:
         self._check_for_error()
         return res
 
-    def _get_batch_float_func(self, funcname):
+    def _get_batch_float64_func(self, funcname):
         func = self._ffi.addressof(self._api_util.lib_unpatched, funcname)
         res = self._get_float64_array(self._lib.Batch_GetFloat64FromFunc, *self._get_ptr_cnt(), func)
         self._check_for_error()
@@ -281,9 +281,10 @@ def _set_batch_float64_array(self, idx: int, value: Union[BatchFloat64ArrayProxy
         if data_cnt != len(self):
             raise ValueError("Number of elements must match")
 
-        self._lib.Batch_SetFloat64Array(
+        self._lib.Batch_Float64Array(
             *ptr_cnt,
             idx,
+            self._lib.BatchOperation_Set,
             data_ptr,
             flags
         )
@@ -312,9 +313,10 @@ def _set_batch_int32_array(self, idx: int, value: Union[BatchInt32ArrayProxy, in
         if data_cnt != len(self):
             raise ValueError("Number of elements must match")
 
-        self._lib.Batch_SetInt32Array(
+        self._lib.Batch_Int32Array(
             *ptr_cnt,
             idx,
+            self._lib.BatchOperation_Set,
             data_ptr,
             flags
         )

altdss/CircuitElement.py

@@ -63,7 +63,7 @@ def NumConductors(self) -> int:
         '''
         return self._lib.Alt_CE_Get_NumConductors(self._ptr)
 
-    def NumPhases(self) -> int:
+    def NumPhases(self) -> int: #TODO remove? Redundant
         '''
         Number of phases
 

altdss/PDElement.py

@@ -182,7 +182,7 @@ def AccumulatedL(self) -> Float64Array:
 
         Original COM help: https://opendss.epri.com/AccumulatedL.html
         '''
-        return self._get_batch_float_func("Alt_PDE_Get_AccumulatedL")
+        return self._get_batch_float64_func("Alt_PDE_Get_AccumulatedL")
 
     def Lambda(self) -> Float64Array:
         '''
@@ -192,7 +192,7 @@ def Lambda(self) -> Float64Array:
 
         Original COM help: https://opendss.epri.com/Lambda1.html
         '''
-        return self._get_batch_float_func("Alt_PDE_Get_Lambda")
+        return self._get_batch_float64_func("Alt_PDE_Get_Lambda")
 
     def NumCustomers(self) -> Int32Array:
         '''
@@ -238,7 +238,7 @@ def TotalMiles(self) -> Float64Array:
 
         Original COM help: https://opendss.epri.com/TotalMiles1.html
         '''
-        return self._get_batch_float_func("Alt_PDE_Get_TotalMiles")
+        return self._get_batch_float64_func("Alt_PDE_Get_TotalMiles")
 
     def SectionID(self) -> Int32Array:
         '''

docs/changelog.md

@@ -12,6 +12,10 @@ relevant. See [DSS C-API's repository](https://github.com/dss-extensions/dss_cap
 
 - NonUniformBatch: allow `batch[idx]` to get a single element by index.
 - Setters: allow using `None` to clear object references (e.g. `altdss.Load[0].Daily = None`)
+- ArrayProxy: 
+    - Fix `BatchFloat64ArrayProxy.to_list()`. It was returning an array instead a list.
+    - Accepts lists for in-place sub, e.g. `arrayProxy -= [1.1, 1.4]` now works as expected.
+    - Use new low-level operations for in-place operations with array values
 
 
 ## 0.2.1

tests/test_alt.py

@@ -50,6 +50,10 @@
         cls = getattr(altdss, cname)
         if not len(cls):
             continue
+        
+        _ = cls.to_json()
+
+        print(cls, cls._sync_cls_idx, len(cls))
 
         print('=' * 40)
         c = cls[0]