Record Class CounterfactualSimulator.SimulationResult

java.lang.Object
java.lang.Record
org.episteme.social.history.CounterfactualSimulator.SimulationResult
All Implemented Interfaces:
Serializable
Enclosing class:
CounterfactualSimulator
public static record CounterfactualSimulator.SimulationResult(CounterfactualSimulator.CounterfactualScenario scenario, List<String> butterfliedEvents, List<String> unchangedEvents, Real historicalDivergence, String narrativeSummary) extends Record implements Serializable
The analytical results of a counterfactual simulation.
Since:
1.0
Version:
1.2
Author:
Silvere Martin-Michiellot, Gemini AI (Google DeepMind)
See Also:

  • Constructor Details

    • SimulationResult

      public SimulationResult(CounterfactualSimulator.CounterfactualScenario scenario, List<String> butterfliedEvents, List<String> unchangedEvents, Real historicalDivergence, String narrativeSummary)
      Creates an instance of a SimulationResult record class.
      Parameters:
      scenario - the value for the scenario record component
      butterfliedEvents - the value for the butterfliedEvents record component
      unchangedEvents - the value for the unchangedEvents record component
      historicalDivergence - the value for the historicalDivergence record component
      narrativeSummary - the value for the narrativeSummary record component

  • Method Details

    • historicalDivergenceValue

      public double historicalDivergenceValue()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • scenario

      public CounterfactualSimulator.CounterfactualScenario scenario()
      Returns the value of the scenario record component.
      Returns:
      the value of the scenario record component

    • butterfliedEvents

      public List<String> butterfliedEvents()
      Returns the value of the butterfliedEvents record component.
      Returns:
      the value of the butterfliedEvents record component

    • unchangedEvents

      public List<String> unchangedEvents()
      Returns the value of the unchangedEvents record component.
      Returns:
      the value of the unchangedEvents record component

    • historicalDivergence

      public Real historicalDivergence()
      Returns the value of the historicalDivergence record component.
      Returns:
      the value of the historicalDivergence record component

    • narrativeSummary

      public String narrativeSummary()
      Returns the value of the narrativeSummary record component.
      Returns:
      the value of the narrativeSummary record component