Package microsim.alignment.probability

Interface AlignmentProbabilityClosure<T>

Type Parameters:
T - A generic type representing agents.
public interface AlignmentProbabilityClosure<T>
An auxiliary interface to get and align probabilities of an agent.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    align(T agent, double alignedProbability)
    Method specifying the sampling of the aligned probability to determine the outcome for the agent.
    double
    getProbability(T agent)
    Returns the unaligned probability of a 'positive' outcome for the agent (the user should define what the positive outcome is; it could be that something happens or does not happen).

  • Method Details

    • getProbability

      double getProbability(@NonNull T agent)
      Returns the unaligned probability of a 'positive' outcome for the agent (the user should define what the positive outcome is; it could be that something happens or does not happen).
      Parameters:
      agent - an agent-representing object.
      Returns:
      the probability of a 'positive' outcome for the agent.
      Throws:
      NullPointerException - when agent is null.

    • align

      void align(@NonNull T agent, double alignedProbability)
      Method specifying the sampling of the aligned probability to determine the outcome for the agent.
      Parameters:
      agent - an agent-representing object.
      alignedProbability - the corrected probability of a 'positive' outcome
      Throws:
      NullPointerException - when agent is null.