Tweak AdvancedTypes: use per instance variable to toggle complex

This may allow mixing old and new code more easily.  We can tweak it more if there's user feedback or issues.

Author: PMeira

dss/IDSS.py

@@ -324,6 +324,7 @@ def NewContext(self) -> Self:
         lib = self._api_util.lib_unpatched
         new_ctx = ffi.gc(lib.ctx_New(), lib.ctx_Dispose)
         new_api_util = CffiApiUtil(ffi, lib, new_ctx)
+        new_api_util._allow_complex = self._api_util._allow_complex
         return IDSS(new_api_util)
 
     def __call__(self, single:Union[AnyStr, List[AnyStr]]=None, block : AnyStr = None): #TODO: benchmark and simplify (single argument)
@@ -388,10 +389,10 @@ def Plotting(self):
     @property
     def AdvancedTypes(self) -> bool:
         '''
-        When enabled, there are **two global side-effects**:
+        When enabled, there are **two side-effects**:
         
-        - Complex arrays and complex numbers can be returned and consumed by the Python API.
-        - The low-level API provides matrix dimensions when available (`EnableArrayDimensions` is enabled).
+        - **Per DSS Context:** Complex arrays and complex numbers can be returned and consumed by the Python API.
+        - **Global effect:** The low-level API provides matrix dimensions when available (`EnableArrayDimensions` is enabled).
         
         As a result, for example, `DSS.ActiveCircuit.ActiveCktElement.Yprim` is returned as a complex matrix instead
         of a plain array.
@@ -404,16 +405,13 @@ def AdvancedTypes(self) -> bool:
         '''
 
         arr_dim = self.CheckForError(self._lib.DSS_Get_EnableArrayDimensions()) != 0
-        allow_complex = CffiApiUtil._ADV_TYPES
-        if arr_dim != allow_complex:
-            raise RuntimeError('Invalid state detected.')
-
-        return arr_dim
+        allow_complex = self._api_util._allow_complex
+        return arr_dim and allow_complex
 
     @AdvancedTypes.setter
     def AdvancedTypes(self, Value: bool):
         self.CheckForError(self._lib.DSS_Set_EnableArrayDimensions(Value))
-        CffiApiUtil._ADV_TYPES = bool(Value)
+        self._api_util._allow_complex = bool(Value)
 
     @property
     def CompatFlags(self) -> int:

dss/_cffi_api_util.py

@@ -186,8 +186,6 @@ def _decode_and_free_string(self, s) -> str:
 
 
 class CffiApiUtil(object):
-    _ADV_TYPES = False # class variable, changed globally
-
     def __init__(self, ffi, lib, ctx=None):
         self.owns_ctx = True
         self.codec = codec
@@ -199,10 +197,9 @@ def __init__(self, ffi, lib, ctx=None):
         else:
             self.lib = CtxLib(ctx, lib)
 
+        self._allow_complex = False
         self.init_buffers()
 
-        # Just in case the user has set the env var DSS_CAPI_ARRAY_DIMS=1
-        CffiApiUtil._ADV_TYPES = self.lib.DSS_Get_EnableArrayDimensions()
 
 
     # def __delete__(self):
@@ -252,7 +249,7 @@ def get_float64_array(self, func, *args) -> Float64Array:
         res = np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 8), dtype=np.float64).copy()
         self.lib.DSS_Dispose_PDouble(ptr)
 
-        if self._ADV_TYPES and cnt[3]:
+        if self._allow_complex and cnt[3]:
             # If the last element is filled, we have a matrix.  Otherwise, the 
             # matrix feature is disabled or the result is indeed a vector
             return res.reshape((cnt[2], cnt[3]), order='F')
@@ -261,7 +258,7 @@ def get_float64_array(self, func, *args) -> Float64Array:
 
 
     def get_complex128_array(self, func, *args) -> Float64ArrayOrComplexArray:
-        if not self._ADV_TYPES:
+        if not self._allow_complex:
             return self.get_float64_array(func, *args)
 
         # Currently we use the same as API as get_float64_array, may change later
@@ -280,7 +277,7 @@ def get_complex128_array(self, func, *args) -> Float64ArrayOrComplexArray:
 
 
     def get_complex128_simple(self, func, *args) -> Float64ArrayOrSimpleComplex:
-        if not self._ADV_TYPES:
+        if not self._allow_complex:
             return self.get_float64_array(func, *args)
 
         # Currently we use the same as API as get_float64_array, may change later
@@ -296,26 +293,26 @@ def get_complex128_simple(self, func, *args) -> Float64ArrayOrSimpleComplex:
 
     def get_float64_gr_array(self) -> Float64Array:
         ptr, cnt = self.gr_float64_pointers
-        if self._ADV_TYPES and cnt[3]:
+        if self._allow_complex and cnt[3]:
             return np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 8), dtype=np.float64).copy().reshape((cnt[2], cnt[3]), order='F')
 
         return np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 8), dtype=np.float64).copy()
 
 
     def get_complex128_gr_array(self) -> ComplexArray:
-        if not self._ADV_TYPES:
+        if not self._allow_complex:
             return self.get_float64_gr_array()
 
         # Currently we use the same as API as get_float64_array, may change later
         ptr, cnt = self.gr_float64_pointers
-        if self._ADV_TYPES and cnt[3]:
+        if self._allow_complex and cnt[3]:
             return np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 8), dtype=complex).copy().reshape((cnt[2], cnt[3]), order='F')
 
         return np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 8), dtype=complex).copy()
 
 
     def get_complex128_gr_simple(self) -> Float64ArrayOrSimpleComplex:
-        if not self._ADV_TYPES:
+        if not self._allow_complex:
             return self.get_float64_gr_array()
 
         # Currently we use the same as API as get_float64_array, may change later
@@ -331,7 +328,7 @@ def get_int32_array(self, func: Callable, *args) -> Int32Array:
         res = np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 4), dtype=np.int32).copy()
         self.lib.DSS_Dispose_PInteger(ptr)
 
-        if self._ADV_TYPES and cnt[3]:
+        if self._allow_complex and cnt[3]:
             # If the last element is filled, we have a matrix.  Otherwise, the 
             # matrix feature is disabled or the result is indeed a vector
             return res.reshape((cnt[2], cnt[3]))
@@ -349,7 +346,7 @@ def get_ptr_array(self, func: Callable, *args):
 
     def get_int32_gr_array(self) -> Int32Array:
         ptr, cnt = self.gr_int32_pointers
-        if self._ADV_TYPES and cnt[3]:
+        if self._allow_complex and cnt[3]:
             return np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 4), dtype=np.int32).copy().reshape((cnt[2], cnt[3]))
 
         return np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 4), dtype=np.int32).copy()
@@ -362,7 +359,7 @@ def get_int8_array(self, func: Callable, *args: Any) -> Int8Array:
         res = np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 1), dtype=np.int8).copy()
         self.lib.DSS_Dispose_PByte(ptr)
 
-        if self._ADV_TYPES and cnt[3]:
+        if self._allow_complex and cnt[3]:
             # If the last element is filled, we have a matrix.  Otherwise, the 
             # matrix feature is disabled or the result is indeed a vector
             return res.reshape((cnt[2], cnt[3]))
@@ -371,7 +368,7 @@ def get_int8_array(self, func: Callable, *args: Any) -> Int8Array:
 
     def get_int8_gr_array(self) -> Int8Array:
         ptr, cnt = self.gr_int8_pointers
-        if self._ADV_TYPES and cnt[3]:
+        if self._allow_complex and cnt[3]:
             return np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 1), dtype=np.int8).copy().reshape((cnt[2], cnt[3]), order='F')
 
         return np.frombuffer(self.ffi.buffer(ptr[0], cnt[0] * 1), dtype=np.int8).copy()