summaryrefslogtreecommitdiff
path: root/viterbi_generator/README
diff options
context:
space:
mode:
Diffstat (limited to 'viterbi_generator/README')
-rw-r--r--viterbi_generator/README16
1 files changed, 16 insertions, 0 deletions
diff --git a/viterbi_generator/README b/viterbi_generator/README
new file mode 100644
index 0000000..d9502fd
--- /dev/null
+++ b/viterbi_generator/README
@@ -0,0 +1,16 @@
+This is generator for Viterbi Algorithm part of Viterbi Equalizer.
+It is able to generate viterbi detector for channels with memory lengths
+of 2,3,4,5 symbols.
+
+To generate function in C++ for channel memory length of four symbols (Lh=4)
+just type:
+$ make
+
+
+To generate function for some other channel memory length type:
+$ make Lh=x
+where 'x' is channel memory length (value from 2 to 5)
+
+To check if algorithm works properly type:
+$ make test Lh=x
+
personal git repositories of Harald Welte. Your mileage may vary