CharacterGene.java
/*
* Java Genetic Algorithm Library (@__identifier__@).
* Copyright (c) @__year__@ Franz Wilhelmstötter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Author:
* Franz Wilhelmstötter (franz.wilhelmstoetter@gmx.at)
*/
package org.jenetics;
import static java.util.Objects.requireNonNull;
import static org.jenetics.util.object.eq;
import static org.jenetics.util.object.hashCodeOf;
import java.util.Random;
import javolution.context.ObjectFactory;
import javolution.lang.Realtime;
import javolution.text.Text;
import javolution.xml.XMLFormat;
import javolution.xml.XMLSerializable;
import javolution.xml.stream.XMLStreamException;
import org.jenetics.util.Array;
import org.jenetics.util.CharSeq;
import org.jenetics.util.Factory;
import org.jenetics.util.Function;
import org.jenetics.util.RandomRegistry;
/**
* Character gene implementation.
*
* @author <a href="mailto:franz.wilhelmstoetter@gmx.at">Franz Wilhelmstötter</a>
* @since 1.0
* @version 1.5 — <em>$Date: 2013-12-02 $</em>
*/
public final class CharacterGene
implements
Gene<Character, CharacterGene>,
Comparable<CharacterGene>,
Realtime,
XMLSerializable
{
private static final long serialVersionUID = 1L;
/**
* The default character set used by this gene.
*/
public static final CharSeq DEFAULT_CHARACTERS = new CharSeq(
CharSeq.expand("0-9a-zA-Z") +
" !\"$%&/()=?`{[]}\\+~*#';.:,-_<>|@^'"
);
private CharSeq _validCharacters;
private Character _character;
private Boolean _valid;
CharacterGene() {
}
@Override
public boolean isValid() {
if (_valid == null) {
_valid = _validCharacters.contains(_character);
}
return _valid;
}
@Override
public Character getAllele() {
return _character;
}
/**
* Return the {@code char} value of this character gene.
*
* @return the {@code char} value.
*/
public char charValue() {
return _character;
}
/**
* Test, if the given character is valid.
*
* @param c The character to test.
* @return true if the character is valid, false otherwise.
*/
public boolean isValidCharacter(final Character c) {
return _validCharacters.contains(c);
}
/**
* Retunr a (unmodifiable) set of valid characters.
*
* @return the {@link CharSeq} of valid characters.
*/
public CharSeq getValidCharacters() {
return _validCharacters;
}
@Override
public CharacterGene copy() {
final CharacterGene gene = valueOf(_character, _validCharacters);
gene._valid = _valid;
return gene;
}
/**
* @see java.lang.Character#compareTo(java.lang.Character)
* @param that The other gene to compare.
* @return the value 0 if the argument Character is equal to this Character;
* a value less than 0 if this Character is numerically less than
* the Character argument; and a value greater than 0 if this
* Character is numerically greater than the Character argument
* (unsigned comparison). Note that this is strictly a numerical
* comparison; it is not local-dependent.
*/
@Override
public int compareTo(final CharacterGene that) {
return getAllele().compareTo(that.getAllele());
}
/**
* Return the {@link Factory} view of this gene.
*
* @return the {@link Factory} view of this gene.
*
* @deprecated No longer needed after adding new factory methods to the
* {@link Array} class.
*/
@Deprecated
Factory<CharacterGene> asFactory() {
return this;
}
@Override
public int hashCode() {
return hashCodeOf(getClass()).and(_character).and(_validCharacters).value();
}
@Override
public boolean equals(final Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof CharacterGene)) {
return false;
}
CharacterGene gene = (CharacterGene)obj;
return eq(_character, gene._character) &&
eq(_validCharacters, gene._validCharacters);
}
@Override
public String toString() {
return _character.toString();
}
@Override
public Text toText() {
return Text.valueOf(_character);
}
/* *************************************************************************
* Property access methods.
* ************************************************************************/
/**
* Converter for accessing the allele from a given gene.
*/
public static final Function<CharacterGene, Character> Allele =
new Function<CharacterGene, Character>() {
@Override public Character apply(final CharacterGene value) {
return value._character;
}
};
/**
* Converter for accessing the valid characters from a given gene.
*/
public static final Function<CharacterGene, CharSeq> ValidCharacters =
new Function<CharacterGene, CharSeq>() {
@Override public CharSeq apply(final CharacterGene value) {
return value._validCharacters;
}
};
/* *************************************************************************
* Factory methods
* ************************************************************************/
@Override
public CharacterGene newInstance() {
return valueOf(_validCharacters);
}
/**
* Create a new character gene from the given character. If the character
* is not within the {@link #getValidCharacters()}, an invalid gene will be
* created.
*
* @param character the character value of the created gene.
* @return a new character gene.
* @throws NullPointerException if the given {@code character} is
* {@code null}.
*/
public CharacterGene newInstance(final Character character) {
return valueOf(character, _validCharacters);
}
/* *************************************************************************
* Static object creation methods
* ************************************************************************/
private static final ObjectFactory<CharacterGene>
FACTORY = new ObjectFactory<CharacterGene>() {
@Override
protected CharacterGene create() {
return new CharacterGene();
}
};
/**
* Create a new CharacterGene with a randomly chosen character from the
* set of valid characters.
*
* @param validCharacters the valid characters for this gene.
* @return a new valid, <em>random</em> gene,
* @throws NullPointerException if the {@code validCharacters} are
* {@code null}.
*/
public static CharacterGene valueOf(final CharSeq validCharacters) {
final Random random = RandomRegistry.getRandom();
int pos = random.nextInt(validCharacters.length());
final CharacterGene gene = valueOf(validCharacters.charAt(pos), validCharacters);
gene._valid = true;
return gene;
}
/**
* Create a new character gene from the given character. If the character
* is not within the {@link #DEFAULT_CHARACTERS}, an invalid gene will be
* created.
*
* @param character the character value of the created gene.
* @return a new character gene.
* @throws NullPointerException if the given {@code character} is
* {@code null}.
*/
public static CharacterGene valueOf(final Character character) {
return valueOf(character, DEFAULT_CHARACTERS);
}
public static CharacterGene valueOf() {
final Random random = RandomRegistry.getRandom();
final int index = random.nextInt(DEFAULT_CHARACTERS.length());
return valueOf(DEFAULT_CHARACTERS.charAt(index));
}
/**
* Create a new CharacterGene from the give character.
*
* @param character The allele.
* @throws NullPointerException if one of the arguments is {@code null}.
* @throws IllegalArgumentException if the {@code validCharacters} are empty.
*/
public static CharacterGene valueOf(
final Character character,
final CharSeq validCharacters
) {
requireNonNull(character, "Character");
requireNonNull(validCharacters, "Valid characters");
final CharacterGene gene = FACTORY.object();
gene._character = character;
gene._validCharacters = validCharacters;
return gene;
}
/* *************************************************************************
* XML object serialization
* ************************************************************************/
static final XMLFormat<CharacterGene>
XML = new XMLFormat<CharacterGene>(CharacterGene.class)
{
private static final String VALID_CHARS = "valid-characters";
@Override
public CharacterGene newInstance(
final Class<CharacterGene> cls, final InputElement xml
)
throws XMLStreamException
{
final String validCharacters = xml.getAttribute(
VALID_CHARS,
DEFAULT_CHARACTERS.toString()
);
final String character = xml.getText().toString();
return CharacterGene.valueOf(character.charAt(0), new CharSeq(validCharacters));
}
@Override
public void write(final CharacterGene gene, final OutputElement xml)
throws XMLStreamException
{
xml.setAttribute(VALID_CHARS, gene.getValidCharacters().toString());
xml.addText(gene._character.toString());
}
@Override
public void read(final InputElement element, final CharacterGene gene) {
}
};
}