Add a description for our PRNG

mfukar · Mar 12, 2014 · 6a5582a · 6a5582a
1 parent 965cba6
commit 6a5582a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/polynomial.py b/polynomial.py
@@ -3,7 +3,7 @@
 # @author Michael Foukarakis
 # @version 0.1
 # @date Created: Sun Jul 10, 2011 03:03 PDT
-# Last Update: Wed Aug 28, 2013 10:23 BST
+# Last Update: Mon Jan 27, 2014 12:13 EET
 #------------------------------------------------------------------------
 # Description: A class representing polynomials over GF(2).
 # The coefficients are stored in a list.

diff --git a/prng.c b/prng.c
@@ -1,3 +1,16 @@
+/**
+ * @file prng.c
+ * @author Michael Foukarakis
+ * @date Created: Wed Mar 12, 2014 14:03 GMT
+ * Last Update: Wed Mar 12, 2014 14:05 GMT
+ * @description PRNG using linear feedback shift registers.
+ * One shift register is used to provide data, while another register is used
+ * to "clock" data output; meaning a data bit is output when the clock
+ * register outputs a one bit, otherwise the data bit is dropped.
+ *------------------------------------------------------------------------
+ * -*- coding: utf-8 -*-
+ *------------------------------------------------------------------------
+ */
 #include <stdio.h>
 #include <stdlib.h>
 #include "lfsr.h"