NestedUniformScrambling.java

/*
 * Class:        NestedUniformScrambling
 * Description:  performs Owen's nested uniform scrambling
 * Environment:  Java
 * Software:     SSJ
 * Copyright (C) 2016  David Munger, Pierre L'Ecuyer and Universite de Montreal
 * Organization: DIRO, Universite de Montreal
 * @author
 * @since
 
 * SSJ is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License (GPL) as published by the
 * Free Software Foundation, either version 3 of the License, or
 * any later version.
 
 * SSJ is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 
 * A copy of the GNU General Public License is available at
   <a href="http://www.gnu.org/licenses">GPL licence site</a>.
 */
package umontreal.ssj.hups;
 
import umontreal.ssj.rng.RandomStream;
import java.lang.IllegalArgumentException;

public class NestedUniformScrambling implements PointSetRandomization {
 
   private RandomStream stream;
   private int numBits;

   public NestedUniformScrambling() {
      this(null);
   }

   public NestedUniformScrambling(RandomStream stream) {
      this(stream, 0);
   }

   public NestedUniformScrambling(RandomStream stream, int numBits) {
      this.stream = stream;
      this.numBits = numBits;
   }
 
   public RandomStream getStream() {
      return stream;
   }
 
   public void setStream(RandomStream stream) {
      this.stream = stream;
   }

   public void setNumBits(int numBits) {
      this.numBits = numBits;
   }

   public void randomize(PointSet p) {
      if (p instanceof CachedPointSet) {
         CachedPointSet cp = (CachedPointSet) p;
         if (cp.getParentPointSet() instanceof DigitalNetBase2) {
            ((DigitalNetBase2) cp.getParentPointSet()).nestedUniformScramble(stream, cp.getArray(), numBits);
            return;
         }
      }
      throw new IllegalArgumentException(
            "NestedUniformScrambling" + " can only randomize a CachedPointSet of a DigitalNetBase2");
   }

   public String toString() {
      return "Nested uniform scrambling";
   }
}