it.unibo.alchemist.boundary.Variable Maven / Gradle / Ivy

Go to download

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

Alchemist Machinery to load from files

The 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.boundary;

import java.io.Serializable;
import java.util.Iterator;
import java.util.stream.Stream;

/**
 * A variable simulation value, that provides a range of values for batches, and
 * a default value for single-shot runs.
 *
 * @param  value typ of the variable
 */
public interface Variable extends Serializable, Iterable {

    @Override
    default Iterator iterator() {
        return stream().iterator();
    }

    /**
     * @return the number of different values this {@link Variable} may yield
     */
    default long steps() {
        return stream().count();
    }

    /**
     * @return the default value for this {@link Variable}
     */
    V getDefault();

    /**
     * @return a view of the values of this variable as {@link Stream}.
     */
    Stream stream();

}