HyperbolicSecantGen.java

/*
 * Class:        HyperbolicSecantGen
 * Description:  random variate generators for the hyperbolic secant 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 HyperbolicSecantGen extends RandomVariateGen {
   protected double mu;
   protected double sigma;

   public HyperbolicSecantGen(RandomStream s, double mu, double sigma) {
      super(s, new HyperbolicSecantDist(mu, sigma));
      setParams(mu, sigma);
   }

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

   public HyperbolicSecantGen(RandomStream s, HyperbolicSecantDist dist) {
      super(s, dist);
      if (dist != null)
         setParams(dist.getMu(), dist.getSigma());
   }

   public static double nextDouble(RandomStream s, double mu, double sigma) {
      return HyperbolicSecantDist.inverseF(mu, sigma, s.nextDouble());
   }

   public double getMu() {
      return mu;
   }

   public double getSigma() {
      return sigma;
   }

   protected void setParams(double mu, double sigma) {
      if (sigma <= 0.0)
         throw new IllegalArgumentException("sigma <= 0");
      this.mu = mu;
      this.sigma = sigma;
   }
}