pre-commit

Author: flaport

docs/references.bib

@@ -1,3 +1,36 @@
+@article{ghioneAnalyticalFormulasCoplanar1984,
+  title = {Analytical Formulas for Coplanar Lines in Hybrid and Monolithic {{MICs}}},
+  author = {Ghione, G. and Naldi, C.},
+  year = {1984},
+  month = feb,
+  journal = {Electronics Letters},
+  volume = {20},
+  number = {4},
+  pages = {179--181},
+  publisher = {The Institution of Engineering and Technology},
+  doi = {10.1049/el:19840120},
+  abstract = {Some analytical formulas for the parameters of coplanar lines are discussed and validated; a chart is given for the design of coplanar waveguides on GaAs. The formulas discussed here, together with those presented previously by us (1983) represent a suitable set for the design of coplanar lines for hybrid and monolithic MICs (microwave integrated circuits).}
+}
+@book{guptaMicrostripLinesSlotlines1996,
+  title = {Microstrip Lines and Slotlines},
+  author = {Gupta, Kuldip C. and Garg, R. and Bahl, I. and Bhartia, P.},
+  year = {1996},
+  edition = {2. ed},
+  publisher = {Artech House},
+  address = {Boston},
+  isbn = {978-0-89006-766-6},
+  langid = {english}
+}
+@inproceedings{hammerstadAccurateModelsMicrostrip1980,
+  title = {Accurate {{Models}} for {{Microstrip Computer-Aided Design}}},
+  booktitle = {1980 {{IEEE MTT-S International Microwave}} Symposium {{Digest}}},
+  author = {Hammerstad, E. and Jensen, O.},
+  year = {1980},
+  pages = {407--409},
+  publisher = {IEEE},
+  address = {Washington, DC, USA},
+  doi = {10.1109/MWSYM.1980.1124303}
+}
 @misc{numpy-docs,
   title = {Numpy Documentation},
   author = {Travis Oliphant},
@@ -33,43 +66,15 @@ @misc{pythonformaths
   year = {2021},
   url = {https://github.erc.monash.edu.au/andrease/Python4Maths}
 }
-
-@article{ghioneAnalyticalFormulasCoplanar1984,
-  title = {Analytical Formulas for Coplanar Lines in Hybrid and Monolithic {{MICs}}},
-  author = {Ghione, G. and Naldi, C.},
-  year = {1984},
-  month = feb,
-  journal = {Electronics Letters},
-  volume = {20},
-  number = {4},
-  pages = {179--181},
-  publisher = {The Institution of Engineering and Technology},
-  doi = {10.1049/el:19840120},
-  abstract = {Some analytical formulas for the parameters of coplanar lines are discussed and validated; a chart is given for the design of coplanar waveguides on GaAs. The formulas discussed here, together with those presented previously by us (1983) represent a suitable set for the design of coplanar lines for hybrid and monolithic MICs (microwave integrated circuits).}
-}
-
-@book{guptaMicrostripLinesSlotlines1996,
-  title = {Microstrip Lines and Slotlines},
-  author = {Gupta, Kuldip C. and Garg, R. and Bahl, I. and Bhartia, P.},
-  year = {1996},
-  edition = {2. ed},
-  publisher = {Artech House},
-  address = {Boston},
-  isbn = {978-0-89006-766-6},
-  langid = {english}
-}
-
-@inproceedings{hammerstadAccurateModelsMicrostrip1980,
-  title = {Accurate {{Models}} for {{Microstrip Computer-Aided Design}}},
-  booktitle = {1980 {{IEEE MTT-S International Microwave}} Symposium {{Digest}}},
-  author = {Hammerstad, E. and Jensen, O.},
-  year = {1980},
-  pages = {407--409},
-  publisher = {IEEE},
-  address = {Washington, DC, USA},
-  doi = {10.1109/MWSYM.1980.1124303}
+@manual{qucs_technical_papers,
+  title = {Qucs Technical Papers},
+  author = {Stefan Jahn and Michael Margraf and Vincent Habchi and Raimund Jacob},
+  organization = {Qucs (Quite Universal Circuit Simulator) Project},
+  year = {2007},
+  month = dec,
+  url = {https://qucs.sourceforge.net/docs/technical/technical.pdf},
+  urldate = {2026-03-13}
 }
-
 @book{simonsCoplanarWaveguideCircuits2001,
   title = {Coplanar Waveguide Circuits, Components, and Systems},
   author = {Simons, Rainee},
@@ -82,13 +87,3 @@ @book{simonsCoplanarWaveguideCircuits2001
   isbn = {978-0-471-22475-4 978-0-471-46393-1},
   langid = {english}
 }
-
-@manual{qucs_technical_papers,
-  title        = {Qucs Technical Papers},
-  author       = {Stefan Jahn and Michael Margraf and Vincent Habchi and Raimund Jacob},
-  organization = {Qucs (Quite Universal Circuit Simulator) Project},
-  year         = {2007},
-  month        = dec,
-  url          = {https://qucs.sourceforge.net/docs/technical/technical.pdf},
-  urldate      = {2026-03-13}
-}

src/sax/saxtypes/singlemode.py

@@ -189,10 +189,11 @@ def val_instance_port(obj: Any) -> InstancePort:
 SCooSM: TypeAlias = tuple[IntArray1D, IntArray1D, ComplexArray, PortMapSM]
 """A sparse S-matrix in COO format (recommended for internal library use only).
 
-An `SCoo` is a sparse matrix based representation of an S-matrix consisting of three
-arrays and a port map. The three arrays represent the output port indices [`int`] (rows),
-input port indices [`int`] (columns) and the S-matrix values [`ComplexFloat`] of the sparse
-matrix. The port map maps a port name [`str`] to a port index [`int`].
+An `SCoo` is a sparse matrix based representation of an S-matrix consisting
+of three arrays and a port map. The three arrays represent the output port
+indices [`int`] (rows), input port indices [`int`] (columns) and the
+S-matrix values [`ComplexFloat`] of the sparse matrix. The port map maps a
+port name [`str`] to a port index [`int`].
 
 Only these four arrays **together** and in this specific **order** are considered a
 valid `SCoo` representation!

src/tests/test_smatrix_convention.py

@@ -1,22 +1,23 @@
-"""Test S-matrix convention: SDense S[i,j] = output at i for input at j (standard)."""
+"""Test S-matrix convention: SDense S[i,j] = output at i for input at j."""
 
+import jax.numpy as jnp
 import numpy as np
 
 import sax
 
 # Non-reciprocal reference: forward transmission only (in->out), no reverse
-SDICT_REF = {
-    ("in", "in"): 0.0 + 0.0j,
-    ("in", "out"): 1.0 + 0.0j,  # from in to out
-    ("out", "in"): 0.0 + 0.0j,  # NO reverse path
-    ("out", "out"): 0.0 + 0.0j,
+SDICT_REF: sax.SDict = {
+    ("in", "in"): jnp.array(0.0 + 0.0j),
+    ("in", "out"): jnp.array(1.0 + 0.0j),  # from in to out
+    ("out", "in"): jnp.array(0.0 + 0.0j),  # NO reverse path
+    ("out", "out"): jnp.array(0.0 + 0.0j),
 }
 
 
 # --- SDense convention ---
 
 
-def test_sdense_convention():
+def test_sdense_convention() -> None:
     """S[out_idx, in_idx] should hold the in->out transmission."""
     S, pm = sax.sdense(SDICT_REF)
     assert float(S[pm["out"], pm["in"]].real) == 1.0
@@ -26,27 +27,27 @@ def test_sdense_convention():
 # --- Round-trips: every (source, target) pair ---
 
 
-def test_sdict_to_scoo_to_sdict():
+def test_sdict_to_scoo_to_sdict() -> None:
     result = sax.sdict(sax.scoo(SDICT_REF))
     for k, v in SDICT_REF.items():
         np.testing.assert_allclose(float(result[k].real), float(complex(v).real))
 
 
-def test_sdict_to_sdense_to_sdict():
+def test_sdict_to_sdense_to_sdict() -> None:
     result = sax.sdict(sax.sdense(SDICT_REF))
     for k, v in SDICT_REF.items():
         np.testing.assert_allclose(float(result[k].real), float(complex(v).real))
 
 
-def test_scoo_to_sdict_to_scoo():
+def test_scoo_to_sdict_to_scoo() -> None:
     scoo1 = sax.scoo(SDICT_REF)
     scoo2 = sax.scoo(sax.sdict(scoo1))
     np.testing.assert_array_equal(scoo1[0], scoo2[0])  # Si
     np.testing.assert_array_equal(scoo1[1], scoo2[1])  # Sj
     np.testing.assert_array_almost_equal(scoo1[2], scoo2[2])  # Sx
 
 
-def test_scoo_to_sdense_to_scoo():
+def test_scoo_to_sdense_to_scoo() -> None:
     scoo1 = sax.scoo(SDICT_REF)
     sdense = sax.sdense(scoo1)
     scoo2 = sax.scoo(sdense)
@@ -56,13 +57,13 @@ def test_scoo_to_sdense_to_scoo():
     np.testing.assert_array_almost_equal(S1, S2)
 
 
-def test_sdense_to_sdict_to_sdense():
+def test_sdense_to_sdict_to_sdense() -> None:
     sdense1 = sax.sdense(SDICT_REF)
     sdense2 = sax.sdense(sax.sdict(sdense1))
     np.testing.assert_array_almost_equal(sdense1[0], sdense2[0])
 
 
-def test_sdense_to_scoo_to_sdense():
+def test_sdense_to_scoo_to_sdense() -> None:
     sdense1 = sax.sdense(SDICT_REF)
     sdense2 = sax.sdense(sax.scoo(sdense1))
     np.testing.assert_array_almost_equal(sdense1[0], sdense2[0])
@@ -71,7 +72,7 @@ def test_sdense_to_scoo_to_sdense():
 # --- Full chain: sdict -> scoo -> sdense -> sdict ---
 
 
-def test_full_chain_sdict_scoo_sdense_sdict():
+def test_full_chain_sdict_scoo_sdense_sdict() -> None:
     scoo = sax.scoo(SDICT_REF)
     sdense = sax.sdense(scoo)
     result = sax.sdict(sdense)
@@ -82,9 +83,9 @@ def test_full_chain_sdict_scoo_sdense_sdict():
 # --- SCoo convention ---
 
 
-def test_scoo_convention():
+def test_scoo_convention() -> None:
     """SCoo Si = row = output port index, Sj = col = input port index."""
-    Si, Sj, Sx, pm = sax.scoo({("in", "out"): 1.0})
+    Si, Sj, _Sx, pm = sax.scoo({("in", "out"): jnp.array(1.0)})
     # The single entry should have Si = out index (row), Sj = in index (col)
     assert int(Si[0]) == pm["out"]
     assert int(Sj[0]) == pm["in"]