Hash test

simphony/libraries/siepic/__init__.py

@@ -512,6 +512,12 @@ class BidirectionalCoupler(SiEPIC_PDK_Base):
         r"(?:\.sparam)"
     )
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the BidirectionalCoupler component based on component type, and component parameters"""
+
+        return hash(hash(type(self)) + hash(self.thickness) + hash(self.width))
+
     def __init__(self, thickness=220e-9, width=500e-9, **kwargs):
         super().__init__(**kwargs, thickness=thickness, width=width)
 
@@ -584,6 +590,12 @@ class HalfRing(SiEPIC_PDK_Base):
         r"(?:m\.dat)"
     )
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the HalfRing component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.gap) + hash(self.radius) + hash(self.thickness) + hash(self.width) + hash(self.couple_length))
+
     def __init__(
         self,
         gap=30e-9,
@@ -660,6 +672,12 @@ class DirectionalCoupler(SiEPIC_PDK_Base):
         r"(?:m\.sparam)"
     )
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the DirectionalCoupler component based on component type, gap, and length of coupler."""
+
+        return hash(hash(type(self)) + hash(self.gap) + hash(self.Lc))
+
     def __init__(self, gap=200e-9, Lc=10e-6, **kwargs):
         super().__init__(**kwargs, gap=gap, Lc=Lc)
 
@@ -723,6 +741,12 @@ class Terminator(SiEPIC_PDK_Base):
         r"(?:_TE.sparam)"
     )
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the Terminator component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.w1) + hash(self.w2) + hash(self.L))
+
     def __init__(self, w1=500e-9, w2=60e-9, L=10e-6, **kwargs):
         super().__init__(**kwargs, w1=w1, w2=w2, L=L)
 
@@ -793,6 +817,12 @@ class GratingCoupler(SiEPIC_PDK_Base):
         r"(?:\.txt)"
     )
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the GratingCoupler component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.polarization) + hash(self.thickness) + hash(self.deltaw))
+
     def __init__(self, thickness=220e-9, deltaw=0, polarization="TE", **kwargs):
         super().__init__(
             **kwargs, thickness=thickness, deltaw=deltaw, polarization=polarization
@@ -892,6 +922,12 @@ class Waveguide(SiEPIC_PDK_Base):
         r"(?:\.txt)"
     )
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the Waveguide component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.length) + hash(self.width) + hash(self.height) + hash(self.polarization) + hash(self.sigma_ne) + hash(self.sigma_ng) + hash(self.sigma_nd))
+
     def __init__(
         self,
         length=0.0,
@@ -1055,6 +1091,12 @@ class YBranch(SiEPIC_PDK_Base):
         r"(?:\.sparam)"
     )
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the YBranch component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.thickness) + hash(self.width) + hash(type(self.polarization)))
+
     def __init__(self, thickness=220e-9, width=500e-9, polarization="TE", **kwargs):
         if polarization not in ["TE", "TM"]:
             raise ValueError(

simphony/libraries/sipann.py

@@ -343,6 +343,12 @@ class HalfRing(SipannWrapper):
 
     pin_count = 4
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the HalfRing component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.model.gap) + hash(self.model.radius) + hash(self.model.thickness) + hash(self.model.width) + hash(self.model.sw_angle))
+
     def __init__(
         self,
         width: Union[float, np.array],
@@ -407,6 +413,12 @@ class HalfRacetrack(SipannWrapper):
 
     pin_count = 4
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the HalfRacetrack component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.model.gap) + hash(self.model.radius) + hash(self.model.thickness) + hash(self.model.width) + hash(self.model.length) + hash(self.model.sw_angle))
+
     def __init__(
         self,
         width: Union[float, np.array],
@@ -470,6 +482,12 @@ class StraightCoupler(SipannWrapper):
 
     pin_count = 4
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the StraightCoupler component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.model.gap) + hash(self.model.thickness) + hash(self.model.width) + hash(self.model.length) + hash(self.model.sw_angle))
+
     def __init__(
         self,
         width: Union[float, np.array],
@@ -539,6 +557,12 @@ class Standard(SipannWrapper):
 
     pin_count = 4
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the standard-shaped directional coupler component based on component type, and component parameters."""
+
+        return hash(hash(type(self)) + hash(self.model.gap) + hash(self.model.thickness) + hash(self.model.width) + hash(self.model.length) + hash(self.model.sw_angle))
+
     def __init__(
         self,
         width: Union[float, np.array],
@@ -609,6 +633,12 @@ class DoubleHalfRing(SipannWrapper):
 
     pin_count = 4
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the DoubleHalfRing component based on component type, gap, radius, thickness, couple length, and width."""
+
+        return hash(hash(type(self)) + hash(self.model.gap) + hash(self.model.radius) + hash(self.model.thickness) + hash(self.model.width) + hash(self.model.sw_angle))
+
     def __init__(
         self,
         width: Union[float, np.array],
@@ -677,6 +707,12 @@ class AngledHalfRing(SipannWrapper):
 
     pin_count = 4
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the AngledHalfRing component based on component type, gap, radius, thickness, couple length, and width."""
+
+        return hash(hash(type(self)) + hash(self.model.gap) + hash(self.model.radius) + hash(self.model.thickness) + hash(self.model.width) + hash(self.model.theta) + hash(self.model.sw_angle))
+
     def __init__(
         self,
         width: Union[float, np.array],
@@ -744,6 +780,12 @@ def __init__(
             **kwargs
         )
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the staright waveguide component based on component type, gap, radius, thickness, couple length, and width."""
+
+        return hash(hash(type(self)) + hash(self.model.thickness) + hash(self.model.width) + hash(self.model.length) + hash(self.model.sw_angle))
+
 
 class Racetrack(SipannWrapper):
     """Racetrack waveguide arc, used to connect to a racetrack directional
@@ -789,6 +831,12 @@ class Racetrack(SipannWrapper):
 
     pin_count = 2
 
+    def __hash__(self) -> int:
+
+        """Gets a hash for the Racetrack component based on component type, gap, radius, thickness, couple length, and width."""
+
+        return hash(hash(type(self)) + hash(self.gap) + hash(self.radius) + hash(self.thickness) + hash(self.width) + + hash(self.length) + hash(self.sw_angle) + hash(self.sigmas))
+
     def __init__(
         self,
         width: Union[float, np.array],
@@ -831,6 +879,12 @@ class PremadeCoupler(SipannWrapper):
 
     pin_count = 4
 
+    def __hash__(self) -> int:
+
+        """Gets a hash value for the premade coupler component based on type, and 'split' parameter value."""
+
+        return hash(hash(type(self)) + hash(self.split))
+
     def __init__(self, split: int, sigmas: Dict[str, float] = dict(), **kwargs) -> None:
         """Loads the premade coupler based on the given split value.
 

simphony/models.py

@@ -53,6 +53,11 @@ class Model:
     pins: ClassVar[Optional[Tuple[str, ...]]]
     pins: PinList  # additional type hint for instance.pins
 
+    def __hash__(self) -> int:
+        """Gets a hash for the model based on pin count and freq range."""
+
+        return hash(hash(self.pin_count) + hash(self.freq_range))
+
     def __getitem__(self, item: Union[int, str]) -> Pin:
         return self.pins[item]