io.jenetics

Interface Chromosome<G extends Gene<?,G>>

All Superinterfaces:

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

All Known Subinterfaces:

BoundedChromosome<A,G>, NumericChromosome<N,G>

All Known Implementing Classes:

AbstractChromosome, AnyChromosome, BitChromosome, CharacterChromosome, DoubleChromosome, IntegerChromosome, LongChromosome, PermutationChromosome

public interface Chromosome<G extends Gene<?,G>>
extends Verifiable, Iterable<G>, Factory<Chromosome<G>>

A chromosome consists of one or more genes. It also provides a factory method for creating new, random chromosome instances of the same type and the same constraint.

API Note: Implementations of the Chromosome interface must be immutable and guarantee an efficient random access (O(1)) to the genes. A Chromosome must contains at least one Gene.

Since:

1.0

Version:

3.7

Author:

Franz Wilhelmstötter

See Also:

Wikipdida: Chromosome, Genotype, Gene

Method Summary

Modifier and Type	Method and Description
default <C extends Chromosome<G>> C	as(Class<C> type) Casts this Chromosome to an instance of type C.
default G	getGene() Return the first gene of this chromosome.
G	getGene(int index) Return the gene on the specified index.
int	length() Returns the length of the Chromosome.
Chromosome<G>	newInstance(ISeq<G> genes) A factory method which creates a new Chromosome of specific type and the given genes.
default Stream<G>	stream() Returns a sequential Stream of genes with this chromosome as its source.
ISeq<G>	toSeq() Return an unmodifiable sequence of the genes of this chromosome.

Methods inherited from interface io.jenetics.util.Verifiable

isValid

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface io.jenetics.util.Factory

instances, newInstance

Method Detail

newInstance

Chromosome<G> newInstance(ISeq<G> genes)

A factory method which creates a new Chromosome of specific type and the given genes.

Parameters:

genes - the genes of the new chromosome. The given genes array is not copied.

Returns:

A new Chromosome of the same type with the given genes.

Throws:

NullPointerException - if the given genes are null.

IllegalArgumentException - if the length of the given gene sequence is smaller than one.

getGene

default G getGene()

Return the first gene of this chromosome. Each chromosome must contain at least one gene.

Returns:

the first gene of this chromosome.

getGene

G getGene(int index)

Return the gene on the specified index.

Parameters:

index - The gene index.

Returns:

the wanted gene.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 1 || index >= length()).

length

int length()

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

Returns:

Length of the Chromosome

toSeq

ISeq<G> toSeq()

Return an unmodifiable sequence of the genes of this chromosome.

Returns:

an immutable gene sequence.

as

default <C extends Chromosome<G>> C as(Class<C> type)

Casts this Chromosome to an instance of type C. This is a convenient method for an ordinary cast and allows seamless method-chaining. Instead of

final Genotype<BitGene> gt = ... final int count = ((BitChromosome)gt.getChromosome()).bitCount()

you can write

final Genotype<BitGene> gt = ... final int count = gt.getChromosome() .as(BitChromosome.class) .bitCount()

This may lead to a more elegant programming style in some cases.

Type Parameters:

C - the target chromosome type

Parameters:

type - the target type class

Returns:

this chromosome casted as C

Throws:

NullPointerException - if the target type class is null

ClassCastException - if this chromosome can't be casted to a chromosome of type C

Since:

3.7

stream

default Stream<G> stream()

Returns a sequential Stream of genes with this chromosome as its source.

Returns:

a sequential Stream of genes

Since:

3.3