Package io.github.ai4ci.config.inhost

Class PartialStochasticModel

java.lang.Object
io.github.ai4ci.config.inhost.PartialStochasticModel
All Implemented Interfaces:
Abstraction.Modification<StochasticModel>, InHostConfiguration, StochasticModel, StochasticModel._PartialStochasticModel, Serializable
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class PartialStochasticModel extends Object implements StochasticModel._PartialStochasticModel
Immutable implementation of StochasticModel._PartialStochasticModel.

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

See Also:

  • Method Details

    • getTargetCellCount

      public Integer getTargetCellCount()
      Specified by:
      getTargetCellCount in interface StochasticModel
      Returns:
      The value of the targetCellCount attribute

    • getImmuneTargetRatio

      public Abstraction.Distribution getImmuneTargetRatio()
      Specified by:
      getImmuneTargetRatio in interface StochasticModel
      Returns:
      The value of the immuneTargetRatio attribute

    • getImmuneActivationRate

      public Abstraction.Distribution getImmuneActivationRate()
      Specified by:
      getImmuneActivationRate in interface StochasticModel
      Returns:
      The value of the immuneActivationRate attribute

    • getImmuneWaningRate

      public Abstraction.Distribution getImmuneWaningRate()
      Specified by:
      getImmuneWaningRate in interface StochasticModel
      Returns:
      The value of the immuneWaningRate attribute

    • getInfectionCarrierProbability

      public Abstraction.Distribution getInfectionCarrierProbability()
      Specified by:
      getInfectionCarrierProbability in interface StochasticModel
      Returns:
      The value of the infectionCarrierProbability attribute

    • getTargetRecoveryRate

      public Abstraction.Distribution getTargetRecoveryRate()
      Specified by:
      getTargetRecoveryRate in interface StochasticModel
      Returns:
      The value of the targetRecoveryRate attribute

    • getBaselineViralInfectionRate

      public Double getBaselineViralInfectionRate()
      Specified by:
      getBaselineViralInfectionRate in interface StochasticModel
      Returns:
      The value of the baselineViralInfectionRate attribute

    • getBaselineViralReplicationRate

      public Double getBaselineViralReplicationRate()
      Specified by:
      getBaselineViralReplicationRate in interface StochasticModel
      Returns:
      The value of the baselineViralReplicationRate attribute

    • getVirionsDiseaseCutoff

      public Integer getVirionsDiseaseCutoff()
      Given the parameters for the virus, what is the unit of virions. This is a calibration parameter, and defines the limit of what is considered disease. It should be the lowest value that is transmissible and defines a patient as "infected" it does not follow that an uninfected patient does not have a small in-host viral load.
      Specified by:
      getVirionsDiseaseCutoff in interface StochasticModel
      Returns:
      the cutoff

    • withTargetCellCount

      public final PartialStochasticModel withTargetCellCount(Integer value)
      Copy the current immutable object by setting a value for the targetCellCount attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for targetCellCount (can be null)
      Returns:
      A modified copy of the this object

    • withImmuneTargetRatio

      public final PartialStochasticModel withImmuneTargetRatio(Abstraction.Distribution value)
      Copy the current immutable object by setting a value for the immuneTargetRatio attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for immuneTargetRatio (can be null)
      Returns:
      A modified copy of the this object

    • withImmuneActivationRate

      public final PartialStochasticModel withImmuneActivationRate(Abstraction.Distribution value)
      Copy the current immutable object by setting a value for the immuneActivationRate attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for immuneActivationRate (can be null)
      Returns:
      A modified copy of the this object

    • withImmuneWaningRate

      public final PartialStochasticModel withImmuneWaningRate(Abstraction.Distribution value)
      Copy the current immutable object by setting a value for the immuneWaningRate attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for immuneWaningRate (can be null)
      Returns:
      A modified copy of the this object

    • withInfectionCarrierProbability

      public final PartialStochasticModel withInfectionCarrierProbability(Abstraction.Distribution value)
      Copy the current immutable object by setting a value for the infectionCarrierProbability attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for infectionCarrierProbability (can be null)
      Returns:
      A modified copy of the this object

    • withTargetRecoveryRate

      public final PartialStochasticModel withTargetRecoveryRate(Abstraction.Distribution value)
      Copy the current immutable object by setting a value for the targetRecoveryRate attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for targetRecoveryRate (can be null)
      Returns:
      A modified copy of the this object

    • withBaselineViralInfectionRate

      public final PartialStochasticModel withBaselineViralInfectionRate(Double value)
      Copy the current immutable object by setting a value for the baselineViralInfectionRate attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for baselineViralInfectionRate (can be null)
      Returns:
      A modified copy of the this object

    • withBaselineViralReplicationRate

      public final PartialStochasticModel withBaselineViralReplicationRate(Double value)
      Copy the current immutable object by setting a value for the baselineViralReplicationRate attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for baselineViralReplicationRate (can be null)
      Returns:
      A modified copy of the this object

    • withVirionsDiseaseCutoff

      public final PartialStochasticModel withVirionsDiseaseCutoff(Integer value)
      Copy the current immutable object by setting a value for the virionsDiseaseCutoff attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for virionsDiseaseCutoff (can be null)
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of PartialStochasticModel 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: targetCellCount, immuneTargetRatio, immuneActivationRate, immuneWaningRate, infectionCarrierProbability, targetRecoveryRate, baselineViralInfectionRate, baselineViralReplicationRate, virionsDiseaseCutoff.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static PartialStochasticModel copyOf(StochasticModel._PartialStochasticModel instance)
      Creates an immutable copy of a StochasticModel._PartialStochasticModel 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 StochasticModel instance

    • builder

      public static PartialStochasticModel.Builder builder()
      Creates a builder for PartialStochasticModel. 
       PartialStochasticModel.builder()
    .setTargetCellCount(Integer | null) // nullable targetCellCount
    .setImmuneTargetRatio(io.github.ai4ci.abm.mechanics.Abstraction.Distribution | null) // nullable immuneTargetRatio
    .setImmuneActivationRate(io.github.ai4ci.abm.mechanics.Abstraction.Distribution | null) // nullable immuneActivationRate
    .setImmuneWaningRate(io.github.ai4ci.abm.mechanics.Abstraction.Distribution | null) // nullable immuneWaningRate
    .setInfectionCarrierProbability(io.github.ai4ci.abm.mechanics.Abstraction.Distribution | null) // nullable infectionCarrierProbability
    .setTargetRecoveryRate(io.github.ai4ci.abm.mechanics.Abstraction.Distribution | null) // nullable targetRecoveryRate
    .setBaselineViralInfectionRate(Double | null) // nullable baselineViralInfectionRate
    .setBaselineViralReplicationRate(Double | null) // nullable baselineViralReplicationRate
    .setVirionsDiseaseCutoff(Integer | null) // nullable virionsDiseaseCutoff
    .build();
      Returns:
      A new PartialStochasticModel builder