org.volante.abm.update

Class ProportionalChangeFunction

java.lang.Object

org.volante.abm.update.ProportionalChangeFunction

All Implemented Interfaces:

Initialisable, AgentTypeUpdater.CapitalUpdateFunction

public class ProportionalChangeFunction
extends Object
implements AgentTypeUpdater.CapitalUpdateFunction

Expresses change of value as a proportion of difference with top value (for +ve numbers) or bottom value (for -ve numbers)

Constructor Summary

Constructors

Constructor and Description
ProportionalChangeFunction()
ProportionalChangeFunction(Capital c, double change)
ProportionalChangeFunction(Capital c, double change, double top, double bottom)

Method Summary

Modifier and Type	Method and Description
void	apply(Cell c) TODO This function did nothing.
double	function(double value) The actual update function.
void	initialise(ModelData data, RunInfo info, Region extent)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProportionalChangeFunction

public ProportionalChangeFunction()

ProportionalChangeFunction

public ProportionalChangeFunction(Capital c,
                                  double change)

ProportionalChangeFunction

public ProportionalChangeFunction(Capital c,
                                  double change,
                                  double top,
                                  double bottom)

Method Detail

apply

public void apply(Cell c)

TODO This function did nothing. What should it do? Applies the function to the cell. If you want to do something more complex (i.e. involving cell values) override this.

Specified by:

apply in interface AgentTypeUpdater.CapitalUpdateFunction

function

public double function(double value)

The actual update function. If you want to change the calculation, override this.

Parameters:

value -

Returns:

initialise

public void initialise(ModelData data,
                       RunInfo info,
                       Region extent)
                throws Exception

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

extent - region the initialisable object belongs to

Throws:

Exception