Move TerminatedConvolutionalCode from block to convolutional module

rwnobrega · Nov 29, 2024 · 09e853a · 09e853a
1 parent bd34f6c
commit 09e853a
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 7 deletions.
diff --git a/site/toc.yaml b/site/toc.yaml
@@ -27,9 +27,9 @@ Error control:
     - BlockDecoder
   Convolutional coding:
     - ConvolutionalCode
+    - TerminatedConvolutionalCode
     - ConvolutionalStreamEncoder
     - ConvolutionalStreamDecoder
-    - TerminatedConvolutionalCode
   Checksum:
     - CyclicRedundancyCheck
 Finite-state machines:

diff --git a/src/komm/_error_control_block/__init__.py b/src/komm/_error_control_block/__init__.py
@@ -13,7 +13,6 @@
 from .SingleParityCheckCode import SingleParityCheckCode
 from .SlepianArray import SlepianArray
 from .SystematicBlockCode import SystematicBlockCode
-from .TerminatedConvolutionalCode import TerminatedConvolutionalCode
 
 __all__ = [
     "BCHCode",
@@ -31,7 +30,6 @@
     "SingleParityCheckCode",
     "SlepianArray",
     "SystematicBlockCode",
-    "TerminatedConvolutionalCode",
 ]
 
 from .decoders import *
diff --git a/src/komm/_error_control_block/decoders/bcjr.py b/src/komm/_error_control_block/decoders/bcjr.py
@@ -1,8 +1,10 @@
 import numpy as np
 import numpy.typing as npt
 
+from ..._error_control_convolutional.TerminatedConvolutionalCode import (
+    TerminatedConvolutionalCode,
+)
 from ..registry import RegistryBlockDecoder
-from ..TerminatedConvolutionalCode import TerminatedConvolutionalCode
 
 
 def decode_bcjr(

diff --git a/src/komm/_error_control_block/decoders/viterbi.py b/src/komm/_error_control_block/decoders/viterbi.py
@@ -3,10 +3,12 @@
 import numpy as np
 import numpy.typing as npt
 
+from ..._error_control_convolutional.TerminatedConvolutionalCode import (
+    TerminatedConvolutionalCode,
+)
 from ..._finite_state_machine.FiniteStateMachine import MetricFunction
 from ..._util import unpack
 from ..registry import RegistryBlockDecoder
-from ..TerminatedConvolutionalCode import TerminatedConvolutionalCode
 
 
 def decode_viterbi(

diff --git a/...trol_block/TerminatedConvolutionalCode.py → ...volutional/TerminatedConvolutionalCode.py b/...trol_block/TerminatedConvolutionalCode.py → ...volutional/TerminatedConvolutionalCode.py
@@ -6,11 +6,11 @@
 from attrs import frozen
 from numpy.linalg import matrix_power
 
-from .._error_control_convolutional.ConvolutionalCode import ConvolutionalCode
+from .._error_control_block.BlockCode import BlockCode
 from .._types import ArrayIntLike
 from .._util.bit_operations import binlist2int, int2binlist, pack, unpack
 from .._util.matrices import pseudo_inverse
-from .BlockCode import BlockCode
+from .ConvolutionalCode import ConvolutionalCode
 
 
 @frozen

diff --git a/src/komm/_error_control_convolutional/__init__.py b/src/komm/_error_control_convolutional/__init__.py
@@ -1,9 +1,11 @@
 from .ConvolutionalCode import ConvolutionalCode
 from .ConvolutionalStreamDecoder import ConvolutionalStreamDecoder
 from .ConvolutionalStreamEncoder import ConvolutionalStreamEncoder
+from .TerminatedConvolutionalCode import TerminatedConvolutionalCode
 
 __all__ = [
     "ConvolutionalCode",
+    "TerminatedConvolutionalCode",
     "ConvolutionalStreamDecoder",
     "ConvolutionalStreamEncoder",
 ]