najaeda 0.2.1__cp310-cp310-macosx_11_0_arm64.whl → 0.2.3__cp310-cp310-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

@@ -207,14 +207,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 +226,23 @@ 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:
+            self.net.setName(name)
+
     def get_msb(self) -> int:
         """
         :return: the most significant bit of the net if it is a bus.
@@ -485,8 +503,9 @@ class Term:
             term_str = f"{path}/{snl_term_str}"
         if self.is_bus():
             term_str += f"[{self.get_msb()}:{self.get_lsb()}]"
-        elif self.is_bus_bit():
-            term_str += f"[{self.get_msb()}]"
+        bit = self.get_bit_number()
+        if bit is not None:
+            term_str += f"[{bit}]"
         return term_str
 
     def __repr__(self) -> str:
@@ -576,6 +595,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.
@@ -671,6 +697,10 @@ class Term:
         return self.get_equipotential().get_leaf_readers()
 
     def get_equipotential(self) -> Equipotential:
+        """
+        :return: the Equipotential of this Term.
+        :rtype: Equipotential
+        """
         return Equipotential(self)
 
     def is_input(self) -> bool:
@@ -748,6 +778,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
@@ -808,8 +857,7 @@ 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()):
@@ -1283,12 +1331,28 @@ 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)
+            if path.size() > 0:
+                naja.SNLUniquifier(path)
+                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
@@ -1607,6 +1671,19 @@ def load_primitives_from_file(file: str):
     module.load(db)
 
 
+def load_naja_if(path: str):
+    """Load the Naja IF from the given path."""
+    if not os.path.isdir(path):
+        raise FileNotFoundError(f"Cannot load Naja IF from non existing directory: {path}")
+    logging.info(f"Loading Naja IF from {path}")
+    naja.NLDB.loadNajaIF(path)
+
+
+def dump_naja_if(path: str):
+    """Dump the Naja IF to the given path."""
+    __get_top_db().dumpNajaIF(path)
+
+
 def get_primitives_library() -> naja.NLLibrary:
     lib = __get_top_db().getLibrary("PRIMS")
     if lib is None:

{najaeda-0.2.1.dist-info → najaeda-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: najaeda
-Version: 0.2.1
+Version: 0.2.3
 Summary: Naja EDA Python package
 Author-Email: Naja Authors <contact@keplertech.io>
 License: Apache License 2.0
@@ -56,7 +56,7 @@ processes with minimal overhead.
 
 najaeda is the Python counterpart of the `Naja C++ project <https://github.com/najaeda/naja>`_.
 
-If you find this project useful, please consider [starring it on GitHub](https://github.com/najaeda/naja) to show your support.
+If you find this project useful, please consider `starring it on GitHub <https://github.com/najaeda/naja>`_ to show your support.
 
 Feel free to reach out to us anytime at `contact@keplertech.io <mailto:contact@keplertech.io>`_.
 

{najaeda-0.2.1.dist-info → najaeda-0.2.3.dist-info}/RECORD

@@ -1,21 +1,27 @@
-najaeda/netlist.py,sha256=by21s-ZgGPYunPDHDmnuAA8E_Z9ZRD5tbyck5NrwoxI,55865
-najaeda/libnaja_nl.dylib,sha256=idyGQyIWdlumfe4onWoTpNYGekRsyxZOHOr44TmzgLA,755312
+najaeda-0.2.3.dist-info/RECORD,,
+najaeda-0.2.3.dist-info/WHEEL,sha256=nFSIsNnUJn_8RF-FUhBaXtCep1yHZRCxSkBom4ebATM,114
+najaeda-0.2.3.dist-info/METADATA,sha256=Jx4ae_OoGfbOlrSqer4UwGLTOz5-CYwWQMeeKz3_mhM,3435
+najaeda-0.2.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+najaeda-0.2.3.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
+najaeda/netlist.py,sha256=B2NwDDriuqf3Jy-J0w4bDJ4dwXIovSzwrWOEHLXjw6s,58509
+najaeda/libnaja_nl.dylib,sha256=X7Dfc_l443uGo5-5Rje2XV_axrx_kxuiHWdAr0Hlx4s,757376
 najaeda/pandas_stats.py,sha256=yOb4ka965U7rN4D6AwvSGmRyeT_O7Ed-5cmT8BFbfeo,1070
-najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/naja.so,sha256=IYMbBEk2aXDx8IK8IH0Q1dwqK1rion3WA7kH5oqvbCE,99440
+najaeda/_version.py,sha256=c-4hT20dyE-3BcdzOqR0vd92E7ydR5u2c-VmCc6oU8A,332
+najaeda/__init__.py,sha256=6QrOzlqTfd558FH9Zm6ve54IzkHaDJ8ZO8hTCaEwsL8,218
+najaeda/naja.so,sha256=E_DYv2PlULYrlFIC5Q_glJgMTmjdC6l5Vn--AAYFbnM,99440
 najaeda/net_visitor.py,sha256=P_esjibYb-wBDuF-AyF7es9sJYw1Ha8RhTPu-qKe7G4,1940
 najaeda/libnaja_opt.dylib,sha256=wIG2H5rnxbqGrwLSgklJjZ5wjOkx2Shhu2RsnYQwmuE,212720
-najaeda/libnaja_python.dylib,sha256=PXEfnml2dhR7E2PvXntT-ymUEbQ6Yh8Cjzm_op4sShM,942400
+najaeda/libnaja_python.dylib,sha256=U5IOxjcxZ0jrZQopUE4ArtnnTaN3TaZkd-VdWrrd80I,944720
 najaeda/stats.py,sha256=SJ9rca0Z6ldNAFOjU7DPO2hfx1zq-9Bec0Rx_oLasJo,16217
 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
@@ -34,8 +40,3 @@ najaeda/.dylibs/libkj-1.1.0.dylib,sha256=pB7dMks8b8ybJ6xKWqFR_hHjKsmpf7wzbcunZaS
 najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 najaeda/primitives/yosys.py,sha256=g1L70AUJoPCkd9B-b9aW4Pzc1AeR9KyIHoXvneW_UEU,8584
 najaeda/primitives/xilinx.py,sha256=Ka-jlu-OxixEZ_yR_niXLHtaUL8HxT1Bg9H9Kpnr4ns,26551
-najaeda-0.2.1.dist-info/RECORD,,
-najaeda-0.2.1.dist-info/WHEEL,sha256=nFSIsNnUJn_8RF-FUhBaXtCep1yHZRCxSkBom4ebATM,114
-najaeda-0.2.1.dist-info/METADATA,sha256=-B4Xx2ur4gYMP8u14YKgiloVBdLr-9362F6wiYNFW0g,3433
-najaeda-0.2.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-najaeda-0.2.1.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377