turtlekit.pheromone

Class Pheromone

java.lang.Object

turtlekit.pheromone.Pheromone

Direct Known Subclasses:

CPU_SobelPheromone, CudaPheromone, JavaPheromone

public abstract class Pheromone
extends Object

Constructor Summary

Constructors

Constructor and Description
Pheromone(String name, int width, int height, float evaporationCoeff, float diffusionCoeff)
Pheromone(String name, int width, int height, int evapPercentage, int diffPercentage)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	diffusion()
abstract void	diffusionAndEvaporation()
abstract void	evaporation()
abstract float	get(int index) access to underlying buffer
float	get(int x, int y)
protected int	get1DIndex(int x, int y)
float	getDiffusionCoefficient()
PheromoneCoefficientBoundedRangeModel	getDiffusionPercentage()
float	getEvaporationCoefficient()
PheromoneCoefficientBoundedRangeModel	getEvaporationPercentage()
int	getHeight()
int	getMaxDirection(int xcor, int ycor)
float	getMaximum()
int	getMinDirection(int i, int j)
String	getName()
abstract FloatBuffer	getValuesFloatBuffer()
int	getWidth()
void	incValue(int index, float inc) Adds inc to the current value of the cell with the corresponding index
void	incValue(int xcor, int ycor, float value)
protected abstract void	set(int index, float value) access to underlying buffer
void	set(int x, int y, float value)
void	setEvaporationPercentage(int evaporationPercentage) Deprecated.
void	setMaximum(float maximum)
String	toString()
void	updateFieldMaxDir()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Pheromone

public Pheromone(String name,
         int width,
         int height,
         int evapPercentage,
         int diffPercentage)

Pheromone

public Pheromone(String name,
         int width,
         int height,
         float evaporationCoeff,
         float diffusionCoeff)

Method Detail

get1DIndex

protected int get1DIndex(int x,
             int y)

getDiffusionCoefficient

public final float getDiffusionCoefficient()

Returns:

the diffusion coefficient as a float between 0 and 1, e.g. 0.33 for 33%

getEvaporationCoefficient

public final float getEvaporationCoefficient()

Returns:

the evaporation coefficient as a float between 0 and 1, e.g. 0.33 for 33%

get

public final float get(int x,
        int y)

set

public void set(int x,
       int y,
       float value)

incValue

public void incValue(int xcor,
            int ycor,
            float value)

getValuesFloatBuffer

public abstract FloatBuffer getValuesFloatBuffer()

get

public abstract float get(int index)

access to underlying buffer

Parameters:

index -

Returns:

set

protected abstract void set(int index,
       float value)

access to underlying buffer

Parameters:

index -

setEvaporationPercentage

@Deprecated
public void setEvaporationPercentage(int evaporationPercentage)

Deprecated.

getWidth

public int getWidth()

Returns:

the width

getHeight

public int getHeight()

Returns:

the height

diffusion

public abstract void diffusion()

diffusionAndEvaporation

public abstract void diffusionAndEvaporation()

evaporation

public abstract void evaporation()

getMaximum

public float getMaximum()

Returns:

the maximum

updateFieldMaxDir

public void updateFieldMaxDir()

setMaximum

public void setMaximum(float maximum)

Parameters:

maximum - the maximum to set

toString

public String toString()

Overrides:

toString in class Object

getMaxDirection

public int getMaxDirection(int xcor,
                  int ycor)

getMinDirection

public int getMinDirection(int i,
                  int j)

incValue

public void incValue(int index,
            float inc)

Adds inc to the current value of the cell with the corresponding index

Parameters:

index - cell's index

inc - how much to add

getName

public String getName()

getDiffusionPercentage

public PheromoneCoefficientBoundedRangeModel getDiffusionPercentage()

Returns:

the diffusionPercentage

getEvaporationPercentage

public PheromoneCoefficientBoundedRangeModel getEvaporationPercentage()

Returns:

the evaporationPercentage