io.jenetics

Class AbstractChromosome<G extends Gene<?,G>>

java.lang.Object

io.jenetics.AbstractChromosome<G>

Type Parameters:

G - the gene type.

All Implemented Interfaces:

Chromosome<G>, Factory<Chromosome<G>>, Verifiable, Serializable, Iterable<G>, RandomAccess

Direct Known Subclasses:

AnyChromosome, CharacterChromosome, DoubleChromosome, IntegerChromosome, LongChromosome, PermutationChromosome

public abstract class AbstractChromosome<G extends Gene<?,G>>
extends Object
implements Chromosome<G>, RandomAccess, Serializable

The abstract base implementation of the Chromosome interface. The implementors of this class must assure that the protected member _genes is not null and the length of the genes > 0.

Since:

1.0

Version:

2.0

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ISeq<G>	_genes Array of genes which forms the chromosome.
protected Boolean	_valid Indicates whether this chromosome is valid or not.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractChromosome(ISeq<? extends G> genes) Create a new AbstractChromosome from the given genes array.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
G	getGene(int index) Return the gene on the specified index.
int	hashCode()
boolean	isValid() Check if this object is valid.
Iterator<G>	iterator()
int	length() Returns the length of the Chromosome.
ISeq<G>	toSeq() Return an unmodifiable sequence of the genes of this chromosome.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jenetics.Chromosome

as, getGene, newInstance, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.jenetics.util.Factory

instances, newInstance

Field Detail

_genes

protected final transient ISeq<G extends Gene<?,G>> _genes

Array of genes which forms the chromosome. This array must be initialized by the derived classes.

_valid

protected transient Boolean _valid

Indicates whether this chromosome is valid or not. If the variable is null the validation state hasn't been calculated yet.

Constructor Detail

AbstractChromosome

protected AbstractChromosome(ISeq<? extends G> genes)

Create a new AbstractChromosome from the given genes array.

Parameters:

genes - the genes that form the chromosome.

Throws:

NullPointerException - if the given gene array is null.

IllegalArgumentException - if the length of the gene sequence is empty.

Method Detail

getGene

public G getGene(int index)

Description copied from interface: Chromosome

Return the gene on the specified index.

Specified by:

getGene in interface Chromosome<G extends Gene<?,G>>

Parameters:

index - The gene index.

Returns:

the wanted gene.

toSeq

public ISeq<G> toSeq()

Description copied from interface: Chromosome

Return an unmodifiable sequence of the genes of this chromosome.

Specified by:

toSeq in interface Chromosome<G extends Gene<?,G>>

Returns:

an immutable gene sequence.

isValid

public boolean isValid()

Description copied from interface: Verifiable

Check if this object is valid.

Specified by:

isValid in interface Verifiable

Returns:

true if this object is valid, false otherwise.

iterator

public Iterator<G> iterator()

Specified by:

iterator in interface Iterable<G extends Gene<?,G>>

length

public int length()

Description copied from interface: Chromosome

Returns the length of the Chromosome. The minimal length of a chromosome is one.

Specified by:

length in interface Chromosome<G extends Gene<?,G>>

Returns:

Length of the Chromosome

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