umontreal.iro.lecuyer.hups.LMScrambleShift Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ssj Show documentation

SSJ is a Java library for stochastic simulation, developed under the direction of Pierre L'Ecuyer, in the Département d'Informatique et de Recherche Opérationnelle (DIRO), at the Université de Montréal. It provides facilities for generating uniform and nonuniform random variates, computing different measures related to probability distributions, performing goodness-of-fit tests, applying quasi-Monte Carlo methods, collecting (elementary) statistics, and programming discrete-event simulations with both events and processes.

The newest version!



/*
 * Class:        LMScrambleShift
 * Description:  performs a left matrix scramble and adds a random digital shift
 * Environment:  Java
 * Software:     SSJ 
 * Copyright (C) 2001  Pierre L'Ecuyer and Université de Montréal
 * Organization: DIRO, Université de Montréal
 * @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
   GPL licence site.
 */

package umontreal.iro.lecuyer.hups;

 import umontreal.iro.lecuyer.rng.RandomStream;
 import java.lang.IllegalArgumentException;


/**
 * This class implements a
 * {@link umontreal.iro.lecuyer.hups.PointSetRandomization PointSetRandomization}
 * that performs a left matrix scrambling and adds a random digital
 * shift. Point set must be a
 * {@link umontreal.iro.lecuyer.hups.DigitalNet DigitalNet} or an
 * {@link java.lang.IllegalArgumentException IllegalArgumentException} is thrown.
 * 
 */
public class LMScrambleShift extends RandomShift  {



   /**
    * Empty constructor.
    * 
    */
   public LMScrambleShift()  {
   }
   


   /**
    * Sets internal variable stream to the given
    *    stream.
    * 
    * @param stream stream to use in the randomization
    * 
    */
   public LMScrambleShift (RandomStream stream)  {
       super(stream);
   }
   


   /**
    * This method calls
    *    {@link umontreal.iro.lecuyer.hups.DigitalNet#leftMatrixScramble(RandomStream) leftMatrixScramble},
    *    then
    *    {@link umontreal.iro.lecuyer.hups.DigitalNet#addRandomShift(RandomStream) addRandomShift}.
    *    If p is not a
    *    {@link umontreal.iro.lecuyer.hups.DigitalNet DigitalNet}, an
    * {@link java.lang.IllegalArgumentException IllegalArgumentException} is thrown.
    * 
    * @param p Point set to randomize
    * 
    * 
    */
   public void randomize (PointSet p)  {
      if (p instanceof DigitalNet) {
         ((DigitalNet)p).leftMatrixScramble (stream);
         ((DigitalNet)p).addRandomShift (stream);
      } else {
         throw new IllegalArgumentException("LMScrambleShift"+
                                            " can only randomize a DigitalNet");
      }
   }
   

}