Package org.opt4j.core.optimizer

Class Archive

java.lang.Object

org.opt4j.core.IndividualSet

org.opt4j.core.optimizer.Archive

All Implemented Interfaces:

Iterable<Individual>, Collection<Individual>, Set<Individual>

Direct Known Subclasses:

AbstractArchive

public abstract class Archive
extends IndividualSet

An Archive is used to store a set of high-quality Individual s. Commonly, these Individuals are non-dominated.

Field Summary

Fields inherited from class org.opt4j.core.IndividualSet

individuals, listeners

Constructor Summary

Constructors

Constructor	Description
Archive()

Method Summary

Modifier and Type	Method	Description
boolean	add(Individual individual)	Deprecated.
boolean	addAll(Collection<? extends Individual> c)	Deprecated.
boolean	addAll(Individual... c)	Deprecated.
protected boolean	addCheckedIndividual(Individual individual)	Adds the Individual to this Archive without further checks.
protected boolean	addCheckedIndividuals(Collection<? extends Individual> individuals)	Adds the Individuals to this Archive without further checks.
abstract boolean	update(Set<? extends Individual> individuals)	Updates the archive with a set of individuals.
boolean	update(Individual individual)	Updates the archive with a single individual.

Methods inherited from class org.opt4j.core.IndividualSet

addListener, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeListener, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Constructor Detail

Archive

public Archive()

Method Detail

update

public boolean update(Individual individual)

Updates the archive with a single individual.

Parameters:

individual - the individual that is used to update the archive

Returns:

returns true if the content of the archive changed

update

public abstract boolean update(Set<? extends Individual> individuals)

Updates the archive with a set of individuals. Instead of the add /addAll methods, which are prohibited for the archive (throwing an UnsupportedOperationException), this method shall be used.

Parameters:

individuals - the set of individuals that is used to update the archive

Returns:

returns true if the content of the archive changed

add

@Deprecated
public final boolean add(Individual individual)

Deprecated.

Specified by:

add in interface Collection<Individual>

Specified by:

add in interface Set<Individual>

Overrides:

add in class IndividualSet

addAll

@Deprecated
public final boolean addAll(Collection<? extends Individual> c)

Deprecated.

Specified by:

addAll in interface Collection<Individual>

Specified by:

addAll in interface Set<Individual>

Overrides:

addAll in class IndividualSet

addAll

@Deprecated
public final boolean addAll(Individual... c)

Deprecated.

Description copied from class: IndividualSet

Add all Individuals.

Overrides:

addAll in class IndividualSet

Parameters:

c - the individuals to be added

Returns:

true if at least one individual was added

addCheckedIndividual

protected boolean addCheckedIndividual(Individual individual)

Adds the Individual to this Archive without further checks. Must be used only if the Individual is checked to be Pareto-dominant and, according to possible archive size restrictions, can be added to this Archive.

Parameters:

individual - the individual to be actually added to the archive

Returns:

true

addCheckedIndividuals

protected boolean addCheckedIndividuals(Collection<? extends Individual> individuals)

Adds the Individuals to this Archive without further checks. Must be used only if the Individuals are checked to be Pareto-dominant and, according to possible archive size restrictions, can all be added to this Archive.

Parameters:

individuals - the individuals to be actually added to the archive

Returns:

true