EnumGene (Jenetics 3.0.0)

java.lang.Object
- org.jenetics.EnumGene<A>

All Implemented Interfaces:

Serializable, Comparable<EnumGene<A>>, Gene<A,EnumGene<A>>, Factory<EnumGene<A>>, Verifiable
```
public final class EnumGene<A>
extends Object
implements Gene<A,EnumGene<A>>, Comparable<EnumGene<A>>
```
Gene which holds enumerable (countable) genes. Will be used for combinatorial problems in combination with the PermutationChromosome.
The following code shows how to create a combinatorial genotype factory which can be used when creating an Engine instance.
final ISeq<Integer> alleles = ISeq.of(1, 2, 3, 4, 5, 6, 7, 8); final Factory<Genotype<EnumGene<Integer>>> gtf = Genotype.of( PermutationChromosome.of(alleles) );
The following code shows the assurances of the EnumGene.
final ISeq<Integer> alleles = ISeq.of(1, 2, 3, 4, 5, 6, 7, 8); final EnumGene<Integer> gene = new EnumGene<>(5, alleles); assert(gene.getAlleleIndex() == 5); assert(gene.getAllele() == gene.getValidAlleles().get(5)); assert(gene.getValidAlleles() == alleles);

Since:

1.0

Version:

2.0 — $Date: 2014-12-28 $

Author:

Franz Wilhelmstötter

See Also:

PermutationChromosome, Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(EnumGene<A> gene)`
`boolean`	`equals(Object obj)`
`A`	`getAllele()` Return the allele of this gene.
`int`	`getAlleleIndex()` Return the index of the allele this gene is representing.
`ISeq<A>`	`getValidAlleles()` Return sequence of the valid alleles where this gene is a part of.
`int`	`hashCode()`
`boolean`	`isValid()` Check if this object is valid.
`EnumGene<A>`	`newInstance()` Return a new, random gene with the same type and with the same constraints than this gene.
`EnumGene<A>`	`newInstance(A value)` Create a new gene from the given `value` and the gene context.
`static <A> EnumGene<A>`	`of(A... validAlleles)` Return a new enum gene with an allele randomly chosen from the given valid alleles.
`static <A> EnumGene<A>`	`of(int alleleIndex, A... validAlleles)` Create a new enum gene from the given valid genes and the chosen allele index.
`static <A> EnumGene<A>`	`of(ISeq<? extends A> validAlleles)` Return a new enum gene with an allele randomly chosen from the given valid alleles.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jenetics.util.Factory
instances

- Method Detail
  - getValidAlleles
```
public ISeq<A> getValidAlleles()
```
    Return sequence of the valid alleles where this gene is a part of.
    
    Returns:
    
    the sequence of the valid alleles.
  - getAlleleIndex
```
public int getAlleleIndex()
```
    Return the index of the allele this gene is representing.
    
    Returns:
    
    the index of the allele this gene is representing.
  - getAllele
```
public A getAllele()
```
    Description copied from interface: Gene
    
    Return the allele of this gene.
    
    Specified by:
    
    getAllele in interface Gene<A,EnumGene<A>>
    
    Returns:
    
    the allele of this gene.
  - 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.
  - newInstance
```
public EnumGene<A> newInstance()
```
    Description copied from interface: Gene
    
    Return a new, random gene with the same type and with the same constraints than this gene. For all genes returned by this method holds gene.getClass() == gene.newInstance().getClass(). Implementations of this method has to use the Random object which can be fetched from the RandomRegistry.
    
    Specified by:
    
    newInstance in interface Gene<A,EnumGene<A>>
    
    Specified by:
    
    newInstance in interface Factory<EnumGene<A>>
    
    Returns:
    
    a new instance of type T
  - newInstance
```
public EnumGene<A> newInstance(A value)
```
    Create a new gene from the given value and the gene context.
    
    Specified by:
    
    newInstance in interface Gene<A,EnumGene<A>>
    
    Parameters:
    
    value - the value of the new gene.
    
    Returns:
    
    a new gene with the given value.
    
    Since:
    
    1.6
  - compareTo
```
public int compareTo(EnumGene<A> gene)
```
    Specified by:
    
    compareTo in interface Comparable<EnumGene<A>>
  - 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 <A> EnumGene<A> of(ISeq<? extends A> validAlleles)
```
    Return a new enum gene with an allele randomly chosen from the given valid alleles.
    
    Type Parameters:
    
    A - the allele type
    
    Parameters:
    
    validAlleles - the sequence of valid alleles.
    
    Returns:
    
    a new EnumGene with the given parameter
    
    Throws:
    
    IllegalArgumentException - if the give valid alleles sequence is empty
    
    NullPointerException - if the valid alleles seq is null.
  - of
```
@SafeVarargs
public static <A> EnumGene<A> of(int alleleIndex,
                                              A... validAlleles)
```
    Create a new enum gene from the given valid genes and the chosen allele index.
    
    Type Parameters:
    
    A - the allele type
    
    Parameters:
    
    alleleIndex - the index of the allele for this gene.
    
    validAlleles - the array of valid alleles.
    
    Returns:
    
    a new EnumGene with the given parameter
    
    Throws:
    
    IllegalArgumentException - if the give valid alleles array is empty of the allele index is out of range.
  - of
```
@SafeVarargs
public static <A> EnumGene<A> of(A... validAlleles)
```
    Return a new enum gene with an allele randomly chosen from the given valid alleles.
    
    Type Parameters:
    
    A - the allele type
    
    Parameters:
    
    validAlleles - the array of valid alleles.
    
    Returns:
    
    a new EnumGene with the given parameter
    
    Throws:
    
    IllegalArgumentException - if the give valid alleles array is empty

Class EnumGene<A>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jenetics.util.Factory

Method Detail

getValidAlleles

getAlleleIndex

getAllele

isValid

newInstance

newInstance

compareTo

hashCode

equals

toString

of

of

of