Package it.unibo.alchemist.model

Interface BenchmarkableEnvironment

  • All Implemented Interfaces:
    it.unibo.alchemist.model.Environment , java.io.Serializable , java.lang.Iterable 
    
public interface BenchmarkableEnvironment<T, P extends Position<out P>>
 implements Environment<T, P>

    An environment which provides a mean to get infos about its performances.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract void enableBenchmark() Call this method to tell this environment that it should record its performances.
      abstract double getBenchmarkResult()

      • Methods inherited from class it.unibo.alchemist.model.Environment

        addGlobalReaction, addLayer, addNode, addTerminator, getDimensions, getDistanceBetweenNodes, getGlobalReactions, getIncarnation, getLayer, getLayers, getLinkingRule, getNeighborhood, getNodeByID, getNodeCount, getNodes, getNodesWithinRange, getNodesWithinRange, getOffset, getPosition, getSimulation, getSize, getSizeInDistanceUnits, isTerminated, makePosition, moveNodeToPosition, removeGlobalReaction, removeNode, setLinkingRule, setSimulation

      • Methods inherited from class java.lang.Iterable

        forEach, iterator, spliterator

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • enableBenchmark

         abstract void enableBenchmark()

        Call this method to tell this environment that it should record its performances. Please note that some environments might ignore this message if this method is not called before starting using the environment itself.

      • getBenchmarkResult

         abstract double getBenchmarkResult()
        Returns:

        a double which is a index of the performances