/*
* Encog(tm) Core v3.0 - Java Version
* http://www.heatonresearch.com/encog/
* http://code.google.com/p/encog-java/
* Copyright 2008-2011 Heaton Research, Inc.
*
* 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.
*
* For more information on Heaton Research copyrights, licenses
* and trademarks visit:
* http://www.heatonresearch.com/copyright
*/
package org.encog.ml.genetic.species;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import org.encog.mathutil.randomize.RangeRandomizer;
import org.encog.ml.genetic.genome.Genome;
import org.encog.ml.genetic.population.Population;
/**
* Provides basic functionality for a species.
*/
public class BasicSpecies implements Species, Serializable {
/**
* Serial id.
*/
private static final long serialVersionUID = 1L;
/**
* The age of this species.
*/
private int age;
/**
* The best score.
*/
private double bestScore;
/**
* The number of generations with no improvement.
*/
private int gensNoImprovement;
/**
* The leader.
*/
private Genome leader;
/**
* The list of genomes.
*/
private final List<Genome> members = new ArrayList<Genome>();
/**
* The number of spawns required.
*/
private double spawnsRequired;
/**
* The species id.
*/
private long speciesID;
/**
* The owner class.
*/
private Population population;
/**
* The id of the leader.
*/
private transient long leaderID;
/**
* Default constructor, used mainly for persistence.
*/
public BasicSpecies() {
}
/**
* Construct a species.
*
* @param thePopulation
* The population the species belongs to.
* @param theFirst
* The first genome in the species.
* @param theSpeciesID
* The species id.
*/
public BasicSpecies(final Population thePopulation, final Genome theFirst,
final long theSpeciesID) {
this.population = thePopulation;
this.speciesID = theSpeciesID;
this.bestScore = theFirst.getScore();
this.gensNoImprovement = 0;
this.age = 0;
this.leader = theFirst;
this.spawnsRequired = 0;
this.members.add(theFirst);
}
/**
* Calculate the amount to spawn.
*/
@Override
public final void calculateSpawnAmount() {
this.spawnsRequired = 0;
for (final Genome genome : this.members) {
this.spawnsRequired += genome.getAmountToSpawn();
}
}
/**
* Choose a parent to mate. Choose from the population, determined by the
* survival rate. From this pool, a random parent is chosen.
*
* @return The parent.
*/
@Override
public final Genome chooseParent() {
Genome baby;
// If there is a single member, then choose that one.
if (this.members.size() == 1) {
baby = this.members.get(0);
} else {
// If there are many, then choose the population based on survival
// rate
// and select a random genome.
final int maxIndexSize
= (int) (this.population.getSurvivalRate() * this.members
.size()) + 1;
final int theOne = (int) RangeRandomizer.randomize(0, maxIndexSize);
baby = this.members.get(theOne);
}
return baby;
}
/**
* @return The age of this species.
*/
@Override
public final int getAge() {
return this.age;
}
/**
* @return The best score for this species.
*/
@Override
public final double getBestScore() {
return this.bestScore;
}
/**
* @return The number of generations with no improvement.
*/
@Override
public final int getGensNoImprovement() {
return this.gensNoImprovement;
}
/**
* @return THe leader of this species.
*/
@Override
public final Genome getLeader() {
return this.leader;
}
/**
* @return The members of this species.
*/
@Override
public final List<Genome> getMembers() {
return this.members;
}
/**
* @return The number to spawn.
*/
@Override
public final double getNumToSpawn() {
return this.spawnsRequired;
}
/**
* @return The population that this species belongs to.
*/
public final Population getPopulation() {
return this.population;
}
/**
* @return The spawns required.
*/
@Override
public final double getSpawnsRequired() {
return this.spawnsRequired;
}
/**
* @return The species ID.
*/
@Override
public final long getSpeciesID() {
return this.speciesID;
}
/**
* @return the leaderID
*/
public final long getTempLeaderID() {
return this.leaderID;
}
/**
* Purge all members, increase age by one and count the number of
* generations with no improvement.
*/
@Override
public final void purge() {
this.members.clear();
this.age++;
this.gensNoImprovement++;
this.spawnsRequired = 0;
}
/**
* Set the age of this species.
*
* @param theAge
* The age of this species.
*/
@Override
public final void setAge(final int theAge) {
this.age = theAge;
}
/**
* Set the best score.
*
* @param theBestScore
* The best score.
*/
@Override
public final void setBestScore(final double theBestScore) {
this.bestScore = theBestScore;
}
/**
* Set the number of generations with no improvement.
*
* @param theGensNoImprovement
* The number of generations.
*/
@Override
public final void setGensNoImprovement(final int theGensNoImprovement) {
this.gensNoImprovement = theGensNoImprovement;
}
/**
* Set the leader.
*
* @param theLeader
* The new leader.
*/
@Override
public final void setLeader(final Genome theLeader) {
this.leader = theLeader;
}
/**
* @param thePopulation
* the population to set
*/
public final void setPopulation(final Population thePopulation) {
this.population = thePopulation;
}
/**
* Set the number of spawns required.
*
* @param theSpawnsRequired
* The number of spawns required.
*/
@Override
public final void setSpawnsRequired(final double theSpawnsRequired) {
this.spawnsRequired = theSpawnsRequired;
}
/**
* Set the species id.
*
* @param i
* The new species id.
*/
public final void setSpeciesID(final int i) {
this.speciesID = i;
}
/**
* Set the leader id. This value is not persisted, it is used only for
* loading.
*
* @param theLeaderID
* the leaderID to set
*/
public final void setTempLeaderID(final long theLeaderID) {
this.leaderID = theLeaderID;
}
}