documentation and rebuilt site

benyamindsmith · Oct 23, 2024 · d5fecc2 · d5fecc2
1 parent 4120e5a
commit d5fecc2
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 15 deletions.
diff --git a/R/RcppExports.R b/R/RcppExports.R
@@ -180,7 +180,7 @@ lfsr_fib <- function(seed, n, bitsize, taps) {
     .Call(`_randngen_lfsr_fib`, seed, n, bitsize, taps)
 }
 
-#' Galois Linear Feedback Shift Register
+#' Galois Linear Feedback Shift Register (LFSR)
 #'
 #' Named after the French mathematician Évariste Galois, an LFSR in Galois configuration, which is also known as modular, internal XORs, or one-to-many LFSR, is an alternate structure that can generate the same output stream as a conventional LFSR (but offset in time).[5] In the Galois configuration, when the system is clocked, bits that are not taps are shifted one position to the right unchanged. The taps, on the other hand, are XORed with the output bit before they are stored in the next position. The new output bit is the next input bit. The effect of this is that when the output bit is zero, all the bits in the register shift to the right unchanged, and the input bit becomes zero. When the output bit is one, the bits in the tap positions all flip (if they are 0, they become 1, and if they are 1, they become 0), and then the entire register is shifted to the right and the input bit becomes 1.
 #'
@@ -202,7 +202,7 @@ lfsr_galois <- function(seed, n, bitsize, taps) {
     .Call(`_randngen_lfsr_galois`, seed, n, bitsize, taps)
 }
 
-#' Xorshift Linear Feedback Shift Register
+#' Xorshift Linear Feedback Shift Register (LFSR)
 #'
 #' For more information, check out the \href{https://en.wikipedia.org/wiki/Linear-feedback_shift_register}{Wikipedia Page}.
 lfsr_xorshift <- function(seed, n, bitsize, taps) {

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.11
 pkgdown: 2.0.7
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-10-22T20:54Z
+last_built: 2024-10-23T04:30Z
 
diff --git a/docs/reference/blumb_blumb_shub.html b/docs/reference/blumb_blumb_shub.html
diff --git a/docs/reference/lfsr_galois-1.png b/docs/reference/lfsr_galois-1.png
diff --git a/docs/reference/lfsr_galois.html b/docs/reference/lfsr_galois.html
diff --git a/man/lfsr_galois.Rd b/man/lfsr_galois.Rd
diff --git a/man/lfsr_xorshift.Rd b/man/lfsr_xorshift.Rd
diff --git a/src/lfsr.cpp b/src/lfsr.cpp
@@ -50,7 +50,7 @@ using namespace Rcpp;
 
 
 
-//' Galois Linear Feedback Shift Register
+//' Galois Linear Feedback Shift Register (LFSR)
 //'
 //' Named after the French mathematician Évariste Galois, an LFSR in Galois configuration, which is also known as modular, internal XORs, or one-to-many LFSR, is an alternate structure that can generate the same output stream as a conventional LFSR (but offset in time).[5] In the Galois configuration, when the system is clocked, bits that are not taps are shifted one position to the right unchanged. The taps, on the other hand, are XORed with the output bit before they are stored in the next position. The new output bit is the next input bit. The effect of this is that when the output bit is zero, all the bits in the register shift to the right unchanged, and the input bit becomes zero. When the output bit is one, the bits in the tap positions all flip (if they are 0, they become 1, and if they are 1, they become 0), and then the entire register is shifted to the right and the input bit becomes 1.
 //'
@@ -104,7 +104,7 @@ using namespace Rcpp;
  }
 
 
-//' Xorshift Linear Feedback Shift Register
+//' Xorshift Linear Feedback Shift Register (LFSR)
 //'
 //' For more information, check out the \href{https://en.wikipedia.org/wiki/Linear-feedback_shift_register}{Wikipedia Page}.
 // [[Rcpp::export]]