pl.edu.agh.age.compute.stream.emas

Class Pipeline

java.lang.Object

pl.edu.agh.age.compute.stream.Pipeline<EmasAgent,Pipeline>

pl.edu.agh.age.compute.stream.emas.Pipeline

public final class Pipeline
extends Pipeline<EmasAgent,Pipeline>

EMAS agent processing definition.

Pipeline is similar to Java Streams, but its methods are executed when called and not lazily computed when needed. This implementation is immutable - each call returns a new pipeline instance or a tuple of new instances.

See Also:

Pipeline

Field Summary

Fields inherited from class pl.edu.agh.age.compute.stream.Pipeline

pipelineFactory, population

Constructor Summary

Constructors

Constructor and Description
Pipeline(io.vavr.collection.List<EmasAgent> population)

Method Summary

Modifier and Type	Method and Description
io.vavr.Tuple2<Pipeline,Pipeline>	dieWhen(java.util.function.Predicate<EmasAgent> deathPredicate) Population splitter for death.
Pipeline	evaluate(PopulationEvaluator<EmasAgent> populationEvaluator) Evaluates agents in the population.
io.vavr.Tuple2<Pipeline,Pipeline>	migrateWhen(java.util.function.Predicate<EmasAgent> migrationPredicate) Population splitter for migration.
static Pipeline	on(io.vavr.collection.List<EmasAgent> population) Create a new pipeline for the given population.
Pipeline	process(java.util.function.Function<io.vavr.collection.Seq<EmasAgent>,io.vavr.collection.Seq<EmasAgent>> populationProcessor) Processes the whole population, applying a custom function to it.
io.vavr.Tuple2<PairPipeline,Pipeline>	selectPairs(java.util.function.BiFunction<EmasAgent,io.vavr.collection.List<EmasAgent>,io.vavr.Tuple2<EmasAgent,EmasAgent>> selector) Select pairs from the current population in this pipeline with regards to the given selector function.
PairPipeline	selectPairsWithRepetitions(java.util.function.BiFunction<EmasAgent,io.vavr.collection.List<EmasAgent>,io.vavr.Tuple2<EmasAgent,EmasAgent>> selector) Select pairs from the current population in this pipeline with regards to the given selector function.
private static io.vavr.Tuple2<EmasAgent,EmasAgent>	selfReproduce(EmasAgent agent, java.util.function.Predicate<EmasAgent> selfReproductionPredicate, java.util.function.Function<EmasAgent,io.vavr.Tuple2<EmasAgent,EmasAgent>> selfReproductionStrategy)
io.vavr.Tuple2<Pipeline,Pipeline>	selfReproduce(java.util.function.Function<EmasAgent,io.vavr.Tuple2<EmasAgent,EmasAgent>> selfReproductionStrategy) Self reproduce all agents from this pipeline, using a provided strategy.
io.vavr.Tuple2<Pipeline,Pipeline>	selfReproduce(java.util.function.Predicate<EmasAgent> selfReproductionPredicate, java.util.function.Function<EmasAgent,io.vavr.Tuple2<EmasAgent,EmasAgent>> selfReproductionStrategy) Self reproduce agents from this pipeline that meet a given reproduction predicate.

Methods inherited from class pl.edu.agh.age.compute.stream.Pipeline

extract, mergeWith, split

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pipeline

Pipeline(io.vavr.collection.List<EmasAgent> population)

Method Detail

on

public static Pipeline on(io.vavr.collection.List<EmasAgent> population)

Create a new pipeline for the given population.

Parameters:

population - population of EMAS agents.

Returns:

a new pipeline instance.

selectPairsWithRepetitions

public PairPipeline selectPairsWithRepetitions(java.util.function.BiFunction<EmasAgent,io.vavr.collection.List<EmasAgent>,io.vavr.Tuple2<EmasAgent,EmasAgent>> selector)

Select pairs from the current population in this pipeline with regards to the given selector function.

Parameters:

selector - a function of two arguments. The first argument is an agent and the second one - the rest of the current population. The selector should return a pair of agents selected for this agent. Usually it will be the given agent and another one.

Returns:

a pipeline operating on pairs of agents.

See Also:

Selectors

selectPairs

public io.vavr.Tuple2<PairPipeline,Pipeline> selectPairs(java.util.function.BiFunction<EmasAgent,io.vavr.collection.List<EmasAgent>,io.vavr.Tuple2<EmasAgent,EmasAgent>> selector)

Select pairs from the current population in this pipeline with regards to the given selector function.

Parameters:

selector - a function of two arguments. The first argument is an agent and the second one - the rest of the current population. The selector should return a pair of agents selected for this agent. Usually it will be the given agent and another one.

Returns:

a pair of pipelines - the first one is a PairPipeline containing the selected pairs, the second one - pipeline containing all agents which have not been selected.

See Also:

Selectors

selfReproduce

public final io.vavr.Tuple2<Pipeline,Pipeline> selfReproduce(java.util.function.Function<EmasAgent,io.vavr.Tuple2<EmasAgent,EmasAgent>> selfReproductionStrategy)

Self reproduce all agents from this pipeline, using a provided strategy.

Parameters:

selfReproductionStrategy - the self reproduction strategy

Returns:

the tuple containing parent and child agents pipelines

selfReproduce

public final io.vavr.Tuple2<Pipeline,Pipeline> selfReproduce(java.util.function.Predicate<EmasAgent> selfReproductionPredicate,
                                                             java.util.function.Function<EmasAgent,io.vavr.Tuple2<EmasAgent,EmasAgent>> selfReproductionStrategy)

Self reproduce agents from this pipeline that meet a given reproduction predicate.

Parameters:

selfReproductionPredicate - the self reproduction predicate

selfReproductionStrategy - the self reproduction strategy

Returns:

the tuple containing parent and child agents pipelines

selfReproduce

private static io.vavr.Tuple2<EmasAgent,EmasAgent> selfReproduce(EmasAgent agent,
                                                                 java.util.function.Predicate<EmasAgent> selfReproductionPredicate,
                                                                 java.util.function.Function<EmasAgent,io.vavr.Tuple2<EmasAgent,EmasAgent>> selfReproductionStrategy)

evaluate

public final Pipeline evaluate(PopulationEvaluator<EmasAgent> populationEvaluator)

Evaluates agents in the population.

Parameters:

populationEvaluator - the population evaluator

Returns:

the pipeline

process

public final Pipeline process(java.util.function.Function<io.vavr.collection.Seq<EmasAgent>,io.vavr.collection.Seq<EmasAgent>> populationProcessor)

Processes the whole population, applying a custom function to it.

Parameters:

populationProcessor - the function to process the population

Returns:

the pipeline

migrateWhen

public io.vavr.Tuple2<Pipeline,Pipeline> migrateWhen(java.util.function.Predicate<EmasAgent> migrationPredicate)

Population splitter for migration.

Parameters:

migrationPredicate - a predicate that should return true if an agent should be migrated.

Returns:

a pair of pipelines - the first one contains agents for migration, the second one - agents staying in this population.

See Also:

Predicates

dieWhen

public io.vavr.Tuple2<Pipeline,Pipeline> dieWhen(java.util.function.Predicate<EmasAgent> deathPredicate)

Population splitter for death.

Parameters:

deathPredicate - a predicate that should return true if an agent should die.

Returns:

a pair of pipelines - the first one contains agents that are dead, the second one - agents staying in this population.

See Also:

Predicates