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 * http://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 package org.apache.commons.math.random;
19
20 /**
21 * This class is a gaussian normalized random generator for scalars.
22 * <p>This class is a simple wrapper around the {@link
23 * RandomGenerator#nextGaussian} method.</p>
24 * @version $Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $
25 * @since 1.2
26 */
27
28 public class GaussianRandomGenerator implements NormalizedRandomGenerator {
29
30 /** Create a new generator.
31 * @param generator underlying random generator to use
32 */
33 public GaussianRandomGenerator(RandomGenerator generator) {
34 this.generator = generator;
35 }
36
37 /** Generate a random scalar with null mean and unit standard deviation.
38 * @return a random scalar with null mean and unit standard deviation
39 */
40 public double nextNormalizedDouble() {
41 return generator.nextGaussian();
42 }
43
44 /** Underlying generator. */
45 private RandomGenerator generator;
46
47 }