io.jenetics

Class AltererResult<G extends Gene<?,G>,C extends Comparable<? super C>>

java.lang.Object

io.jenetics.AltererResult<G,C>

All Implemented Interfaces:

Serializable

public final class AltererResult<G extends Gene<?,G>,C extends Comparable<? super C>>
extends Object
implements Serializable

Represents the result pair of a Alterer.alter(Seq, long) call, which consists of the altered population and the number of altered individuals.

Since:

4.0

Version:

4.0

Author:

Franz Wilhelmstötter

See Also:

Alterer, Serialized Form

Implementation Requirements:

This class is immutable and thread-safe.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getAlterations() Return the number of altered individuals.
ISeq<Phenotype<G,C>>	getPopulation() Return the altered population.
int	hashCode()
static <G extends Gene<?,G>,C extends Comparable<? super C>> AltererResult<G,C>	of(ISeq<Phenotype<G,C>> population) Return a new alter result for the given arguments.
static <G extends Gene<?,G>,C extends Comparable<? super C>> AltererResult<G,C>	of(ISeq<Phenotype<G,C>> population, int alterations) Return a new alter result for the given arguments.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getPopulation

public ISeq<Phenotype<G,C>> getPopulation()

Return the altered population.

Returns:

the altered population

getAlterations

public int getAlterations()

Return the number of altered individuals.

Returns:

the number of altered individuals

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static <G extends Gene<?,G>,C extends Comparable<? super C>> AltererResult<G,C> of(ISeq<Phenotype<G,C>> population,
                                                                                          int alterations)

Return a new alter result for the given arguments.

Type Parameters:

G - the gene type

C - the result type

Parameters:

population - the altered population

alterations - the number of altered individuals

Returns:

a new alterer for the given arguments

Throws:

NullPointerException - if the given population is null

IllegalArgumentException - if the given alterations is negative

of

public static <G extends Gene<?,G>,C extends Comparable<? super C>> AltererResult<G,C> of(ISeq<Phenotype<G,C>> population)

Return a new alter result for the given arguments.

Type Parameters:

G - the gene type

C - the result type

Parameters:

population - the altered population

Returns:

a new alterer for the given arguments

Throws:

NullPointerException - if the given population is null