Package io.github.ai4ci.abm.inhost

Class ImmutableBiPhasicLogistic

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

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

See Also:

  • Method Details

    • getGrowthRate

      public double getGrowthRate()
      Specified by:
      getGrowthRate in interface ExposureModel.BiPhasicLogistic
      Returns:
      The value of the growthRate attribute

    • getGrowthTime

      public double getGrowthTime()
      Specified by:
      getGrowthTime in interface ExposureModel.BiPhasicLogistic
      Returns:
      The value of the growthTime attribute

    • getDecayRate

      public double getDecayRate()
      Specified by:
      getDecayRate in interface ExposureModel.BiPhasicLogistic
      Returns:
      The value of the decayRate attribute

    • getDecayTime

      public double getDecayTime()
      Specified by:
      getDecayTime in interface ExposureModel.BiPhasicLogistic
      Returns:
      The value of the decayTime attribute

    • getUnit

      public double getUnit()
      Specified by:
      getUnit in interface ExposureModel.BiPhasicLogistic
      Returns:
      The computed-at-construction value of the unit attribute

    • withGrowthRate

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

    • withGrowthTime

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

    • withDecayRate

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

    • withDecayTime

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

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableBiPhasicLogistic 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: growthRate, growthTime, decayRate, decayTime, unit.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static ImmutableBiPhasicLogistic copyOf(ExposureModel.BiPhasicLogistic instance)
      Creates an immutable copy of a ExposureModel.BiPhasicLogistic 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 BiPhasicLogistic instance

    • toBuilder

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

    • builder

      public static ImmutableBiPhasicLogistic.Builder builder()
      Creates a builder for ImmutableBiPhasicLogistic. 
       ImmutableBiPhasicLogistic.builder()
    .setGrowthRate(double) // required growthRate
    .setGrowthTime(double) // required growthTime
    .setDecayRate(double) // required decayRate
    .setDecayTime(double) // required decayTime
    .build();
      Returns:
      A new ImmutableBiPhasicLogistic builder