Rename rate to code_rate

Author: mhostetter

src/sdr/_conversion.py

@@ -143,7 +143,7 @@ def linear(
 
 
 @export
-def ebn0_to_esn0(ebn0: npt.ArrayLike, bits_per_symbol: int, rate: int = 1) -> npt.NDArray[np.float64]:
+def ebn0_to_esn0(ebn0: npt.ArrayLike, bits_per_symbol: int, code_rate: int = 1) -> npt.NDArray[np.float64]:
     r"""
     Converts from $E_b/N_0$ to $E_s/N_0$.
 
@@ -154,7 +154,7 @@ def ebn0_to_esn0(ebn0: npt.ArrayLike, bits_per_symbol: int, rate: int = 1) -> np
     Arguments:
         ebn0: Bit energy $E_b$ to noise PSD $N_0$ ratio in dB.
         bits_per_symbol: The number of coded bits per symbol $\log_2 M$, where $M$ is the modulation order.
-        rate: Code rate $r = k/n$, where $k$ is the number of information bits and $n$ is the
+        code_rate: Code rate $r = k/n$, where $k$ is the number of information bits and $n$ is the
             number of coded bits.
 
     Returns:
@@ -165,26 +165,26 @@ def ebn0_to_esn0(ebn0: npt.ArrayLike, bits_per_symbol: int, rate: int = 1) -> np
 
         .. ipython:: python
 
-            sdr.ebn0_to_esn0(5, 2, rate=2/3)
+            sdr.ebn0_to_esn0(5, 2, code_rate=2/3)
 
         Convert from $E_b/N_0 = 10$ dB to $E_s/N_0$ for a 16-QAM signal with $r = 1$.
 
         .. ipython:: python
 
-            sdr.ebn0_to_esn0(10, 4, rate=1)
+            sdr.ebn0_to_esn0(10, 4, code_rate=1)
 
     Group:
         conversions-snrs
     """
     ebn0 = np.asarray(ebn0)  # Energy per information bit
-    ecn0 = ebn0 + db(rate)  # Energy per coded bit
+    ecn0 = ebn0 + db(code_rate)  # Energy per coded bit
     esn0 = ecn0 + db(bits_per_symbol)  # Energy per symbol
     return esn0
 
 
 @export
 def ebn0_to_snr(
-    ebn0: npt.ArrayLike, bits_per_symbol: int, rate: int = 1, samples_per_symbol: int = 1
+    ebn0: npt.ArrayLike, bits_per_symbol: int, code_rate: int = 1, samples_per_symbol: int = 1
 ) -> npt.NDArray[np.float64]:
     r"""
     Converts from $E_b/N_0$ to $S/N$.
@@ -196,7 +196,7 @@ def ebn0_to_snr(
     Arguments:
         ebn0: Bit energy $E_b$ to noise PSD $N_0$ ratio in dB.
         bits_per_symbol: The number of coded bits per symbol $\log_2 M$, where $M$ is the modulation order.
-        rate: Code rate $r = k/n$, where $k$ is the number of information bits and $n$ is the
+        code_rate: Code rate $r = k/n$, where $k$ is the number of information bits and $n$ is the
             number of coded bits.
         samples_per_symbol: The number of samples per symbol $f_s / f_{sym}$.
 
@@ -208,18 +208,18 @@ def ebn0_to_snr(
 
         .. ipython:: python
 
-            sdr.ebn0_to_snr(5, 2, rate=2/3, samples_per_symbol=1)
+            sdr.ebn0_to_snr(5, 2, code_rate=2/3, samples_per_symbol=1)
 
         Convert from $E_b/N_0 = 10$ dB to $S/N$ for a 16-QAM signal with $r = 1$ and 4 samples per symbol.
 
         .. ipython:: python
 
-            sdr.ebn0_to_snr(10, 4, rate=1, samples_per_symbol=4)
+            sdr.ebn0_to_snr(10, 4, code_rate=1, samples_per_symbol=4)
 
     Group:
         conversions-snrs
     """
-    esn0 = ebn0_to_esn0(ebn0, bits_per_symbol, rate=rate)  # SNR per symbol
+    esn0 = ebn0_to_esn0(ebn0, bits_per_symbol, code_rate=code_rate)  # SNR per symbol
     snr = esn0 - db(samples_per_symbol)  # SNR per sample
     return snr
 
@@ -230,7 +230,7 @@ def ebn0_to_snr(
 
 
 @export
-def esn0_to_ebn0(esn0: npt.ArrayLike, bits_per_symbol: int, rate: int = 1) -> npt.NDArray[np.float64]:
+def esn0_to_ebn0(esn0: npt.ArrayLike, bits_per_symbol: int, code_rate: int = 1) -> npt.NDArray[np.float64]:
     r"""
     Converts from $E_s/N_0$ to $E_b/N_0$.
 
@@ -241,7 +241,7 @@ def esn0_to_ebn0(esn0: npt.ArrayLike, bits_per_symbol: int, rate: int = 1) -> np
     Arguments:
         esn0: Symbol energy $E_s$ to noise PSD $N_0$ ratio in dB.
         bits_per_symbol: The number of coded bits per symbol $\log_2 M$, where $M$ is the modulation order.
-        rate: Code rate $r = k/n$, where $k$ is the number of information bits and $n$ is the
+        code_rate: Code rate $r = k/n$, where $k$ is the number of information bits and $n$ is the
             number of coded bits.
 
     Returns:
@@ -252,20 +252,20 @@ def esn0_to_ebn0(esn0: npt.ArrayLike, bits_per_symbol: int, rate: int = 1) -> np
 
         .. ipython:: python
 
-            sdr.esn0_to_ebn0(5, 2, rate=2/3)
+            sdr.esn0_to_ebn0(5, 2, code_rate=2/3)
 
         Convert from $E_s/N_0 = 10$ dB to $E_b/N_0$ for a 16-QAM signal with $r = 1$.
 
         .. ipython:: python
 
-            sdr.esn0_to_ebn0(10, 4, rate=1)
+            sdr.esn0_to_ebn0(10, 4, code_rate=1)
 
     Group:
         conversions-snrs
     """
     esn0 = np.asarray(esn0)
     ecn0 = esn0 - db(bits_per_symbol)  # Energy per coded bit
-    ebn0 = ecn0 - db(rate)  # Energy per information bit
+    ebn0 = ecn0 - db(code_rate)  # Energy per information bit
     return ebn0
 
 
@@ -314,7 +314,7 @@ def esn0_to_snr(esn0: npt.ArrayLike, samples_per_symbol: int = 1) -> npt.NDArray
 
 @export
 def snr_to_ebn0(
-    snr: npt.ArrayLike, bits_per_symbol: int, rate: int = 1, samples_per_symbol: int = 1
+    snr: npt.ArrayLike, bits_per_symbol: int, code_rate: int = 1, samples_per_symbol: int = 1
 ) -> npt.NDArray[np.float64]:
     r"""
     Converts from $S/N$ to $E_b/N_0$.
@@ -326,7 +326,7 @@ def snr_to_ebn0(
     Arguments:
         snr: Signal-to-noise ratio $S/N$ in dB.
         bits_per_symbol: The number of coded bits per symbol $\log_2 M$, where $M$ is the modulation order.
-        rate: Code rate $r = k/n$, where $k$ is the number of information bits and $n$ is the
+        code_rate: Code rate $r = k/n$, where $k$ is the number of information bits and $n$ is the
             number of coded bits.
         samples_per_symbol: The number of samples per symbol $f_s / f_{sym}$.
 
@@ -338,20 +338,20 @@ def snr_to_ebn0(
 
         .. ipython:: python
 
-            sdr.snr_to_ebn0(5, 2, rate=2/3, samples_per_symbol=1)
+            sdr.snr_to_ebn0(5, 2, code_rate=2/3, samples_per_symbol=1)
 
         Convert from $S/N = 10$ dB to $E_b/N_0$ for a 16-QAM signal with $r = 1$ and 4 samples per symbol.
 
         .. ipython:: python
 
-            sdr.snr_to_ebn0(10, 4, rate=1, samples_per_symbol=4)
+            sdr.snr_to_ebn0(10, 4, code_rate=1, samples_per_symbol=4)
 
     Group:
         conversions-snrs
     """
     snr = np.asarray(snr)  # SNR per sample
     esn0 = snr_to_esn0(snr, samples_per_symbol=samples_per_symbol)  # Energy per symbol
-    ebn0 = esn0_to_ebn0(esn0, bits_per_symbol, rate=rate)  # Energy per information bit
+    ebn0 = esn0_to_ebn0(esn0, bits_per_symbol, code_rate=code_rate)  # Energy per information bit
     return ebn0
 
 

tests/conversions/test_ebn0_to_esn0.py

@@ -9,7 +9,7 @@ def test_1():
         >> convertSNR(0:10, 'ebno', 'esno', 'BitsPerSymbol', 2, 'CodingRate', 1/3)'
     """
     ebn0 = np.arange(0, 11)
-    esn0 = sdr.ebn0_to_esn0(ebn0, 2, rate=1 / 3)
+    esn0 = sdr.ebn0_to_esn0(ebn0, 2, code_rate=1 / 3)
     esn0_truth = np.array(
         [
             -1.760912590556813,
@@ -34,7 +34,7 @@ def test_2():
         >> convertSNR(0:10, 'ebno', 'esno', 'BitsPerSymbol', 3, 'CodingRate', 1/2)'
     """
     ebn0 = np.arange(0, 11)
-    esn0 = sdr.ebn0_to_esn0(ebn0, 3, rate=1 / 2)
+    esn0 = sdr.ebn0_to_esn0(ebn0, 3, code_rate=1 / 2)
     esn0_truth = np.array(
         [
             1.760912590556812,
@@ -59,7 +59,7 @@ def test_3():
         >> convertSNR(0:10, 'ebno', 'esno', 'BitsPerSymbol', 4, 'CodingRate', 2/3)'
     """
     ebn0 = np.arange(0, 11)
-    esn0 = sdr.ebn0_to_esn0(ebn0, 4, rate=2 / 3)
+    esn0 = sdr.ebn0_to_esn0(ebn0, 4, code_rate=2 / 3)
     esn0_truth = np.array(
         [
             4.259687322722811,

tests/conversions/test_ebn0_to_snr.py

@@ -9,7 +9,7 @@ def test_1():
         >> convertSNR(0:10, 'ebno', 'snr', 'BitsPerSymbol', 2, 'CodingRate', 1/3, 'SamplesPerSymbol', 1)'
     """
     ebn0 = np.arange(0, 11)
-    snr = sdr.ebn0_to_snr(ebn0, 2, rate=1 / 3, samples_per_symbol=1)
+    snr = sdr.ebn0_to_snr(ebn0, 2, code_rate=1 / 3, samples_per_symbol=1)
     snr_truth = np.array(
         [
             -1.760912590556813,
@@ -34,7 +34,7 @@ def test_2():
         >> convertSNR(0:10, 'ebno', 'snr', 'BitsPerSymbol', 3, 'CodingRate', 1/2, 'SamplesPerSymbol', 2)'
     """
     ebn0 = np.arange(0, 11)
-    snr = sdr.ebn0_to_snr(ebn0, 3, rate=1 / 2, samples_per_symbol=2)
+    snr = sdr.ebn0_to_snr(ebn0, 3, code_rate=1 / 2, samples_per_symbol=2)
     snr_truth = np.array(
         [
             -1.249387366082999,
@@ -59,7 +59,7 @@ def test_3():
         >> convertSNR(0:10, 'ebno', 'snr', 'BitsPerSymbol', 4, 'CodingRate', 2/3, 'SamplesPerSymbol', 4)'
     """
     ebn0 = np.arange(0, 11)
-    snr = sdr.ebn0_to_snr(ebn0, 4, rate=2 / 3, samples_per_symbol=4)
+    snr = sdr.ebn0_to_snr(ebn0, 4, code_rate=2 / 3, samples_per_symbol=4)
     snr_truth = np.array(
         [
             -1.760912590556813,

tests/conversions/test_esn0_to_ebn0.py

@@ -9,7 +9,7 @@ def test_1():
         >> convertSNR(0:10, 'esno', 'ebno', 'BitsPerSymbol', 2, 'CodingRate', 1/3)'
     """
     esn0 = np.arange(0, 11)
-    ebn0 = sdr.esn0_to_ebn0(esn0, 2, rate=1 / 3)
+    ebn0 = sdr.esn0_to_ebn0(esn0, 2, code_rate=1 / 3)
     ebn0_truth = np.array(
         [
             1.760912590556813,
@@ -34,7 +34,7 @@ def test_2():
         >> convertSNR(0:10, 'esno', 'ebno', 'BitsPerSymbol', 3, 'CodingRate', 1/2)'
     """
     esn0 = np.arange(0, 11)
-    ebn0 = sdr.esn0_to_ebn0(esn0, 3, rate=1 / 2)
+    ebn0 = sdr.esn0_to_ebn0(esn0, 3, code_rate=1 / 2)
     ebn0_truth = np.array(
         [
             -1.760912590556812,
@@ -59,7 +59,7 @@ def test_3():
         >> convertSNR(0:10, 'esno', 'ebno', 'BitsPerSymbol', 4, 'CodingRate', 2/3)'
     """
     esn0 = np.arange(0, 11)
-    ebn0 = sdr.esn0_to_ebn0(esn0, 4, rate=2 / 3)
+    ebn0 = sdr.esn0_to_ebn0(esn0, 4, code_rate=2 / 3)
     ebn0_truth = np.array(
         [
             -4.259687322722811,

tests/conversions/test_snr_to_ebn0.py

@@ -9,7 +9,7 @@ def test_1():
         >> convertSNR(0:10, 'snr', 'ebno', 'BitsPerSymbol', 2, 'CodingRate', 1/3, 'SamplesPerSymbol', 1)'
     """
     snr = np.arange(0, 11)
-    ebn0 = sdr.snr_to_ebn0(snr, 2, rate=1 / 3, samples_per_symbol=1)
+    ebn0 = sdr.snr_to_ebn0(snr, 2, code_rate=1 / 3, samples_per_symbol=1)
     ebn0_truth = np.array(
         [
             1.760912590556812,
@@ -34,7 +34,7 @@ def test_2():
         >> convertSNR(0:10, 'snr', 'ebno', 'BitsPerSymbol', 3, 'CodingRate', 1/2, 'SamplesPerSymbol', 2)'
     """
     snr = np.arange(0, 11)
-    ebn0 = sdr.snr_to_ebn0(snr, 3, rate=1 / 2, samples_per_symbol=2)
+    ebn0 = sdr.snr_to_ebn0(snr, 3, code_rate=1 / 2, samples_per_symbol=2)
     ebn0_truth = np.array(
         [
             1.249387366082999,
@@ -59,7 +59,7 @@ def test_3():
         >> convertSNR(0:10, 'snr', 'ebno', 'BitsPerSymbol', 4, 'CodingRate', 2/3, 'SamplesPerSymbol', 4)'
     """
     snr = np.arange(0, 11)
-    ebn0 = sdr.snr_to_ebn0(snr, 4, rate=2 / 3, samples_per_symbol=4)
+    ebn0 = sdr.snr_to_ebn0(snr, 4, code_rate=2 / 3, samples_per_symbol=4)
     ebn0_truth = np.array(
         [
             1.760912590556812,