Package io.github.ai4ci.config.setup

Class ImmutableAgeStratifiedNetworkConfiguration

java.lang.Object

io.github.ai4ci.config.setup.ImmutableAgeStratifiedNetworkConfiguration

All Implemented Interfaces:

Abstraction.Named, Abstraction.Replica, AgeStratifiedNetworkConfiguration, SetupConfiguration, Serializable

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableAgeStratifiedNetworkConfiguration
extends Object
implements AgeStratifiedNetworkConfiguration

Immutable implementation of AgeStratifiedNetworkConfiguration.

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableAgeStratifiedNetworkConfiguration.Builder	Builds instances of type ImmutableAgeStratifiedNetworkConfiguration.

Nested classes/interfaces inherited from interface io.github.ai4ci.config.setup.AgeStratifiedNetworkConfiguration

AgeStratifiedNetworkConfiguration._PartialAgeStratifiedNetworkConfiguration

Field Summary

Fields inherited from interface io.github.ai4ci.config.setup.AgeStratifiedNetworkConfiguration

DEFAULT

Method Summary

Modifier and Type	Method	Description
static ImmutableAgeStratifiedNetworkConfiguration.Builder	builder()	Creates a builder for ImmutableAgeStratifiedNetworkConfiguration.
static ImmutableAgeStratifiedNetworkConfiguration	copyOf(AgeStratifiedNetworkConfiguration instance)	Creates an immutable copy of a AgeStratifiedNetworkConfiguration value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableAgeStratifiedNetworkConfiguration that have equal attribute values.
ImmutableEmpiricalDistribution	getAgeDistribution()
Integer	getInitialImports()
String	getName()
int	getNetworkConnectedness()
double	getNetworkRandomness()
Integer	getNetworkSize()
Abstraction.SimpleFunction	getNormalisedOddsContactFromAgeDifference()
Abstraction.SimpleFunction	getOddsContactFromAgeDifference()
Integer	getReplicate()
int	hashCode()	Computes a hash code from attributes: name, replicate, networkSize, initialImports, ageDistribution, networkConnectedness, networkRandomness, oddsContactFromAgeDifference, normalisedOddsContactFromAgeDifference.
ImmutableAgeStratifiedNetworkConfiguration.Builder	toBuilder()	Creates a builder for ImmutableAgeStratifiedNetworkConfiguration.prefilled with attibute values of this instance to easily create modified copies.
String	toString()	Prints the immutable value AgeStratifiedNetworkConfiguration with attribute values.
final ImmutableAgeStratifiedNetworkConfiguration	withAgeDistribution(EmpiricalDistribution value)	Copy the current immutable object by setting a value for the ageDistribution attribute.
final ImmutableAgeStratifiedNetworkConfiguration	withInitialImports(Integer value)	Copy the current immutable object by setting a value for the initialImports attribute.
final ImmutableAgeStratifiedNetworkConfiguration	withName(String value)	Copy the current immutable object by setting a value for the name attribute.
final ImmutableAgeStratifiedNetworkConfiguration	withNetworkConnectedness(int value)	Copy the current immutable object by setting a value for the networkConnectedness attribute.
final ImmutableAgeStratifiedNetworkConfiguration	withNetworkRandomness(double value)	Copy the current immutable object by setting a value for the networkRandomness attribute.
final ImmutableAgeStratifiedNetworkConfiguration	withNetworkSize(Integer value)	Copy the current immutable object by setting a value for the networkSize attribute.
final ImmutableAgeStratifiedNetworkConfiguration	withNormalisedOddsContactFromAgeDifference(Abstraction.SimpleFunction value)	Copy the current immutable object by setting a value for the normalisedOddsContactFromAgeDifference attribute.
final ImmutableAgeStratifiedNetworkConfiguration	withOddsContactFromAgeDifference(Abstraction.SimpleFunction value)	Copy the current immutable object by setting a value for the oddsContactFromAgeDifference attribute.
final ImmutableAgeStratifiedNetworkConfiguration	withReplicate(Integer value)	Copy the current immutable object by setting a value for the replicate attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.ai4ci.config.setup.AgeStratifiedNetworkConfiguration

adjustedProbabilityContact

Methods inherited from interface io.github.ai4ci.config.setup.SetupConfiguration

getHilbertCoords

Method Details

getName

public String getName()

Specified by:

getName in interface Abstraction.Named

Returns:

The value of the name attribute

getReplicate

public Integer getReplicate()

Specified by:

getReplicate in interface Abstraction.Replica

Returns:

The value of the replicate attribute

getNetworkSize

public Integer getNetworkSize()

Specified by:

getNetworkSize in interface SetupConfiguration

Returns:

The value of the networkSize attribute

getInitialImports

public Integer getInitialImports()

Specified by:

getInitialImports in interface SetupConfiguration

Returns:

The value of the initialImports attribute

getAgeDistribution

public ImmutableEmpiricalDistribution getAgeDistribution()

Specified by:

getAgeDistribution in interface AgeStratifiedNetworkConfiguration

Returns:

The value of the ageDistribution attribute

getNetworkConnectedness

public int getNetworkConnectedness()

Specified by:

getNetworkConnectedness in interface AgeStratifiedNetworkConfiguration

Returns:

The value of the networkConnectedness attribute

getNetworkRandomness

public double getNetworkRandomness()

Specified by:

getNetworkRandomness in interface AgeStratifiedNetworkConfiguration

Returns:

The value of the networkRandomness attribute

getOddsContactFromAgeDifference

public Abstraction.SimpleFunction getOddsContactFromAgeDifference()

Specified by:

getOddsContactFromAgeDifference in interface AgeStratifiedNetworkConfiguration

Returns:

The value of the oddsContactFromAgeDifference attribute

getNormalisedOddsContactFromAgeDifference

public Abstraction.SimpleFunction getNormalisedOddsContactFromAgeDifference()

Specified by:

getNormalisedOddsContactFromAgeDifference in interface AgeStratifiedNetworkConfiguration

Returns:

The value of the normalisedOddsContactFromAgeDifference attribute

withName

public final ImmutableAgeStratifiedNetworkConfiguration withName(String value)

Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.

Specified by:

withName in interface SetupConfiguration

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withReplicate

public final ImmutableAgeStratifiedNetworkConfiguration withReplicate(Integer value)

Copy the current immutable object by setting a value for the replicate attribute. An equals check used to prevent copying of the same value by returning this.

Specified by:

withReplicate in interface SetupConfiguration

Parameters:

value - A new value for replicate

Returns:

A modified copy of the this object

withNetworkSize

public final ImmutableAgeStratifiedNetworkConfiguration withNetworkSize(Integer value)

Copy the current immutable object by setting a value for the networkSize attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for networkSize

Returns:

A modified copy of the this object

withInitialImports

public final ImmutableAgeStratifiedNetworkConfiguration withInitialImports(Integer value)

Copy the current immutable object by setting a value for the initialImports attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for initialImports

Returns:

A modified copy of the this object

withAgeDistribution

public final ImmutableAgeStratifiedNetworkConfiguration withAgeDistribution(EmpiricalDistribution value)

Copy the current immutable object by setting a value for the ageDistribution attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for ageDistribution

Returns:

A modified copy of the this object

withNetworkConnectedness

public final ImmutableAgeStratifiedNetworkConfiguration withNetworkConnectedness(int value)

Copy the current immutable object by setting a value for the networkConnectedness attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for networkConnectedness

Returns:

A modified copy of the this object

withNetworkRandomness

public final ImmutableAgeStratifiedNetworkConfiguration withNetworkRandomness(double value)

Copy the current immutable object by setting a value for the networkRandomness attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for networkRandomness

Returns:

A modified copy of the this object

withOddsContactFromAgeDifference

public final ImmutableAgeStratifiedNetworkConfiguration withOddsContactFromAgeDifference(Abstraction.SimpleFunction value)

Copy the current immutable object by setting a value for the oddsContactFromAgeDifference attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for oddsContactFromAgeDifference

Returns:

A modified copy of the this object

withNormalisedOddsContactFromAgeDifference

public final ImmutableAgeStratifiedNetworkConfiguration withNormalisedOddsContactFromAgeDifference(Abstraction.SimpleFunction value)

Copy the current immutable object by setting a value for the normalisedOddsContactFromAgeDifference attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for normalisedOddsContactFromAgeDifference

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
 Object another)

This instance is equal to all instances of ImmutableAgeStratifiedNetworkConfiguration 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: name, replicate, networkSize, initialImports, ageDistribution, networkConnectedness, networkRandomness, oddsContactFromAgeDifference, normalisedOddsContactFromAgeDifference.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AgeStratifiedNetworkConfiguration with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableAgeStratifiedNetworkConfiguration copyOf(AgeStratifiedNetworkConfiguration instance)

Creates an immutable copy of a AgeStratifiedNetworkConfiguration 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 AgeStratifiedNetworkConfiguration instance

toBuilder

public ImmutableAgeStratifiedNetworkConfiguration.Builder toBuilder()

Creates a builder for ImmutableAgeStratifiedNetworkConfiguration.prefilled with attibute values of this instance to easily create modified copies.

Returns:

A new ImmutableAgeStratifiedNetworkConfiguration builder with attributes of this instance

builder

public static ImmutableAgeStratifiedNetworkConfiguration.Builder builder()

Creates a builder for ImmutableAgeStratifiedNetworkConfiguration.

 ImmutableAgeStratifiedNetworkConfiguration.builder()
    .setName(String) // required name
    .setReplicate(Integer) // optional replicate
    .setNetworkSize(Integer) // required networkSize
    .setInitialImports(Integer) // required initialImports
    .setAgeDistribution(io.github.ai4ci.util.EmpiricalDistribution) // required ageDistribution
    .setNetworkConnectedness(int) // required networkConnectedness
    .setNetworkRandomness(double) // required networkRandomness
    .setOddsContactFromAgeDifference(io.github.ai4ci.abm.mechanics.Abstraction.SimpleFunction) // required oddsContactFromAgeDifference
    .setNormalisedOddsContactFromAgeDifference(io.github.ai4ci.abm.mechanics.Abstraction.SimpleFunction) // optional normalisedOddsContactFromAgeDifference
    .build();
 

Returns:

A new ImmutableAgeStratifiedNetworkConfiguration builder