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    *      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 interface represent a normalized random generator for
22   * scalars.
23   * Normalized generator provide null mean and unit standard deviation scalars.
24   * @version $Revision: 780933 $ $Date: 2009-06-02 00:39:12 -0400 (Tue, 02 Jun 2009) $
25   * @since 1.2
26   */
27  public interface NormalizedRandomGenerator {
28  
29    /** Generate a random scalar with null mean and unit standard deviation.
30     * <p>This method does <strong>not</strong> specify the shape of the
31     * distribution, it is the implementing class that provides it. The
32     * only contract here is to generate numbers with null mean and unit
33     * standard deviation.</p>
34     * @return a random scalar with null mean and unit standard deviation
35     */
36    public double nextNormalizedDouble();
37  
38  }