Package io.github.ai4ci.abm.inhost

Class ImmutableInHostMarkovStateMachine

java.lang.Object
io.github.ai4ci.abm.inhost.ImmutableInHostMarkovStateMachine
All Implemented Interfaces:
InHostMarkovState.InHostMarkovStateMachine, Serializable
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableInHostMarkovStateMachine extends Object implements InHostMarkovState.InHostMarkovStateMachine
Immutable implementation of InHostMarkovState.InHostMarkovStateMachine.

Use the builder to create immutable instances: ImmutableInHostMarkovStateMachine.builder().

See Also:

  • Method Details

    • getPExposedInfectious

      public double getPExposedInfectious()
      Specified by:
      getPExposedInfectious in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:
      The value of the pExposedInfectious attribute

    • getPInfectiousImmune

      public double getPInfectiousImmune()
      Specified by:
      getPInfectiousImmune in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:
      The value of the pInfectiousImmune attribute

    • getPImmuneSusceptible

      public double getPImmuneSusceptible()
      Specified by:
      getPImmuneSusceptible in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:
      The value of the pImmuneSusceptible attribute

    • getPAsymptomaticSymptomatic

      public double getPAsymptomaticSymptomatic()
      this is the per day probability of becoming symptomatic given that you are infected. it is 1-(1-infection_case_rate)^duration_of_infection
      Specified by:
      getPAsymptomaticSymptomatic in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:

    • getPSymptomaticAsymptomatic

      public double getPSymptomaticAsymptomatic()
      Specified by:
      getPSymptomaticAsymptomatic in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:
      The value of the pSymptomaticAsymptomatic attribute

    • getPSymptomaticHospitalised

      public double getPSymptomaticHospitalised()
      Specified by:
      getPSymptomaticHospitalised in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:
      The value of the pSymptomaticHospitalised attribute

    • getPSymptomaticDead

      public double getPSymptomaticDead()
      Specified by:
      getPSymptomaticDead in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:
      The value of the pSymptomaticDead attribute

    • getPHospitalisedDead

      public double getPHospitalisedDead()
      Specified by:
      getPHospitalisedDead in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:
      The value of the pHospitalisedDead attribute

    • getPHospitalisedAsymptomatic

      public double getPHospitalisedAsymptomatic()
      Specified by:
      getPHospitalisedAsymptomatic in interface InHostMarkovState.InHostMarkovStateMachine
      Returns:
      The value of the pHospitalisedAsymptomatic attribute

    • withPExposedInfectious

      public final ImmutableInHostMarkovStateMachine withPExposedInfectious(double value)
      Copy the current immutable object by setting a value for the pExposedInfectious attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pExposedInfectious
      Returns:
      A modified copy of the this object

    • withPInfectiousImmune

      public final ImmutableInHostMarkovStateMachine withPInfectiousImmune(double value)
      Copy the current immutable object by setting a value for the pInfectiousImmune attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pInfectiousImmune
      Returns:
      A modified copy of the this object

    • withPImmuneSusceptible

      public final ImmutableInHostMarkovStateMachine withPImmuneSusceptible(double value)
      Copy the current immutable object by setting a value for the pImmuneSusceptible attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pImmuneSusceptible
      Returns:
      A modified copy of the this object

    • withPAsymptomaticSymptomatic

      public final ImmutableInHostMarkovStateMachine withPAsymptomaticSymptomatic(double value)
      Copy the current immutable object by setting a value for the pAsymptomaticSymptomatic attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pAsymptomaticSymptomatic
      Returns:
      A modified copy of the this object

    • withPSymptomaticAsymptomatic

      public final ImmutableInHostMarkovStateMachine withPSymptomaticAsymptomatic(double value)
      Copy the current immutable object by setting a value for the pSymptomaticAsymptomatic attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pSymptomaticAsymptomatic
      Returns:
      A modified copy of the this object

    • withPSymptomaticHospitalised

      public final ImmutableInHostMarkovStateMachine withPSymptomaticHospitalised(double value)
      Copy the current immutable object by setting a value for the pSymptomaticHospitalised attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pSymptomaticHospitalised
      Returns:
      A modified copy of the this object

    • withPSymptomaticDead

      public final ImmutableInHostMarkovStateMachine withPSymptomaticDead(double value)
      Copy the current immutable object by setting a value for the pSymptomaticDead attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pSymptomaticDead
      Returns:
      A modified copy of the this object

    • withPHospitalisedDead

      public final ImmutableInHostMarkovStateMachine withPHospitalisedDead(double value)
      Copy the current immutable object by setting a value for the pHospitalisedDead attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pHospitalisedDead
      Returns:
      A modified copy of the this object

    • withPHospitalisedAsymptomatic

      public final ImmutableInHostMarkovStateMachine withPHospitalisedAsymptomatic(double value)
      Copy the current immutable object by setting a value for the pHospitalisedAsymptomatic attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pHospitalisedAsymptomatic
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableInHostMarkovStateMachine that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: pExposedInfectious, pInfectiousImmune, pImmuneSusceptible, pAsymptomaticSymptomatic, pSymptomaticAsymptomatic, pSymptomaticHospitalised, pSymptomaticDead, pHospitalisedDead, pHospitalisedAsymptomatic.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value InHostMarkovStateMachine with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableInHostMarkovStateMachine copyOf(InHostMarkovState.InHostMarkovStateMachine instance)
      Creates an immutable copy of a InHostMarkovState.InHostMarkovStateMachine value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable InHostMarkovStateMachine instance

    • toBuilder

      public ImmutableInHostMarkovStateMachine.Builder toBuilder()
      Creates a builder for ImmutableInHostMarkovStateMachine.prefilled with attibute values of this instance to easily create modified copies.
      Returns:
      A new ImmutableInHostMarkovStateMachine builder with attributes of this instance

    • builder

      public static ImmutableInHostMarkovStateMachine.Builder builder()
      Creates a builder for ImmutableInHostMarkovStateMachine. 
       ImmutableInHostMarkovStateMachine.builder()
    .setPExposedInfectious(double) // required pExposedInfectious
    .setPInfectiousImmune(double) // required pInfectiousImmune
    .setPImmuneSusceptible(double) // required pImmuneSusceptible
    .setPAsymptomaticSymptomatic(double) // required pAsymptomaticSymptomatic
    .setPSymptomaticAsymptomatic(double) // required pSymptomaticAsymptomatic
    .setPSymptomaticHospitalised(double) // required pSymptomaticHospitalised
    .setPSymptomaticDead(double) // required pSymptomaticDead
    .setPHospitalisedDead(double) // required pHospitalisedDead
    .setPHospitalisedAsymptomatic(double) // required pHospitalisedAsymptomatic
    .build();
      Returns:
      A new ImmutableInHostMarkovStateMachine builder