net.sourceforge.cilib.entity
Interface Particle

All Superinterfaces:

Cloneable, Comparable<Entity>, Entity, Serializable, SocialEntity

All Known Implementing Classes:

AbstractParticle, ChargedParticle, CoherenceParticle, DeviationDecorator, DynamicParticle, LFDecorator, MultiObjectiveParticle, ParticleDecorator, RNAParticle, StandardParticle

public interface Particle
extends Entity, SocialEntity

Definition of a particle.

Method Summary

Fitness	getBestFitness() Get the best Fitness for the particle.
StructuredType	getBestPosition() Get the best position of the Particle.
Particle	getClone() Make a clone of the Entity the exact semantics of the clone method will be defined by the classes that implements this interface.
int	getDimension() Returns the dimension of the Entity.
Fitness	getFitness() Returns the Entity fitness.
Particle	getNeighbourhoodBest() Get the current best particle within the Particles neighbourhood.
PersonalBestUpdateStrategy	getPersonalBestUpdateStrategy() Get the current strategy to perform personal best updates.
StructuredType	getPosition() Get the current position of the Particle.
PositionUpdateStrategy	getPositionUpdateStrategy() Get the current PositionUpdateStrategy of the Particle.
StructuredType	getVelocity() Get the current velocity of the Particle.
VelocityInitialisationStrategy	getVelocityInitialisationStrategy() Get the strategy for the intialisation of the velocity.
VelocityUpdateStrategy	getVelocityUpdateStrategy() Get the strategy that will be used to update the velocity.
void	setNeighbourhoodBest(Particle particle) Set the current neighbourhood best particle within the current neighbourhood.
void	setPersonalBestUpdateStrategy(PersonalBestUpdateStrategy personalBestUpdateStrategy) Set the strategy to perform personal best updates.
void	setPositionUpdateStrategy(PositionUpdateStrategy positionUpdateStrategy) Set the PositionUpdateStrategy to use for particle position updates.
void	setVelocityInitialisationStrategy(VelocityInitialisationStrategy velocityInitialisationStrategy) Set the initialisation strategy for the Particles velocity.
void	setVelocityUpdateStrategy(VelocityUpdateStrategy velocityUpdateStrategy) Set the VelocityUpdateStrategy to be used during velocity updates.
void	updateControlParameters() Update all the ControlParameters that are maintained within the Particle.
void	updatePosition() Update the current position of the Particle.
void	updateVelocity() Update the velocity of the Particle.

Methods inherited from interface net.sourceforge.cilib.entity.SocialEntity

getNeighbourhoodBestUpdateStrategy, getSocialBestFitness, setNeighbourhoodBestUpdateStrategy

Methods inherited from interface net.sourceforge.cilib.entity.Entity

calculateFitness, calculateFitness, compareTo, getCandidateSolution, getFitnessCalculator, getId, getProperties, initialise, reinitialise, setCandidateSolution, setProperties

Method Detail

getClone

Particle getClone()

Make a clone of the Entity the exact semantics of the clone method will be defined by the classes that implements this interface.

Specified by:

getClone in interface Cloneable

Specified by:

getClone in interface Entity

Returns:

the cloned object

See Also:

Object.clone()

getPosition

StructuredType getPosition()

Get the current position of the Particle.

Returns:

The Type representing the position.

getBestPosition

StructuredType getBestPosition()

Get the best position of the Particle.

Returns:

The Type representing the best position.

getVelocity

StructuredType getVelocity()

Get the current velocity of the Particle.

Returns:

The Type representing the velocity.

getNeighbourhoodBest

Particle getNeighbourhoodBest()

Get the current best particle within the Particles neighbourhood.

Returns:

The neighbourhood best particle.

setNeighbourhoodBest

void setNeighbourhoodBest(Particle particle)

Set the current neighbourhood best particle within the current neighbourhood.

Parameters:

particle - The particle to set as the neighbourhood best.

getDimension

int getDimension()

Returns the dimension of the Entity.

Specified by:

getDimension in interface Entity

Returns:

The dimension of the Entity.

getFitness

Fitness getFitness()

Returns the Entity fitness.

Specified by:

getFitness in interface Entity

Returns:

The Fitness of the Entity.

getBestFitness

Fitness getBestFitness()

Get the best Fitness for the particle.

Specified by:

getBestFitness in interface Entity

Returns:

The particle's best Fitness.

updatePosition

void updatePosition()

Update the current position of the Particle.

updateVelocity

void updateVelocity()

Update the velocity of the Particle.

updateControlParameters

void updateControlParameters()

Update all the ControlParameters that are maintained within the Particle.

getVelocityUpdateStrategy

VelocityUpdateStrategy getVelocityUpdateStrategy()

Get the strategy that will be used to update the velocity.

Returns:

The current VelocityUpdateStrategy.

setVelocityUpdateStrategy

void setVelocityUpdateStrategy(VelocityUpdateStrategy velocityUpdateStrategy)

Set the VelocityUpdateStrategy to be used during velocity updates.

Parameters:

velocityUpdateStrategy - the VelocityUpdateStrategy to use.

getVelocityInitialisationStrategy

VelocityInitialisationStrategy getVelocityInitialisationStrategy()

Get the strategy for the intialisation of the velocity.

Returns:

The VelocityInitialisationStrategy that is currently set.

setVelocityInitialisationStrategy

void setVelocityInitialisationStrategy(VelocityInitialisationStrategy velocityInitialisationStrategy)

Set the initialisation strategy for the Particles velocity.

Parameters:

velocityInitialisationStrategy - The velocity initialisation strategy to set.

getPositionUpdateStrategy

PositionUpdateStrategy getPositionUpdateStrategy()

Get the current PositionUpdateStrategy of the Particle.

Returns:

The current PositionUpdateStrategy.

setPositionUpdateStrategy

void setPositionUpdateStrategy(PositionUpdateStrategy positionUpdateStrategy)

Set the PositionUpdateStrategy to use for particle position updates.

Parameters:

positionUpdateStrategy - The PositionUpdateStrategy to set.

getPersonalBestUpdateStrategy

PersonalBestUpdateStrategy getPersonalBestUpdateStrategy()

Get the current strategy to perform personal best updates.

Returns:

The current PersonalBestUpdateStrategy.

setPersonalBestUpdateStrategy

void setPersonalBestUpdateStrategy(PersonalBestUpdateStrategy personalBestUpdateStrategy)

Set the strategy to perform personal best updates.

Parameters:

personalBestUpdateStrategy - The instance to set.