001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.math3.random;
019
020/**
021 * This class is a gaussian normalized random generator for scalars.
022 * <p>This class is a simple wrapper around the {@link
023 * RandomGenerator#nextGaussian} method.</p>
024 * @since 1.2
025 */
026
027public class GaussianRandomGenerator implements NormalizedRandomGenerator {
028
029    /** Underlying generator. */
030    private final RandomGenerator generator;
031
032    /** Create a new generator.
033     * @param generator underlying random generator to use
034     */
035    public GaussianRandomGenerator(final RandomGenerator generator) {
036        this.generator = generator;
037    }
038
039    /** Generate a random scalar with null mean and unit standard deviation.
040     * @return a random scalar with null mean and unit standard deviation
041     */
042    public double nextNormalizedDouble() {
043        return generator.nextGaussian();
044    }
045
046}