IntegerGene (Jenetics 5.1.0)

java.lang.Object
- io.jenetics.IntegerGene

All Implemented Interfaces:

BoundedGene<Integer,IntegerGene>, Gene<Integer,IntegerGene>, NumericGene<Integer,IntegerGene>, Factory<IntegerGene>, Mean<IntegerGene>, Verifiable, Serializable, Comparable<IntegerGene>
```
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:

5.0

Author:

Franz Wilhelmstötter

See Also:

IntegerChromosome, Serialized Form

Implementation Note:

This class is immutable and thread-safe.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte`	`byteValue()` Returns the value of the specified gene as an byte.
`int`	`compareTo(IntegerGene other)`
`double`	`doubleValue()` Returns the value of the specified gene as an double.
`boolean`	`equals(Object obj)`
`float`	`floatValue()` Returns the value of the specified gene as an float.
`Integer`	`getAllele()` Return the allele of this gene.
`Integer`	`getMax()` Return the allowed max value.
`Integer`	`getMin()` Return the allowed min value.
`int`	`hashCode()`
`int`	`intValue()` Returns the value of the specified gene as an int.
`boolean`	`isValid()` Check if this object is valid.
`long`	`longValue()` Returns the value of the specified gene as an long.
`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(int value)` Create a new gene from the given `value` and the gene context.
`IntegerGene`	`newInstance(Integer number)` Create a new gene from the given `value` and the current bounds.
`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`.
`IntRange`	`range()` Return the range of `this` gene.
`short`	`shortValue()` Returns the value of the specified gene as an short.
`String`	`toString()`

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

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

- Method Detail
  - getAllele
```
public Integer getAllele()
```
    Description copied from interface: Gene
    
    Return the allele of this gene.
    
    Specified by:
    
    getAllele in interface Gene<Integer,IntegerGene>
    
    Returns:
    
    the allele of this gene.
  - getMin
```
public Integer getMin()
```
    Description copied from interface: BoundedGene
    
    Return the allowed min value.
    
    Specified by:
    
    getMin in interface BoundedGene<Integer,IntegerGene>
    
    Returns:
    
    The allowed min value.
  - getMax
```
public Integer getMax()
```
    Description copied from interface: BoundedGene
    
    Return the allowed max value.
    
    Specified by:
    
    getMax in interface BoundedGene<Integer,IntegerGene>
    
    Returns:
    
    The allowed max value.
  - range
```
public IntRange range()
```
    Return the range of this gene.
    
    Returns:
    
    the range of this gene
    
    Since:
    
    4.4
  - byteValue
```
public byte byteValue()
```
    Description copied from interface: NumericGene
    
    Returns the value of the specified gene as an byte. This may involve rounding or truncation.
    
    Specified by:
    
    byteValue in interface NumericGene<Integer,IntegerGene>
    
    Returns:
    
    the numeric value represented by this object after conversion to type byte.
  - shortValue
```
public short shortValue()
```
    Description copied from interface: NumericGene
    
    Returns the value of the specified gene as an short. This may involve rounding or truncation.
    
    Specified by:
    
    shortValue in interface NumericGene<Integer,IntegerGene>
    
    Returns:
    
    the numeric value represented by this object after conversion to type short.
  - intValue
```
public int intValue()
```
    Description copied from interface: NumericGene
    
    Returns the value of the specified gene as an int. This may involve rounding or truncation.
    
    Specified by:
    
    intValue in interface NumericGene<Integer,IntegerGene>
    
    Returns:
    
    the numeric value represented by this object after conversion to type int.
  - longValue
```
public long longValue()
```
    Description copied from interface: NumericGene
    
    Returns the value of the specified gene as an long. This may involve rounding or truncation.
    
    Specified by:
    
    longValue in interface NumericGene<Integer,IntegerGene>
    
    Returns:
    
    the numeric value represented by this object after conversion to type long.
  - floatValue
```
public float floatValue()
```
    Description copied from interface: NumericGene
    
    Returns the value of the specified gene as an float. This may involve rounding or truncation.
    
    Specified by:
    
    floatValue in interface NumericGene<Integer,IntegerGene>
    
    Returns:
    
    the numeric value represented by this object after conversion to type float.
  - doubleValue
```
public double doubleValue()
```
    Description copied from interface: NumericGene
    
    Returns the value of the specified gene as an double. This may involve rounding or truncation.
    
    Specified by:
    
    doubleValue in interface NumericGene<Integer,IntegerGene>
    
    Returns:
    
    the numeric value represented by this object after conversion to type double.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: Verifiable
    
    Check if this object is valid.
    
    Specified by:
    
    isValid in interface BoundedGene<Integer,IntegerGene>
    
    Specified by:
    
    isValid in interface Verifiable
    
    Returns:
    
    true if this object is valid, false otherwise.
  - compareTo
```
public int compareTo(IntegerGene other)
```
    Specified by:
    
    compareTo in interface BoundedGene<Integer,IntegerGene>
    
    Specified by:
    
    compareTo in interface Comparable<IntegerGene>
  - 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.
  - newInstance
```
public IntegerGene newInstance(int value)
```
    Create a new gene from the given value and the gene context.
    
    Parameters:
    
    value - the value of the new gene.
    
    Returns:
    
    a new gene with the given value.
    
    Since:
    
    5.0
  - newInstance
```
public IntegerGene newInstance(Integer number)
```
    Description copied from interface: BoundedGene
    
    Create a new gene from the given value and the current bounds.
    
    Specified by:
    
    newInstance in interface BoundedGene<Integer,IntegerGene>
    
    Specified by:
    
    newInstance in interface Gene<Integer,IntegerGene>
    
    Parameters:
    
    number - the value of the new gene.
    
    Returns:
    
    a new gene with the given value.
  - 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
  - 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 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 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 IntegerGene with the given value
  - 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 isValid() returns false.
    
    Parameters:
    
    value - the value of the gene.
    
    range - the integer range to use
    
    Returns:
    
    a new IntegerGene with the give value
    
    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

Class IntegerGene

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.jenetics.util.Factory

Method Detail

getAllele

getMin

getMax

range

byteValue

shortValue

intValue

longValue

floatValue

doubleValue

isValid

compareTo

mean

newInstance

newInstance

newInstance

newInstance

hashCode

equals

toString

of

of

of

of