it.unibo.alchemist.util.RandomGenerators.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-implementationbase Show documentation

Abstract, incarnation independent implementations of the Alchemist's interfaces. Provides support for those who want to write incarnations.

There is a newer version: 35.0.1

Show newest version

/*
 * Copyright (C) 2010-2023, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */

package it.unibo.alchemist.util

import org.apache.commons.math3.random.RandomGenerator

/**
 * Utilities that extend the functionality of [RandomGenerator].
 */
object RandomGenerators {

    /**
     * Generate a random double between the given bounds.
     *
     * @param from
     *          the lower bound.
     * @param to
     *          the upper bound.
     */
    fun RandomGenerator.nextDouble(from: Double, to: Double) = nextDouble() * (to - from) + from

    /**
     * Generates a random value in 0..2π.
     *
     */
    fun RandomGenerator.randomAngle() = 2 * Math.PI * nextDouble()
}