NakagamiGen.java

/*
 * Class:        NakagamiGen
 * Description:  random variate generators for the Nakagami 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 NakagamiGen extends RandomVariateGen {
   // Distribution parameters
   protected double a;
   protected double lambda;
   protected double c;

   public NakagamiGen(RandomStream s, double a, double lambda, double c) {
      super(s, new NakagamiDist(a, lambda, c));
      setParams(a, lambda, c);
   }

   public NakagamiGen(RandomStream s, NakagamiDist dist) {
      super(s, dist);
      if (dist != null)
         setParams(dist.getA(), dist.getLambda(), dist.getC());
   }

   public static double nextDouble(RandomStream s, double a, double lambda, double c) {
      return NakagamiDist.inverseF(a, lambda, c, s.nextDouble());
   }

   public double getA() {
      return a;
   }

   public double getLambda() {
      return lambda;
   }

   public double getC() {
      return c;
   }
 
   protected void setParams(double a, double lambda, double c) {
      if (lambda <= 0.0)
         throw new IllegalArgumentException("lambda <= 0");
      if (c <= 0.0)
         throw new IllegalArgumentException("c <= 0");
      this.a = a;
      this.lambda = lambda;
      this.c = c;
   }
}