org.jenetix

Class BigIntegerGene

java.lang.Object

org.jenetix.BigIntegerGene

All Implemented Interfaces:

Serializable, Comparable<BigIntegerGene>, BoundedGene<BigInteger,BigIntegerGene>, Gene<BigInteger,BigIntegerGene>, NumericGene<BigInteger,BigIntegerGene>, Factory<BigIntegerGene>, Mean<BigIntegerGene>, Verifiable

public final class BigIntegerGene
extends Object
implements NumericGene<BigInteger,BigIntegerGene>, Mean<BigIntegerGene>, Serializable

Numeric chromosome implementation which holds an arbitrary sized 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:

3.5

Version:

3.5

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BigInteger	getAllele()
BigInteger	getMax()
BigInteger	getMin()
int	hashCode()
BigIntegerGene	mean(BigIntegerGene that)
BigIntegerGene	newInstance()
BigIntegerGene	newInstance(BigInteger value)
BigIntegerGene	newInstance(Number number)
static BigIntegerGene	of(BigInteger min, BigInteger max) Create a new random BigIntegerGene.
static BigIntegerGene	of(BigInteger value, BigInteger min, BigInteger max) Create a new random BigIntegerGene with the given value and the given range.
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

compareTo, isValid

Methods inherited from interface org.jenetics.util.Factory

instances

Method Detail

getAllele

public BigInteger getAllele()

Specified by:

getAllele in interface Gene<BigInteger,BigIntegerGene>

getMin

public BigInteger getMin()

Specified by:

getMin in interface BoundedGene<BigInteger,BigIntegerGene>

getMax

public BigInteger getMax()

Specified by:

getMax in interface BoundedGene<BigInteger,BigIntegerGene>

mean

public BigIntegerGene mean(BigIntegerGene that)

Specified by:

mean in interface Mean<BigIntegerGene>

newInstance

public BigIntegerGene newInstance(Number number)

Specified by:

newInstance in interface NumericGene<BigInteger,BigIntegerGene>

newInstance

public BigIntegerGene newInstance(BigInteger value)

Specified by:

newInstance in interface BoundedGene<BigInteger,BigIntegerGene>

Specified by:

newInstance in interface Gene<BigInteger,BigIntegerGene>

newInstance

public BigIntegerGene newInstance()

Specified by:

newInstance in interface Gene<BigInteger,BigIntegerGene>

Specified by:

newInstance in interface Factory<BigIntegerGene>

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 BigIntegerGene of(BigInteger value,
                                BigInteger min,
                                BigInteger max)

Create a new random BigIntegerGene 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 BoundedGene.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 BigIntegerGene

Throws:

NullPointerException - if one of the arguments is null

of

public static BigIntegerGene of(BigInteger min,
                                BigInteger max)

Create a new random BigIntegerGene. It is guaranteed that the value of the BigIntegerGene 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 BigIntegerGene

Throws:

NullPointerException - if one of the arguments is null