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 018 package org.apache.commons.math.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 * @version $Revision: 780933 $ $Date: 2009-06-02 00:39:12 -0400 (Tue, 02 Jun 2009) $ 025 * @since 1.2 026 */ 027 028 public class GaussianRandomGenerator implements NormalizedRandomGenerator { 029 030 /** Create a new generator. 031 * @param generator underlying random generator to use 032 */ 033 public GaussianRandomGenerator(RandomGenerator generator) { 034 this.generator = generator; 035 } 036 037 /** Generate a random scalar with null mean and unit standard deviation. 038 * @return a random scalar with null mean and unit standard deviation 039 */ 040 public double nextNormalizedDouble() { 041 return generator.nextGaussian(); 042 } 043 044 /** Underlying generator. */ 045 private RandomGenerator generator; 046 047 }