jas.ai.ga
Class GARule

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.bitvector.BitVector
          jas.ai.ga.GARule

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class GARule
extends cern.colt.bitvector.BitVector
implements java.lang.Comparable, java.lang.Cloneable

A genetic element of population. It is based on cern.colt.bitvector.BitVector from COLT library.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa, Gianluigi Ferraris

See Also:

Serialized Form

Constructor Summary

GARule(int stringLength)
Create a new rule with given number of bits and id = 0.

GARule(int id, int stringLength)
Create a new rule with given number of bits and id.

Method Summary

void	addCopy() Increase the number of copies.
void	clear() Empty the bit string and put each parameter to its default value.
void	clear(int id) Empty the bit string and put each parameter to its default value.
void	clear(int id, int stringLength) Empty the bit string and put each parameter to its default value.
java.lang.Object	clone() Create a bitwise copy of the object.
int	compareTo(java.lang.Object o) Compare the fitness value of two rules returning an ordered signed value.
void	copyFromGenoma(GARule sourceRule) Replace current genoma with the one of the given rule.
void	copyFromRule(GARule sourceRule) Replace current rule with the given one.
void	crossWithRule(GARule sourceRule, int crossPoint) WARNING: To be tested.
void	decreaseFitness(double decrement) Decrease the current fitness value.
void	flip(int bitIndex) Flip the state of a bit.
int	getCopies() Return the number of copies.
double	getFitness() Return the current fitness.
java.lang.String	getGenomaString() Return the bit string in the format 010101010001
int	getID() Return the rule id.
int	hashCode() The hashCode depends only on the content of the bit string.
void	increaseFitness(double increment) Increase the current fitness value.
void	randomInitialize() Initialize the bit string to a uniform random initial state.
void	set(int bitIndex, boolean value) Change the state of the given bit to the given value.
void	setCopies(int copies) Set the number of copies for this rule.
void	setFitness(double fitness) Set the current fitness value.
void	setWillDie(boolean willDie) Set the willDie parameter.
void	setWillGenerate(boolean willGenerate) Set the willGenerate parameter.
java.lang.String	toString() Return a string in the format id [Fitness: # [willGenerate] [willDie] copies #] 0101.0101.0001
boolean	willDie() Return if the rule will die at next evolution.
boolean	willGenerate() Return if the rule will be regenerated at next evolution.

Methods inherited from class cern.colt.bitvector.BitVector

and, andNot, cardinality, copy, elements, elements, equals, forEachIndexFromToInState, get, getLongFromTo, getQuick, indexOfFromTo, not, or, partFromTo, put, putLongFromTo, putQuick, replaceFromToWith, replaceFromToWith, set, setSize, size, xor

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GARule

public GARule(int stringLength)

Create a new rule with given number of bits and id = 0.

Parameters:

stringLength - The fixed length of the bit string.

GARule

public GARule(int id,
              int stringLength)

Create a new rule with given number of bits and id.

Parameters:

stringLength - The fixed length of the bit string.

id - An integer used to identify the rule.

Method Detail

addCopy

public void addCopy()

Increase the number of copies.

clear

public void clear()

Empty the bit string and put each parameter to its default value.

Overrides:

clear in class cern.colt.bitvector.BitVector

clear

public void clear(int id)

Empty the bit string and put each parameter to its default value.

Overrides:

clear in class cern.colt.bitvector.BitVector

Parameters:

id - Change the id of the rule.

clear

public void clear(int id,
                  int stringLength)

Empty the bit string and put each parameter to its default value.

Parameters:

id - Changes the id of the rule.

stringLength - Changes the length of the bit string.

clone

public java.lang.Object clone()

Create a bitwise copy of the object.

Overrides:

clone in class cern.colt.bitvector.BitVector

Returns:

a copy of this object.

compareTo

public int compareTo(java.lang.Object o)

Compare the fitness value of two rules returning an ordered signed value.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - The object to be compared. It must be a Rule.

Returns:

1 if this.fitness > o.fitness; 0 if they are equal; -1 otherwise.

Throws:

java.lang.ClassCastException - if o is not an instance of Rule class.

copyFromGenoma

public void copyFromGenoma(GARule sourceRule)

Replace current genoma with the one of the given rule.

Parameters:

sourceRule - The rule from which to copy the genoma.

copyFromRule

public void copyFromRule(GARule sourceRule)

Replace current rule with the given one. All rule parameters will be overwritten. Also the id value is updated.

Parameters:

sourceRule - The rule overwriting this.

crossWithRule

public void crossWithRule(GARule sourceRule,
                          int crossPoint)

WARNING: To be tested. Do the crossover of two rules in a given cross point.

Parameters:

sourceRule - The rule to be crossed with this.

crossPoint - The bitIndex of the cross point.

Throws:

java.lang.UnsupportedOperationException - if the rules are not of the same size.

java.lang.IndexOutOfBoundsException - if crossPoint < 0 || crossPoint >= size().

decreaseFitness

public void decreaseFitness(double decrement)

Decrease the current fitness value.

Parameters:

decrement - The value to be subtracted to the fitness value.

flip

public void flip(int bitIndex)

Flip the state of a bit.

Parameters:

bitIndex - The bit to be flipped.

Throws:

java.lang.IndexOutOfBoundsException - - if bitIndex<0 || bitIndex>=size().

getCopies

public int getCopies()

Return the number of copies.

Returns:

The content of the copies variable.

getFitness

public double getFitness()

Return the current fitness.

Returns:

The fitness value for this rule.

getGenomaString

public java.lang.String getGenomaString()

Return the bit string in the format
010101010001

Returns:

The bit string representing the genoma.

getID

public int getID()

Return the rule id.

Returns:

The id of the rule.

hashCode

public int hashCode()

The hashCode depends only on the content of the bit string. See the cern.colt.bitvector.BitVector API for more details.

Overrides:

hashCode in class cern.colt.bitvector.BitVector

Returns:

The hashCode for the rule.

increaseFitness

public void increaseFitness(double increment)

Increase the current fitness value.

Parameters:

increment - The value to be added to the fitness value.

randomInitialize

public void randomInitialize()

Initialize the bit string to a uniform random initial state. Each bit has the same probability to be set.

set

public void set(int bitIndex,
                boolean value)

Change the state of the given bit to the given value.

Parameters:

bitIndex - The 0 based index of the bit to change.

value - The new value of the selected bit.

Throws:

java.lang.IndexOutOfBoundsException - - if bitIndex<0 || bitIndex>=size().

setCopies

public void setCopies(int copies)

Set the number of copies for this rule.

Parameters:

copies - The number of copies.

setFitness

public void setFitness(double fitness)

Set the current fitness value.

Parameters:

fitness - The fitness value for this rule.

setWillDie

public void setWillDie(boolean willDie)

Set the willDie parameter.

Parameters:

willDie - It decides if the rule will die at next evolution.

setWillGenerate

public void setWillGenerate(boolean willGenerate)

Set the willGenerate parameter.

Parameters:

willGenerate - It decides if the rule will reproduced at next evolution.

toString

public java.lang.String toString()

Return a string in the format
id [Fitness: # [willGenerate] [willDie] copies #]
0101.0101.0001

Overrides:

toString in class cern.colt.bitvector.BitVector

Returns:

The string describing the status of the rule.

willDie

public boolean willDie()

Return if the rule will die at next evolution.

Returns:

The willDie current value.

willGenerate

public boolean willGenerate()

Return if the rule will be regenerated at next evolution.

Returns:

The willGenerate current value.