Apply the same copy-editing to the existing generators as was discussed for Lcg128CmDxsm64.

Author: adamreichold

rand_pcg/src/pcg128.rs

@@ -77,6 +77,9 @@ impl Lcg128Xsl64 {
 
     /// Construct an instance compatible with PCG seed and stream.
     ///
+    /// Note that the highest bit of the `stream` parameter is discarded
+    /// to simplify upholding internal invariants.
+    ///
     /// Note that two generators with different stream parameters may be closely
     /// correlated.
     ///
@@ -116,11 +119,11 @@ impl fmt::Debug for Lcg128Xsl64 {
     }
 }
 
-/// We use a single 255-bit seed to initialise the state and select a stream.
-/// One `seed` bit (lowest bit of `seed[8]`) is ignored.
 impl SeedableRng for Lcg128Xsl64 {
     type Seed = [u8; 32];
 
+    /// We use a single 255-bit seed to initialise the state and select a stream.
+    /// One `seed` bit (lowest bit of `seed[8]`) is ignored.
     fn from_seed(seed: Self::Seed) -> Self {
         let mut seed_u64 = [0u64; 4];
         le::read_u64_into(&seed, &mut seed_u64);

rand_pcg/src/pcg64.rs

@@ -77,6 +77,9 @@ impl Lcg64Xsh32 {
 
     /// Construct an instance compatible with PCG seed and stream.
     ///
+    /// Note that the highest bit of the `stream` parameter is discarded
+    /// to simplify upholding internal invariants.
+    ///
     /// Note that two generators with different stream parameters may be closely
     /// correlated.
     ///
@@ -117,11 +120,11 @@ impl fmt::Debug for Lcg64Xsh32 {
     }
 }
 
-/// We use a single 127-bit seed to initialise the state and select a stream.
-/// One `seed` bit (lowest bit of `seed[8]`) is ignored.
 impl SeedableRng for Lcg64Xsh32 {
     type Seed = [u8; 16];
 
+    /// We use a single 127-bit seed to initialise the state and select a stream.
+    /// One `seed` bit (lowest bit of `seed[8]`) is ignored.
     fn from_seed(seed: Self::Seed) -> Self {
         let mut seed_u64 = [0u64; 2];
         le::read_u64_into(&seed, &mut seed_u64);

rand_pcg/tests/lcg128xsl64.rs

@@ -35,7 +35,7 @@ fn test_lcg128xsl64_construction() {
 }
 
 #[test]
-fn test_lcg128xsl64_true_values() {
+fn test_lcg128xsl64_reference() {
     // Numbers copied from official test suite (C version).
     let mut rng = Lcg128Xsl64::new(42, 54);
 

rand_pcg/tests/lcg64xsh32.rs

@@ -33,7 +33,7 @@ fn test_lcg64xsh32_construction() {
 }
 
 #[test]
-fn test_lcg64xsh32_true_values() {
+fn test_lcg64xsh32_reference() {
     // Numbers copied from official test suite.
     let mut rng = Lcg64Xsh32::new(42, 54);
 

rand_pcg/tests/mcg128xsl64.rs

@@ -33,7 +33,7 @@ fn test_mcg128xsl64_construction() {
 }
 
 #[test]
-fn test_mcg128xsl64_true_values() {
+fn test_mcg128xsl64_reference() {
     // Numbers copied from official test suite (C version).
     let mut rng = Mcg128Xsl64::new(42);