GenerateRandom.java

/*
 * Encog(tm) Core v3.4 - Java Version
 * http://www.heatonresearch.com/encog/
 * https://github.com/encog/encog-java-core
 
 * Copyright 2008-2016 Heaton Research, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *   
 * For more information on Heaton Research copyrights, licenses 
 * and trademarks visit:
 * http://www.heatonresearch.com/copyright
 */
package org.encog.mathutil.randomize.generate;

/**
 * Interface that defines how random numbers are generated.  Provides the means to generate both uniform and normal
 * (gaussian) distributed random numbers.
 */
public interface GenerateRandom {

    /**
     * @return The next normally distributed random number.
     */
    double nextGaussian();

    /**
     * @return The next random boolean.
     */
    boolean nextBoolean();

    /**
     * @return The next random long.
     */
    long nextLong();

    /**
     * @return The next random floating point.
     */
    float nextFloat();

    /**
     * @return The next random double.
     */
    double nextDouble();

    /**
     * The next random double up to a non-inclusive range.
     *
     * @param high The highest desired value.
     * @return The result.
     */
    double nextDouble(double high);

    /**
     * The next double between low (inclusive) and high (exclusive).
     *
     * @param low  The inclusive low value.
     * @param high The exclusive high value.
     * @return The result.
     */
    double nextDouble(double low, double high);

    /**
     * @return The next random integer.
     */
    int nextInt();

    /**
     * The next random int up to a non-inclusive range.
     *
     * @param high The highest desired value.
     * @return The result.
     */
    int nextInt(int high);

    /**
     * The next int between low (inclusive) and high (exclusive).
     *
     * @param low  The inclusive low value.
     * @param high The exclusive high value.
     * @return The result.
     */
    int nextInt(int low, int high);
}