View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      https://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  
23  package org.hipparchus.random;
24  
25  /**
26   * This class is a gaussian normalized random generator for scalars.
27   * <p>This class is a simple wrapper around the {@link
28   * RandomGenerator#nextGaussian} method.</p>
29   */
30  
31  public class GaussianRandomGenerator implements NormalizedRandomGenerator {
32  
33      /** Underlying generator. */
34      private final RandomGenerator generator;
35  
36      /** Create a new generator.
37       * @param generator underlying random generator to use
38       */
39      public GaussianRandomGenerator(final RandomGenerator generator) {
40          this.generator = generator;
41      }
42  
43      /** Generate a random scalar with null mean and unit standard deviation.
44       * @return a random scalar with null mean and unit standard deviation
45       */
46      @Override
47      public double nextNormalizedDouble() {
48          return generator.nextGaussian();
49      }
50  
51  }