Fibonacci Linear Feedback Shift Register (Pseudo-Random Number Generator)
Dependents: SDP_K1_Rand FibonacciLFSR_LED_Demo
Diff: FibonacciLFSR.h
- Revision:
- 1:a1207d543967
- Parent:
- 0:2038ff2b7de5
--- a/FibonacciLFSR.h Sat Jun 25 03:19:45 2016 +0000 +++ b/FibonacciLFSR.h Sat Jun 25 17:03:12 2016 +0000 @@ -1,7 +1,7 @@ #ifndef FIBONACCI_LFSR #define FIBONACCI_LFSR -/* +/** Library for Fibonacci Linear Feedback Shift Register pseudo-random number generator. The uniqueness of the Fibonacci LFSR is that all permutations (values) are explored except zero, ensuring at least one bit in the LFSR @@ -10,11 +10,10 @@ Applications: Random Number Generation, LED Faux Candles, LED lighting effects, etc. - References: (Press "Ctrl" and click link to open in browser) + References: https://en.wikipedia.org/wiki/Linear-feedback_shift_register - - TODO: Consider making this class static */ +// TODO: Consider making this class static #include "mbed.h" @@ -24,14 +23,14 @@ LFSR_2 = 2, LFSR_4 = 4, LFSR_8 = 8, LFSR_16 = 16 }LFSR_SIZE_t; - /* + /** Constructor of Fibonacci Linear Feedback Shift Register Objects. Preconditions: None @param size Number of bits for LFSR */ FibonacciLFSR(LFSR_SIZE_t size); - /* + /** Generate and return new random number @return A new random value */