io.jenetics

Class LongGene

java.lang.Object

io.jenetics.LongGene

All Implemented Interfaces:

BoundedGene<Long,LongGene>, Gene<Long,LongGene>, NumericGene<Long,LongGene>, Factory<LongGene>, Mean<LongGene>, Verifiable, Serializable, Comparable<LongGene>

public final class LongGene
extends Object
implements NumericGene<Long,LongGene>, Mean<LongGene>, Comparable<LongGene>, Serializable

NumericGene implementation which holds a 64 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 LongGene may have unpredictable results and should be avoided.

Since:

1.6

Version:

4.0

Author:

Franz Wilhelmstötter

See Also:

LongChromosome, Serialized Form

Implementation Requirements:

This class is immutable and thread-safe.

Method Summary

Modifier and Type	Method and Description
int	compareTo(LongGene 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.
LongGene	mean(LongGene that) Return the (usually arithmetic) mean value of this and that.
LongGene	newInstance() Return a new, random gene with the same type and with the same constraints than this gene.
LongGene	newInstance(Number number) Create a new gene from the given value and the current bounds.
static LongGene	of(long min, long max) Create a new random LongGene.
static LongGene	of(long value, long min, long max) Create a new random LongGene with the given value and the given range.
static LongGene	of(long value, LongRange range) Create a new random LongGene with the given value and the given range.
static LongGene	of(LongRange range) Create a new random LongGene.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jenetics.NumericGene

byteValue, doubleValue, floatValue, intValue, longValue, shortValue

Methods inherited from interface io.jenetics.BoundedGene

getMax, getMin, isValid

Methods inherited from interface io.jenetics.Gene

getAllele

Methods inherited from interface io.jenetics.util.Factory

instances

Method Detail

compareTo

public int compareTo(LongGene other)

Specified by:

compareTo in interface BoundedGene<Long,LongGene>

Specified by:

compareTo in interface Comparable<LongGene>

of

public static LongGene of(long value,
                          long min,
                          long max)

Create a new random LongGene 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 LongGene with the given parameters.

of

public static LongGene of(long value,
                          LongRange range)

Create a new random LongGene 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 long range to use

Returns:

a new random LongGene

Throws:

NullPointerException - if the given range is null.

Since:

3.2

of

public static LongGene of(long min,
                          long max)

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

of

public static LongGene of(LongRange range)

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

Parameters:

range - the long range to use

Returns:

a new random LongGene

Throws:

NullPointerException - if the given range is null.

Since:

3.2

newInstance

public LongGene 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<Long,LongGene>

Parameters:

number - the value of the new gene.

Returns:

a new gene with the given value.

newInstance

public LongGene 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<Long,LongGene>

Specified by:

newInstance in interface Factory<LongGene>

Returns:

a new instance of type T

mean

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

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 io.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 io.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 io.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 io.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