org.jenetics

Class IntegerGene

java.lang.Object

org.jenetics.IntegerGene

All Implemented Interfaces:

Serializable, Comparable<IntegerGene>, BoundedGene<Integer,IntegerGene>, Gene<Integer,IntegerGene>, NumericGene<Integer,IntegerGene>, Factory<IntegerGene>, Mean<IntegerGene>, Verifiable

public final class IntegerGene
extends Object
implements NumericGene<Integer,IntegerGene>, Mean<IntegerGene>, Comparable<IntegerGene>, Serializable

NumericGene implementation which holds a 32 bit integer number.

This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of IntegerGene may have unpredictable results and should be avoided.

Since:

2.0

Version:

3.2

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(IntegerGene other)
boolean	equals(Object obj)
A	getAllele() Return the allele of this gene.
A	getMax() Return the allowed max value.
A	getMin() Return the allowed min value.
int	hashCode()
boolean	isValid() Check if this object is valid.
IntegerGene	mean(IntegerGene that) Return the (usually arithmetic) mean value of this and that.
IntegerGene	newInstance() Return a new, random gene with the same type and with the same constraints than this gene.
IntegerGene	newInstance(Number number) Create a new gene from the given value and the current bounds.
static IntegerGene	of(int min, int max) Create a new random IntegerGene.
static IntegerGene	of(int value, int min, int max) Create a new random IntegerGene with the given value and the given range.
static IntegerGene	of(int value, IntRange range) Create a new random IntegerGene with the given value and the given range.
static IntegerGene	of(IntRange range) Create a new random IntegerGene.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jenetics.NumericGene

byteValue, doubleValue, floatValue, intValue, longValue, shortValue

Methods inherited from interface org.jenetics.BoundedGene

getMax, getMin, isValid

Methods inherited from interface org.jenetics.Gene

getAllele

Methods inherited from interface org.jenetics.util.Factory

instances

Method Detail

compareTo

public int compareTo(IntegerGene other)

Specified by:

compareTo in interface Comparable<IntegerGene>

Specified by:

compareTo in interface BoundedGene<Integer,IntegerGene>

of

public static IntegerGene of(int value,
                             int min,
                             int max)

Create a new random IntegerGene with the given value and the given range. If the value isn't within the interval [min, max], no exception is thrown. In this case the method AbstractBoundedGene.isValid() returns false.

Parameters:

value - the value of the gene.

min - the minimal valid value of this gene (inclusively).

max - the maximal valid value of this gene (inclusively).

Returns:

a new random IntegerGene

of

public static IntegerGene of(int value,
                             IntRange range)

Create a new random IntegerGene with the given value and the given range. If the value isn't within the interval [min, max], no exception is thrown. In this case the method AbstractBoundedGene.isValid() returns false.

Parameters:

value - the value of the gene.

range - the integer range to use

Returns:

a new random IntegerGene

Throws:

NullPointerException - if the given range is null.

Since:

3.2

of

public static IntegerGene of(int min,
                             int max)

Create a new random IntegerGene. It is guaranteed that the value of the IntegerGene lies in the interval [min, max].

Parameters:

min - the minimal valid value of this gene (inclusively).

max - the maximal valid value of this gene (inclusively).

Returns:

a new random IntegerGene

of

public static IntegerGene of(IntRange range)

Create a new random IntegerGene. It is guaranteed that the value of the IntegerGene lies in the interval [min, max].

Parameters:

range - the integer range to use

Returns:

a new random IntegerGene

Throws:

NullPointerException - if the given range is null.

Since:

3.2

newInstance

public IntegerGene newInstance(Number number)

Description copied from interface: BoundedGene

Create a new gene from the given value and the current bounds.

Specified by:

newInstance in interface NumericGene<Integer,IntegerGene>

Parameters:

number - the value of the new gene.

Returns:

a new gene with the given value.

newInstance

public IntegerGene 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<Integer,IntegerGene>

Specified by:

newInstance in interface Factory<IntegerGene>

Returns:

a new instance of type T

mean

public IntegerGene mean(IntegerGene that)

Description copied from interface: Mean

Return the (usually arithmetic) mean value of this and that. For NumericGenes the mean is the arithmetic mean.

Specified by:

mean in interface Mean<IntegerGene>

Parameters:

that - the second value for calculating the mean.

Returns:

the mean value of this and that.

getAllele

public A getAllele()

Description copied from interface: Gene

Return the allele of this gene.

Specified by:

getAllele in interface Gene<A extends Comparable<? super A>,G extends org.jenetics.AbstractBoundedGene<A,G>>

Returns:

the allele of this gene.

getMin

public A getMin()

Description copied from interface: BoundedGene

Return the allowed min value.

Specified by:

getMin in interface BoundedGene<A extends Comparable<? super A>,G extends org.jenetics.AbstractBoundedGene<A,G>>

Returns:

The allowed min value.

getMax

public A getMax()

Description copied from interface: BoundedGene

Return the allowed max value.

Specified by:

getMax in interface BoundedGene<A extends Comparable<? super A>,G extends org.jenetics.AbstractBoundedGene<A,G>>

Returns:

The allowed max value.

isValid

public boolean isValid()

Description copied from interface: Verifiable

Check if this object is valid.

Specified by:

isValid in interface BoundedGene<A extends Comparable<? super A>,G extends org.jenetics.AbstractBoundedGene<A,G>>

Specified by:

isValid in interface Verifiable

Returns:

true if this object is valid, false otherwise.

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