simudyne.core.abm

Interface Group<A extends Agent<?>>

public interface Group<A extends Agent<?>>

A group is a collection of Agents of a specific type that can be used to create links between agents in the group, and to agents in other groups.

When connecting two groups, one has to use a specific Linker to define the exact topology to use. Some Groups propose more possibilities of connections overloading connect(simudyne.core.abm.Group<?>, C).

Method Summary

Modifier and Type	Method and Description
default <L extends Link> BananaTree<A,L>	bananaTreeConnected(int nbStars, java.lang.Class<L> linkClass) bananaTreeConnected(int, Class, SerializableBiConsumer) without a data injector so no initial function is run for links.
<L extends Link> BananaTree<A,L>	bananaTreeConnected(int nbStars, java.lang.Class<L> linkClass, SerializableBiConsumer<A,L> dataInjector) Connect agents within this group using the GridConnected strategy.
<C extends Connector<A>> C	connect(Group<?> target, C connector) Connect this group to a target group using connection rules defined in a Connector
default <L extends Link> FullyConnected<A,L>	fullyConnected(Group<?> target, java.lang.Class<L> linkClass) fullyConnected(Group, Class, SerializableBiConsumer) without a data injector so no initial function is run for links
<L extends Link> FullyConnected<A,L>	fullyConnected(Group<?> target, java.lang.Class<L> linkClass, SerializableBiConsumer<A,L> dataInjector) Connect this group to a target group using the FullyConnected strategy.
default <L extends Link> GraphConnector<A,L>	graphConnected(org.apache.commons.math3.distribution.IntegerDistribution degreeDistr, org.apache.commons.math3.distribution.RealDistribution clustCoefDistr, java.lang.Class<L> linkClass) graphConnected(IntegerDistribution, RealDistribution, Class, SerializableBiConsumer) without a data injector so no initial function is run for links.
<L extends Link> GraphConnector<A,L>	graphConnected(org.apache.commons.math3.distribution.IntegerDistribution degreeDistr, org.apache.commons.math3.distribution.RealDistribution clustCoefDistr, java.lang.Class<L> linkClass, SerializableBiConsumer<A,L> dataInjector)
default <L extends Link> GridConnected<A,L>	gridConnected(java.lang.Class<L> linkClass) gridConnected(Class, SerializableBiConsumer) without a data injector so no initial function is run for links.
<L extends Link> GridConnected<A,L>	gridConnected(java.lang.Class<L> linkClass, SerializableBiConsumer<A,L> dataInjector) Connect agents within this group using the GridConnected strategy.
default <L extends Link> DataConnector<A,L>	loadConnections(Group<?> target, java.lang.Class<L> linkClass, Source source) loadConnections(Group, Class, Source, SerializableBiConsumer) without a data injector so no initial function is run for links
<L extends Link> DataConnector<A,L>	loadConnections(Group<?> target, java.lang.Class<L> linkClass, Source source, SerializableBiConsumer<A,L> linkInjector) Connect this Group with another Group, using some data via a DataConnector.
default <L extends Link> PartitionConnected<A,L>	partitionConnected(Group<?> target, java.lang.Class<L> linkClass) partitionConnected(Group, Class, SerializableBiConsumer) without a data injector so no initial function is run for links.
<L extends Link> PartitionConnected<A,L>	partitionConnected(Group<?> target, java.lang.Class<L> linkClass, SerializableBiConsumer<A,L> dataInjector) Connect this group to a target group using the PartitionConnected strategy.
default <L extends Link> RingConnected<A,L>	ringConnected(java.lang.Class<L> linkClass) ringConnected(Class, SerializableBiConsumer) without a data injector so no initial function is run for links.
<L extends Link> RingConnected<A,L>	ringConnected(java.lang.Class<L> linkClass, SerializableBiConsumer<A,L> dataInjector) Connect agents within this group using the RingConnected strategy.
default <L extends Link> SmallWorld<A,L>	smallWorldConnected(int inDegree, double beta, java.lang.Class<L> linkClass) smallWorldConnected(int, double, Class, SerializableBiConsumer) without a data injector so no initial function is run for links.
<L extends Link> SmallWorld<A,L>	smallWorldConnected(int inDegree, double beta, java.lang.Class<L> linkClass, SerializableBiConsumer<A,L> dataInjector) Connect agents within this group using the SmallWorld strategy.

Method Detail

connect

<C extends Connector<A>> C connect(Group<?> target,
                                   C connector)

Connect this group to a target group using connection rules defined in a Connector

Parameters:

target - The group to connect to

connector - Connector class to use for the connection

Returns:

Connector that will be used to connect the groups.

loadConnections

default <L extends Link> DataConnector<A,L> loadConnections(Group<?> target,
                                                            java.lang.Class<L> linkClass,
                                                            Source source)

loadConnections(Group, Class, Source, SerializableBiConsumer) without a data injector so no initial function is run for links

loadConnections

<L extends Link> DataConnector<A,L> loadConnections(Group<?> target,
                                                    java.lang.Class<L> linkClass,
                                                    Source source,
                                                    SerializableBiConsumer<A,L> linkInjector)

Connect this Group with another Group, using some data via a DataConnector.

Parameters:

target - The group to connect to.

source - The source to use

linkInjector - Function run when on each link after is loaded from source which can be used to set initialization values of link

fullyConnected

default <L extends Link> FullyConnected<A,L> fullyConnected(Group<?> target,
                                                            java.lang.Class<L> linkClass)

fullyConnected(Group, Class, SerializableBiConsumer) without a data injector so no initial function is run for links

fullyConnected

<L extends Link> FullyConnected<A,L> fullyConnected(Group<?> target,
                                                    java.lang.Class<L> linkClass,
                                                    SerializableBiConsumer<A,L> dataInjector)

Connect this group to a target group using the FullyConnected strategy.

Parameters:

target - The group to connect to

linkClass - Class to be used to store data on the links between agents

dataInjector - Function run when each link is created which can be used to set initialization values of link

partitionConnected

default <L extends Link> PartitionConnected<A,L> partitionConnected(Group<?> target,
                                                                    java.lang.Class<L> linkClass)

partitionConnected(Group, Class, SerializableBiConsumer) without a data injector so no initial function is run for links.

partitionConnected

<L extends Link> PartitionConnected<A,L> partitionConnected(Group<?> target,
                                                            java.lang.Class<L> linkClass,
                                                            SerializableBiConsumer<A,L> dataInjector)

Connect this group to a target group using the PartitionConnected strategy.

Parameters:

target - The group to connect to

linkClass - Class to be used to store data on the links between agents

dataInjector - Function run when each link is created which can be used to set initialization values of link

smallWorldConnected

default <L extends Link> SmallWorld<A,L> smallWorldConnected(int inDegree,
                                                             double beta,
                                                             java.lang.Class<L> linkClass)

smallWorldConnected(int, double, Class, SerializableBiConsumer) without a data injector so no initial function is run for links.

smallWorldConnected

<L extends Link> SmallWorld<A,L> smallWorldConnected(int inDegree,
                                                     double beta,
                                                     java.lang.Class<L> linkClass,
                                                     SerializableBiConsumer<A,L> dataInjector)

Connect agents within this group using the SmallWorld strategy.

Parameters:

inDegree - The number of outgoing links for each agent

beta - The degree of randomness of the graph (Must be between 0 and 1)

linkClass - Class to be used to store data on the links between agents

dataInjector - Function run when each link is created which can be used to set initialization values of link

ringConnected

default <L extends Link> RingConnected<A,L> ringConnected(java.lang.Class<L> linkClass)

ringConnected(Class, SerializableBiConsumer) without a data injector so no initial function is run for links.

ringConnected

<L extends Link> RingConnected<A,L> ringConnected(java.lang.Class<L> linkClass,
                                                  SerializableBiConsumer<A,L> dataInjector)

Connect agents within this group using the RingConnected strategy.

Parameters:

linkClass - Class to be used to store data on the links between agents

dataInjector - Function run when each link is created which can be used to set initialization values of link

gridConnected

default <L extends Link> GridConnected<A,L> gridConnected(java.lang.Class<L> linkClass)

gridConnected(Class, SerializableBiConsumer) without a data injector so no initial function is run for links.

gridConnected

<L extends Link> GridConnected<A,L> gridConnected(java.lang.Class<L> linkClass,
                                                  SerializableBiConsumer<A,L> dataInjector)

Connect agents within this group using the GridConnected strategy.

Parameters:

linkClass - Class to be used to store data on the links between agents

dataInjector - Function run when each link is created which can be used to set initialization values of link

bananaTreeConnected

default <L extends Link> BananaTree<A,L> bananaTreeConnected(int nbStars,
                                                             java.lang.Class<L> linkClass)

bananaTreeConnected(int, Class, SerializableBiConsumer) without a data injector so no initial function is run for links.

bananaTreeConnected

<L extends Link> BananaTree<A,L> bananaTreeConnected(int nbStars,
                                                     java.lang.Class<L> linkClass,
                                                     SerializableBiConsumer<A,L> dataInjector)

Connect agents within this group using the GridConnected strategy.

Parameters:

nbStars - Number of stars to create

linkClass - Class to be used to store data on the links between agents

dataInjector - Function run when each link is created which can be used to set initialization values of link

graphConnected

default <L extends Link> GraphConnector<A,L> graphConnected(org.apache.commons.math3.distribution.IntegerDistribution degreeDistr,
                                                            org.apache.commons.math3.distribution.RealDistribution clustCoefDistr,
                                                            java.lang.Class<L> linkClass)

graphConnected(IntegerDistribution, RealDistribution, Class, SerializableBiConsumer) without a data injector so no initial function is run for links.

graphConnected

<L extends Link> GraphConnector<A,L> graphConnected(org.apache.commons.math3.distribution.IntegerDistribution degreeDistr,
                                                    org.apache.commons.math3.distribution.RealDistribution clustCoefDistr,
                                                    java.lang.Class<L> linkClass,
                                                    SerializableBiConsumer<A,L> dataInjector)