najaeda 0.2.2__cp312-cp312-macosx_11_0_arm64.whl → 0.2.4__cp312-cp312-macosx_11_0_arm64.whl

najaeda/__init__.py

@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: 2025 The Naja authors
+# <https://github.com/najaeda/naja/blob/main/AUTHORS>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from ._version import version, git_hash
+
+__all__ = ["version", "git_hash"]

najaeda/_version.py

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2025 The Naja authors
+# <https://github.com/najaeda/naja/blob/main/AUTHORS>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from najaeda import naja
+
+
+def version():
+    """Get the version of Naja."""
+    return naja.getVersion()
+
+
+def git_hash():
+    """Get the git hash of Naja."""
+    return naja.getGitHash()

najaeda/docs/source/instance.rst

@@ -10,6 +10,21 @@ of an instance in its hierarchical context.
 When an **Instance** is modified through editing methods,
 **najaeda** will automatically manage the necessary uniquification.
 
+Generic Gates (and, or, etc.)
+-----------------------------
+
+**najaeda** supports **generic gates** as defined in Verilog, specifically:
+
+- **n-input gates**: `and`, `nand`, `or`, `nor`, `xor`, `xnor`
+- **n-output gates**: `buf`, `not`
+
+In this model:
+
+- **n-input gates** have a **single scalar output** and a **bus input terminal** (of size *n*).
+- **n-output gates** have a **scalar input** and a **bus output terminal** (of size *n*).
+
+All terminals in these generic instances are **unnamed**,
+
 Instance Attributes
 -------------------
 

najaeda/netlist.py

@@ -3,7 +3,6 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-import itertools
 import time
 import logging
 import hashlib
@@ -133,27 +132,31 @@ class Equipotential:
             for term in self.equi.getTerms():
                 yield Term([], term)
 
-    def get_leaf_readers(self):
+    def get_leaf_readers(self, filter=None):
         if self.equi is not None:
             for term in self.equi.getInstTermOccurrences():
                 direction = term.getInstTerm().getDirection()
-                if direction != naja.SNLTerm.Direction.Output:
-                    if term.getInstTerm().getInstance().getModel().isLeaf():
-                        path = term.getPath().getPathIDs()
-                        path.append(term.getInstTerm().getInstance().getID())
-                        yield Term(path,
-                            term.getInstTerm().getBitTerm())
-
-    def get_leaf_drivers(self):
+                if (
+                    direction != naja.SNLTerm.Direction.Output and
+                    term.getInstTerm().getInstance().getModel().isLeaf() and
+                    (filter is None or filter(term))
+                ):
+                    path = term.getPath().getPathIDs()
+                    path.append(term.getInstTerm().getInstance().getID())
+                    yield Term(path, term.getInstTerm().getBitTerm())
+
+    def get_leaf_drivers(self, filter=None):
         if self.equi is not None:
             for term in self.equi.getInstTermOccurrences():
                 direction = term.getInstTerm().getDirection()
-                if direction != naja.SNLTerm.Direction.Input:
-                    if term.getInstTerm().getInstance().getModel().isLeaf():
-                        path = term.getPath().getPathIDs()
-                        path.append(term.getInstTerm().getInstance().getID())
-                        yield Term(path,
-                            term.getInstTerm().getBitTerm())
+                if (
+                    direction != naja.SNLTerm.Direction.Input and
+                    term.getInstTerm().getInstance().getModel().isLeaf() and
+                    (filter is None or filter(term))
+                ):
+                    path = term.getPath().getPathIDs()
+                    path.append(term.getInstTerm().getInstance().getID())
+                    yield Term(path, term.getInstTerm().getBitTerm())
 
     def get_top_readers(self):
         if self.equi is not None:
@@ -207,14 +210,15 @@ class Net:
         return not eq_result
 
     def __str__(self):
-        if hasattr(self, "net"):
-            net_str = str(self.net)
-        elif hasattr(self, "net_concat"):
+        if self.is_concat():
             net_str = "{" + ",".join(map(str, self.net_concat)) + "}"
+            return net_str
+        net_str = str(self.net)
         path = get_snl_path_from_id_list(self.pathIDs)
         if path.size() > 0:
             return f"{path}/{net_str}"
-        return net_str
+        else:
+            return net_str
 
     def get_name(self) -> str:
         """
@@ -225,6 +229,27 @@ class Net:
             return self.net.getName()
         return "{" + ",".join(map(str, self.net_concat)) + "}"
 
+    def set_name(self, name: str):
+        """
+        :param str name: the name to set for this Net.
+        """
+        if self.is_concat():
+            raise ValueError(
+                f"set_name of {self}: cannot set name for a concatenated net. "
+                "Use the individual nets instead."
+            )
+        elif self.is_bus_bit():
+            raise ValueError(
+                f"set_name of {self}: cannot set name for a bus bit. "
+                "Use the bus net instead."
+            )
+        else:
+            # We need to uniquify until parent instance if parent instance is not top.
+            path = get_snl_path_from_id_list(self.pathIDs)
+            if path.size():
+                naja.SNLUniquifier(path.getHeadPath())
+            self.net.setName(name)
+
     def get_msb(self) -> int:
         """
         :return: the most significant bit of the net if it is a bus.
@@ -286,10 +311,7 @@ class Net:
         if hasattr(self, "net"):
             return self.net.isConstant()
         else:
-            for net in self.net_concat:
-                if not net.isConstant():
-                    return False
-            return True
+            return all(net.isConstant() for net in self.net_concat)
 
     def set_type(self, net_type: Type):
         """
@@ -324,7 +346,7 @@ class Net:
                 yield self
         else:
             for net in self.net_concat:
-                yield Net(net)
+                yield Net(self.pathIDs, net)
 
     def get_bit(self, index: int):
         """
@@ -391,8 +413,8 @@ class Net:
         :return: an iterator over the terminals of the net.
         :rtype: Iterator[Term]
         """
-        for term in itertools.chain(self.get_design_terms(), self.get_inst_terms()):
-            yield term
+        yield from self.get_design_terms()
+        yield from self.get_inst_terms()
 
 
 def get_snl_term_for_ids(pathIDs, termIDs):
@@ -534,6 +556,22 @@ class Term:
         """
         return self.is_scalar() or self.is_bus_bit()
 
+    def is_sequential(self) -> bool:
+        """
+        :return: True if the term is a sequential term.
+        :rtype: bool
+        """
+        for term in self.get_instance().get_flat_terms():
+            clockRelatedInputs = term.get_instance().get_clock_related_inputs(term)
+            if self in clockRelatedInputs:
+                return True
+            clockRelatedOutputs = term.get_instance().get_clock_related_outputs(term)
+            if self in clockRelatedOutputs:
+                return True
+            if (len(clockRelatedInputs) > 0 or len(clockRelatedOutputs) > 0) and (term == self):
+                return True
+        return False
+
     def get_bit_number(self):
         """
         :return: the bit index of the term if it is a bit.
@@ -577,6 +615,13 @@ class Term:
         """
         return get_snl_term_for_ids(self.pathIDs, self.termIDs).getName()
 
+    def is_unnamed(self) -> bool:
+        """
+        :return: True if the term is unnamed.
+        :rtype: bool
+        """
+        return get_snl_term_for_ids(self.pathIDs, self.termIDs).isUnnamed()
+
     def get_direction(self) -> Direction:
         """
         :return: the direction of the term.
@@ -593,7 +638,7 @@ class Term:
     def __get_snl_bitnet(self, bit) -> Net:
         # single bit
         path = get_snl_path_from_id_list(self.pathIDs)
-        if path.size() > 0:
+        if path.size():
             instTerm = path.getTailInstance().getInstTerm(bit)
             return instTerm.getNet()
         else:
@@ -668,8 +713,11 @@ class Term:
         """
         return Instance(self.pathIDs)
 
-    def get_flat_fanout(self):
-        return self.get_equipotential().get_leaf_readers()
+    def get_flat_fanout(self, filter=None):
+        return self.get_equipotential().get_leaf_readers(filter=filter)
+
+    def count_flat_fanout(self, filter=None):
+        return sum(1 for _ in self.get_flat_fanout(filter=filter))
 
     def get_equipotential(self) -> Equipotential:
         """
@@ -753,6 +801,25 @@ class Term:
                 iterm = inst.getInstTerm(bterm)
                 iterm.setNet(bnet)
 
+    def get_truth_table(self):
+        # check the index of the output
+        if not self.is_output():
+            raise ValueError("Truth table can only be computed for output terms")
+        # get the instance
+        if self.is_bus():
+            raise ValueError("Truth table cannot be computed for bus terms")
+        inst = self.get_instance()
+        # get the model
+        model = inst._Instance__get_snl_model()
+        for term in model.getTerms():
+            if term.getDirection() == naja.SNLTerm.Direction.Output:
+                if term.getName() == self.get_name():
+                    # get the truth table
+                    tt = model.getTruthTableByOutputID(term.getID())
+                    if tt is not None:
+                        return model.getTruthTableByOutputID(term.getID())
+        return None
+
 
 def get_instance_by_path(names: list):
     assert len(names) > 0
@@ -813,16 +880,15 @@ class Attribute:
 
 
 class Instance:
-    """Class that represents the instance and wraps some
-    of the snl occurrence API.
+    """Class that represents an instance in the design hierarchy.
     """
 
     def __init__(self, path=naja.SNLPath()):
         self.inst = None
         self.revisionCount = 0
-        self.SNLID = [0, 0, 0, 0, 0, 0]
+        self.SNLID = [0] * 6
         if isinstance(path, naja.SNLPath):
-            if path.size() > 0:
+            if path.size():
                 self.pathIDs = path.getPathIDs()
                 self.revisionCount = path.getTailInstance().getModel().getRevisionCount()
                 self.inst = path.getTailInstance()
@@ -830,10 +896,10 @@ class Instance:
                 self.pathIDs = []
         elif isinstance(path, list):
             self.pathIDs = path.copy()
-            if len(path) > 0:
+            if path:
                 self.inst = get_snl_instance_from_id_list(path)
                 self.revisionCount = self.inst.getModel().getRevisionCount()
-        if self.inst is not None:
+        if self.inst:
             self.SNLID = self.inst.getModel().getNLID()
 
     def __eq__(self, other) -> bool:
@@ -946,12 +1012,6 @@ class Instance:
         """
         return self.__get_snl_model().isInv()
 
-    def is_basic_primitive(instance):
-        design = instance.__get_snl_model()
-        return (
-            design.isConst0() or design.isConst1() or design.isBuf() or design.isInv()
-        )
-
     def __get_snl_model(self):
         if self.is_top():
             return naja.NLUniverse.get().getTopDesign()
@@ -1099,6 +1159,13 @@ class Instance:
         """
         return self.__get_snl_model().isPrimitive()
 
+    def is_sequential(self) -> bool:
+        """
+        :return: True if this is a sequential element.
+        :rtype: bool
+        """
+        return self.__get_snl_model().isSequential()
+
     def get_terms(self):
         """Iterate over all scalar terms and bus terms of this Instance.
 
@@ -1242,6 +1309,14 @@ class Instance:
         for attribute in leaf_object.getAttributes():
             yield Attribute(attribute)
 
+    def count_attributes(self) -> int:
+        """Count the attributes of this Instance.
+
+        :return: the number of attributes of this Instance.
+        :rtype: int
+        """
+        return sum(1 for _ in self.get_attributes())
+
     def delete_instance(self, name: str):
         """Delete the child instance with the given name."""
         if name == "":
@@ -1288,12 +1363,30 @@ class Instance:
         :return: the name of the instance or name of the top is this is the top.
         :rtype: str
         """
-        path = get_snl_path_from_id_list(self.pathIDs)
         if self.is_top():
             return self.get_model_name()
         else:
+            path = get_snl_path_from_id_list(self.pathIDs)
             return path.getTailInstance().getName()
 
+    def set_name(self, name: str):
+        """Set the name of this instance.
+
+        :param str name: the new name of the instance.
+        """
+        if self.is_top():
+            topSNLDesign = naja.NLUniverse.get().getTopDesign()
+            topSNLDesign.setName(name)
+        else:
+            path = get_snl_path_from_id_list(self.pathIDs)
+            # We need to uniquify until parent instance if parent instance
+            # is not top. path.size == 1 for instance under top
+            if path.size() > 1:
+                naja.SNLUniquifier(path.getHeadPath())
+                path = get_snl_path_from_id_list(self.pathIDs)
+            inst = path.getTailInstance()
+            inst.setName(name)
+
     def get_model_name(self) -> str:
         """
         :return: the name of the model of the instance
@@ -1478,6 +1571,87 @@ class Instance:
         """
         return self.__get_snl_model().getTruthTable()
 
+    def add_clock_related_inputs(self, clock_term: Term, input_terms: List[Term]):
+        """Add input terms that are related to the given clock term.
+
+        :param clock_term: the clock term to check for related inputs.
+        :param input_terms: a list of input terms to add.
+        :return: None
+        """
+        snlterms = [get_snl_term_for_ids(term.pathIDs, term.termIDs) for term in input_terms]
+        self.__get_snl_model().addInputsToClockArcs(snlterms,
+                                                    get_snl_term_for_ids(clock_term.pathIDs,
+                                                                         clock_term.termIDs))
+
+    def get_clock_related_inputs(self, clock_term: Term) -> List[Term]:
+        """Get all input terms that are related to the given clock term.
+
+        :param clock_term: the clock term to check for related inputs.
+        :return: a list of input terms that are related to the clock term.
+        :rtype: List[Term]
+        """
+        terms = self.__get_snl_model().getClockRelatedInputs(
+            get_snl_term_for_ids(clock_term.pathIDs, clock_term.termIDs))
+        # Convert SNL terms to Term objects
+        return [Term(clock_term.pathIDs, term) for term in terms]
+
+    def add_clock_related_outputs(self, clock_term: Term, output_terms: List[Term]):
+        """Add output terms that are related to the given clock term.
+
+        :param clock_term: the clock term to check for related outputs.
+        :param output_terms: a list of output terms to add.
+        :return: None
+        """
+        # convert Term objects to SNL terms
+        snlterms = [get_snl_term_for_ids(term.pathIDs, term.termIDs) for term in output_terms]
+        self.__get_snl_model().addClockToOutputsArcs(
+            get_snl_term_for_ids(clock_term.pathIDs, clock_term.termIDs), snlterms)
+
+    def get_clock_related_outputs(self, clock_term: Term) -> List[Term]:
+        """Get all output terms that are related to the given clock term.
+
+        :param clock_term: the clock term to check for related outputs.
+        :return: a list of output terms that are related to the clock term.
+        :rtype: List[Term]
+        """
+        terms = self.__get_snl_model().getClockRelatedOutputs(
+            get_snl_term_for_ids(clock_term.pathIDs, clock_term.termIDs))
+        # Convert SNL terms to Term objects
+        return [Term(clock_term.pathIDs, term) for term in terms]
+
+    def add_combinatorial_arcs(self, input_terms: List[Term], output_terms: List[Term]):
+        """Add input terms that are combinatorial inputs for the given output term.
+
+        :param output_term: the output term to check for combinatorial inputs.
+        :param input_terms: a list of input terms to add.
+        :return: None
+        """
+        self.__get_snl_model().addCombinatorialArcs(
+            [get_snl_term_for_ids(term.pathIDs, term.termIDs) for term in input_terms],
+            [get_snl_term_for_ids(term.pathIDs, term.termIDs) for term in output_terms])
+
+    def get_combinatorial_inputs(self, output_term: Term) -> List[Term]:
+        """Get all combinatorial input terms of this instance.
+
+        :return: a list of combinatorial input terms.
+        :rtype: List[Term]
+        """
+        terms = self.__get_snl_model().getCombinatorialInputs(
+            get_snl_term_for_ids(output_term.pathIDs, output_term.termIDs))
+        # Convert SNL terms to Term objects
+        return [Term(self.pathIDs, term) for term in terms]
+
+    def get_combinatorial_outputs(self, input_term: Term) -> List[Term]:
+        """Get all combinatorial output terms of this instance.
+
+        :return: a list of combinatorial output terms.
+        :rtype: List[Term]
+        """
+        terms = self.__get_snl_model().getCombinatorialOutputs(
+            get_snl_term_for_ids(input_term.pathIDs, input_term.termIDs))
+        # Convert SNL terms to Term objects
+        return [Term(self.pathIDs, term) for term in terms]
+
 
 def __get_top_db() -> naja.NLDB:
     if naja.NLUniverse.get() is None:

najaeda/stats.py

@@ -151,7 +151,7 @@ class InstanceStats:
 
 
 def is_basic_primitive(instance):
-    return instance.is_basic_primitive()
+    return instance.is_const() or instance.is_buf() or instance.is_inv()
 
 
 def compute_instance_stats(instance, instances_stats):

{najaeda-0.2.2.dist-info → najaeda-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: najaeda
-Version: 0.2.2
+Version: 0.2.4
 Summary: Naja EDA Python package
 Author-Email: Naja Authors <contact@keplertech.io>
 License: Apache License 2.0

{najaeda-0.2.2.dist-info → najaeda-0.2.4.dist-info}/RECORD

@@ -1,26 +1,27 @@
-najaeda-0.2.2.dist-info/RECORD,,
-najaeda-0.2.2.dist-info/WHEEL,sha256=v7i1yNVEHWKlHHcCQ8SYkgpldhmAvPDAYWfI_XMFumo,114
-najaeda-0.2.2.dist-info/METADATA,sha256=sDeDlCC-dBef_IHUdq2tfSqbCwhYqwdLu97HLgozptY,3435
-najaeda-0.2.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-najaeda-0.2.2.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
-najaeda/netlist.py,sha256=hU9g4tO40GGhS5b9uEfAqn7m6dXgcl9-yEBIKT1dmuU,56385
-najaeda/libnaja_nl.dylib,sha256=idyGQyIWdlumfe4onWoTpNYGekRsyxZOHOr44TmzgLA,755312
+najaeda-0.2.4.dist-info/RECORD,,
+najaeda-0.2.4.dist-info/WHEEL,sha256=v7i1yNVEHWKlHHcCQ8SYkgpldhmAvPDAYWfI_XMFumo,114
+najaeda-0.2.4.dist-info/METADATA,sha256=aGamxUDd_TKlccUOBxm-ooAbA3Ef-FwSlgP3lPTW09U,3435
+najaeda-0.2.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+najaeda-0.2.4.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
+najaeda/netlist.py,sha256=KdBQ77bMqYiUU_ecbDrR43L98FXk05_ahvj-8um-G5k,63866
+najaeda/libnaja_nl.dylib,sha256=v773WRb6Pl9gpAtRNB8Z6YO0L0L1N121JPXRm9CjucI,757456
 najaeda/pandas_stats.py,sha256=yOb4ka965U7rN4D6AwvSGmRyeT_O7Ed-5cmT8BFbfeo,1070
-najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/naja.so,sha256=rQ_i6Wha8ggIUKpXwNjGcusLinrtVjAmHtRJ4wJG3XU,99440
+najaeda/_version.py,sha256=c-4hT20dyE-3BcdzOqR0vd92E7ydR5u2c-VmCc6oU8A,332
+najaeda/__init__.py,sha256=6QrOzlqTfd558FH9Zm6ve54IzkHaDJ8ZO8hTCaEwsL8,218
+najaeda/naja.so,sha256=KlZfhVxDYoHspfxoGy4yHuU8h9-r3y51IDlK9TSrjeQ,99440
 najaeda/net_visitor.py,sha256=P_esjibYb-wBDuF-AyF7es9sJYw1Ha8RhTPu-qKe7G4,1940
 najaeda/libnaja_opt.dylib,sha256=wIG2H5rnxbqGrwLSgklJjZ5wjOkx2Shhu2RsnYQwmuE,212720
-najaeda/libnaja_python.dylib,sha256=iJLng1_gWI8nAMiXXcLOq9sHdDhZf7ScyxZk2-kQMaM,942416
-najaeda/stats.py,sha256=SJ9rca0Z6ldNAFOjU7DPO2hfx1zq-9Bec0Rx_oLasJo,16217
+najaeda/libnaja_python.dylib,sha256=soj2mTcuscVV3Frs3XmeiyekyUgWm5fmxGezO6ziJEQ,944848
+najaeda/stats.py,sha256=W41fqyMiAN9o9ajXy1t-CGoxDaSmY0TyTT5epc6yz-I,16249
 najaeda/instance_visitor.py,sha256=JMsPSQaWNiDjxS05rxg83a0PIsrOIuTi9G35hkwdibs,1530
 najaeda/libnaja_bne.dylib,sha256=pLbGUnDr5PSGXbA8wKD-pqEyQIWHbiCb1icPpxRYrWE,136416
-najaeda/libnaja_dnl.dylib,sha256=VD2Nl5M_XR1VEZO82Cy5I3MjXdXUXIr24b85p61awGY,145936
+najaeda/libnaja_dnl.dylib,sha256=qroDUAnl-eBJcdz-1YGC08Ngz4NEUctMiZ4W-gpT5mU,147088
 najaeda/native/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 najaeda/native/stats.py,sha256=t50hhE9pEFNtlssjES0A-K9TsO_2ZSUAb-e9L3Rt6yc,13063
 najaeda/docs/requirements.txt,sha256=1XIBGTIplm2arC9HhDCfLuAjozGdVSXkqmOj8ybuT6U,121
 najaeda/docs/.readthedocs.yaml,sha256=nN_Psro-YdfPcIiueZkJcZepts68g23rqVThhKnmVRw,790
 najaeda/docs/source/index.rst,sha256=80VMfeEGHObnOUXRBxIzISQsG_HNkgT-pUpsDZsCfOY,387
-najaeda/docs/source/instance.rst,sha256=7B2IBB0p32Tb4qvOCE77OlrQaYpFADvmTlq1q8eyVqw,458
+najaeda/docs/source/instance.rst,sha256=4JDl4_YaTbYxJrgSCe-3vV-EkKGGKOIejXMLfbJR1jk,957
 najaeda/docs/source/conf.py,sha256=XqCFo29gZCbaoPe1xEan9ZonYyQW5NZnWHGEWrB7p8Q,2021
 najaeda/docs/source/preprocessor.py,sha256=TK4LsTdNbv2dxkKQaJ7cEyo9PU5v_56vlrFCJYIPKf8,2625
 najaeda/docs/source/term.rst,sha256=QKWT6u1xjEjusvcZYknKQ-M83ibohO5y1EYTQnnXqak,690