Module io.jenetics.ext

Package io.jenetics.ext

Class BigIntegerGene

java.lang.Object

io.jenetics.ext.BigIntegerGene

All Implemented Interfaces:

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

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:

6.0

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
BigInteger	allele()	Return the allele of this gene.
boolean	equals(Object obj)
int	hashCode()
BigInteger	max()	Return the allowed max value.
BigIntegerGene	mean(BigIntegerGene that)	Return the (usually arithmetic) mean value of this and that.
BigInteger	min()	Return the allowed min value.
BigIntegerGene	newInstance()	Return a new, random gene with the same type and with the same constraints as this gene.
BigIntegerGene	newInstance(Number number)	Create a new gene from the given value and the current bounds.
BigIntegerGene	newInstance(BigInteger value)	Create a new gene from the given value and the current bounds.
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 io.jenetics.BoundedGene

compareTo, isValid, max, min

Methods inherited from interface io.jenetics.util.Factory

instances

Methods inherited from interface io.jenetics.NumericGene

byteValue, doubleValue, floatValue, intValue, longValue, shortValue

Methods inherited from interface io.jenetics.util.Self

self

Method Details

allele

public BigInteger allele()

Description copied from interface: Gene

Return the allele of this gene.

Specified by:

allele in interface Gene<BigInteger,BigIntegerGene>

Returns:

the allele of this gene.

min

public BigInteger min()

Description copied from interface: BoundedGene

Return the allowed min value.

Specified by:

min in interface BoundedGene<BigInteger,BigIntegerGene>

Returns:

The allowed min value.

max

public BigInteger max()

Description copied from interface: BoundedGene

Return the allowed max value.

Specified by:

max in interface BoundedGene<BigInteger,BigIntegerGene>

Returns:

The allowed max value.

mean

public BigIntegerGene mean(BigIntegerGene 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<BigIntegerGene>

Parameters:

that - the second value for calculating the mean.

Returns:

the mean value of this and that.

newInstance

public BigIntegerGene 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<BigInteger,BigIntegerGene>

Parameters:

number - the value of the new gene.

Returns:

a new gene with the given value.

newInstance

public BigIntegerGene newInstance(BigInteger value)

Description copied from interface: BoundedGene

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

Specified by:

newInstance in interface BoundedGene<BigInteger,BigIntegerGene>

Specified by:

newInstance in interface Gene<BigInteger,BigIntegerGene>

Parameters:

value - the value of the new gene.

Returns:

a new gene with the given value.

newInstance

public BigIntegerGene newInstance()

Description copied from interface: Gene

Return a new, random gene with the same type and with the same constraints as this gene. For all genes returned by this method holds gene.getClass() == gene.newInstance().getClass(). Implementations of this method have to use the Random object which can be fetched from the RandomRegistry.

Specified by:

newInstance in interface Factory<BigIntegerGene>

Specified by:

newInstance in interface Gene<BigInteger,BigIntegerGene>

Returns:

a new instance of type T

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 (exclusively).

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 (exclusively).

Returns:

a new random BigIntegerGene

Throws:

NullPointerException - if one of the arguments is null