CauchyGen.java

/*
 * Class:        CauchyGen
 * Description:  random variate generators for the Cauchy distribution
 * Environment:  Java
 * Software:     SSJ 
 * Copyright (C) 2001  Pierre L'Ecuyer and Universite de Montreal
 * Organization: DIRO, Universite de Montreal
 * @author       
 * @since
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package umontreal.ssj.randvar;
 
import umontreal.ssj.rng.*;
import umontreal.ssj.probdist.*;

public class CauchyGen extends RandomVariateGen {
   protected double alpha;
   protected double beta;

   public CauchyGen(RandomStream s, double alpha, double beta) {
      super(s, new CauchyDist(alpha, beta));
      setParams(alpha, beta);
   }

   public CauchyGen(RandomStream s) {
      this(s, 0.0, 1.0);
   }

   public CauchyGen(RandomStream s, CauchyDist dist) {
      super(s, dist);
      if (dist != null)
         setParams(dist.getAlpha(), dist.getBeta());
   }

   public static double nextDouble(RandomStream s, double alpha, double beta) {
      return CauchyDist.inverseF(alpha, beta, s.nextDouble());
   }

   public double getAlpha() {
      return alpha;
   }

   public double getBeta() {
      return beta;
   }
 
   protected void setParams(double alpha, double beta) {
      if (beta <= 0.0)
         throw new IllegalArgumentException("beta <= 0");
      this.alpha = alpha;
      this.beta = beta;
   }
}