Package net.bmahe.genetics4j.extras.evolutionlisteners

Class CSVEvolutionListener<T extends Comparable<T>,U>

java.lang.Object

net.bmahe.genetics4j.extras.evolutionlisteners.CSVEvolutionListener<T,U>

Type Parameters:

T - Fitness type

U - Data type written to the CSV

All Implemented Interfaces:

EvolutionListener<T>

Direct Known Subclasses:

ImmutableCSVEvolutionListener

@Immutable
public abstract class CSVEvolutionListener<T extends Comparable<T>,U>
extends Object
implements EvolutionListener<T>

Evolution Listener which writes the output of each generation to a CSV file

Author:

bruno

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CSVEvolutionListener.Builder<T extends Comparable<T>,U>

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.commons.csv.CSVPrinter	csvPrinter
static final boolean	DEFAULT_AUTO_FLUSH
static final org.apache.logging.log4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
CSVEvolutionListener()

Method Summary

Modifier and Type	Method	Description
boolean	autoFlush()	Whether or not the CSV writer has auto flush enabled.
abstract List<ColumnExtractor<T,U>>	columnExtractors()	List of Column Extractors.
GenerationFunction<T,U>	evolutionContextSupplier()	User defined function to provide some additional information when computing the value to write.
abstract String	filename()	Destination file name for the CSV file
Function<Stream<EvolutionStep<T,U>>,Stream<EvolutionStep<T,U>>>	filter()	Users can supply an optional set of filters to control which individuals get written and in which order.
static <T extends Comparable<T>, U> CSVEvolutionListener<T,U>	of(String filename, Iterable<? extends ColumnExtractor<T,U>> columnExtractors)
static <T extends Comparable<T>, U> CSVEvolutionListener<T,U>	of(String filename, List<ColumnExtractor<T,U>> columnExtractors)
static <T extends Comparable<T>, U> CSVEvolutionListener<T,U>	of(String filename, GenerationFunction<T,U> evolutionContextSupplier, Iterable<? extends ColumnExtractor<T,U>> columnExtractors)
static <T extends Comparable<T>, U> CSVEvolutionListener<T,U>	of(String filename, GenerationFunction<T,U> evolutionContextSupplier, Iterable<? extends ColumnExtractor<T,U>> columnExtractors, int skipN)
static <T extends Comparable<T>, U> CSVEvolutionListener<T,U>	ofTopN(String filename, GenerationFunction<T,U> evolutionContextSupplier, Iterable<? extends ColumnExtractor<T,U>> columnExtractors, int topN)
static <T extends Comparable<T>, U> CSVEvolutionListener<T,U>	ofTopN(String filename, GenerationFunction<T,U> evolutionContextSupplier, Iterable<? extends ColumnExtractor<T,U>> columnExtractors, Comparator<T> comparator, int topN)
void	onEvolution(long generation, List<Genotype> population, List<T> fitness, boolean isDone)
protected org.apache.commons.csv.CSVPrinter	openPrinter()
int	skipN()	How many generations to skip between each writes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.bmahe.genetics4j.core.evolutionlisteners.EvolutionListener

postEvaluation, preEvaluation

Field Details

logger

public static final org.apache.logging.log4j.Logger logger

DEFAULT_AUTO_FLUSH

public static final boolean DEFAULT_AUTO_FLUSH

See Also:

• Constant Field Values

csvPrinter

private org.apache.commons.csv.CSVPrinter csvPrinter

Constructor Details

CSVEvolutionListener

public CSVEvolutionListener()

Method Details

openPrinter

protected org.apache.commons.csv.CSVPrinter openPrinter()

autoFlush

@Default
public boolean autoFlush()

Whether or not the CSV writer has auto flush enabled. Defaults to true<T extends Comparable<T>,U>

Returns:

evolutionContextSupplier

@Default
public GenerationFunction<T,U> evolutionContextSupplier()

User defined function to provide some additional information when computing the value to write. Defaults to null

Returns:

skipN

@Default
public int skipN()

How many generations to skip between each writes. Defaults to writing every generations

Returns:

filter

@Default
public Function<Stream<EvolutionStep<T,U>>,Stream<EvolutionStep<T,U>>> filter()

Users can supply an optional set of filters to control which individuals get written and in which order. Default to have no impact.

Returns:

filename

@Parameter
public abstract String filename()

Destination file name for the CSV file

Returns:

columnExtractors

@Parameter
public abstract List<ColumnExtractor<T,U>> columnExtractors()

List of Column Extractors. They specify how and what to write from each individual at a given generation

Returns:

onEvolution

public void onEvolution(long generation,
 List<Genotype> population,
 List<T> fitness,
 boolean isDone)

Specified by:

onEvolution in interface EvolutionListener<T extends Comparable<T>>

of

public static <T extends Comparable<T>,
U>
CSVEvolutionListener<T,U> of(String filename,
 List<ColumnExtractor<T,U>> columnExtractors)

of

public static <T extends Comparable<T>,
U>
CSVEvolutionListener<T,U> of(String filename,
 Iterable<? extends ColumnExtractor<T,U>> columnExtractors)

of

public static <T extends Comparable<T>,
U>
CSVEvolutionListener<T,U> of(String filename,
 GenerationFunction<T,U> evolutionContextSupplier,
 Iterable<? extends ColumnExtractor<T,U>> columnExtractors)

of

public static <T extends Comparable<T>,
U>
CSVEvolutionListener<T,U> of(String filename,
 GenerationFunction<T,U> evolutionContextSupplier,
 Iterable<? extends ColumnExtractor<T,U>> columnExtractors,
 int skipN)

ofTopN

public static <T extends Comparable<T>,
U>
CSVEvolutionListener<T,U> ofTopN(String filename,
 GenerationFunction<T,U> evolutionContextSupplier,
 Iterable<? extends ColumnExtractor<T,U>> columnExtractors,
 Comparator<T> comparator,
 int topN)

ofTopN

public static <T extends Comparable<T>,
U>
CSVEvolutionListener<T,U> ofTopN(String filename,
 GenerationFunction<T,U> evolutionContextSupplier,
 Iterable<? extends ColumnExtractor<T,U>> columnExtractors,
 int topN)