org.volante.abm.example

Class CurveCompetitivenessModel

java.lang.Object

org.volante.abm.example.CurveCompetitivenessModel

All Implemented Interfaces:

CompetitivenessModel, Initialisable, Displayable

public class CurveCompetitivenessModel
extends Object
implements CompetitivenessModel

A more complex model of competitiveness allowing the applications of functions.

Nested Class Summary

Nested classes/interfaces inherited from interface org.volante.abm.models.CompetitivenessModel

CompetitivenessModel.CompetitivenessDisplay

Constructor Summary

Constructors

Constructor and Description
CurveCompetitivenessModel()

Method Summary

Modifier and Type	Method and Description
double	addUpMarginalUtilities(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> residualDemand, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)
double	addUpMarginalUtilities(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> residualDemand, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply, boolean showWorking) Adds up marginal utilities (determined by competitiveness for unmet demand) of all services.
double	getCompetitiveness(DemandModel demand, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)
double	getCompetitiveness(DemandModel demand, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply, Cell cell)
double	getCompetitveness(DemandModel demand, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply, boolean showWorking) Calculates per-cell residuals and calls addUpMarginalUtilities(UnmodifiableNumberMap, UnmodifiableNumberMap, boolean) .
Map<Service,com.moseph.modelutils.curve.Curve>	getCurves()
CurveCompetitivenessDisplay	getDisplay()
void	initialise(ModelData data, RunInfo info, Region extent)
boolean	isRemoveCurrentLevel()
boolean	isRemoveNegative()
void	loadLinearCSV(String csvFile)
void	onWrite()
void	setCurve(Service s, com.moseph.modelutils.curve.Curve c)
void	setRemoveCurrentLevel(boolean removeCurrentLevel)
void	setRemoveNegative(boolean removeNegative)

Methods inherited from class java.lang.Object

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

Constructor Detail

CurveCompetitivenessModel

public CurveCompetitivenessModel()

Method Detail

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

getCompetitiveness

public double getCompetitiveness(DemandModel demand,
                                 com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)

Specified by:

getCompetitiveness in interface CompetitivenessModel

See Also:

CompetitivenessModel.getCompetitiveness(org.volante.abm.models.DemandModel, com.moseph.modelutils.fastdata.UnmodifiableNumberMap)

getCompetitveness

public double getCompetitveness(DemandModel demand,
                                com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply,
                                boolean showWorking)

Calculates per-cell residuals and calls addUpMarginalUtilities(UnmodifiableNumberMap, UnmodifiableNumberMap, boolean) .

Parameters:

demand -

supply -

showWorking -

Returns:

summed marginal utilities

getCompetitiveness

public double getCompetitiveness(DemandModel demand,
                                 com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply,
                                 Cell cell)

Specified by:

getCompetitiveness in interface CompetitivenessModel

addUpMarginalUtilities

public double addUpMarginalUtilities(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> residualDemand,
                                     com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)

Specified by:

addUpMarginalUtilities in interface CompetitivenessModel

addUpMarginalUtilities

public double addUpMarginalUtilities(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> residualDemand,
                                     com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply,
                                     boolean showWorking)

Adds up marginal utilities (determined by competitiveness for unmet demand) of all services.

Parameters:

residualDemand -

supply -

showWorking - if true, log details in DEBUG mode

Returns:

summed marginal utilities of all services

isRemoveCurrentLevel

public boolean isRemoveCurrentLevel()

setRemoveCurrentLevel

public void setRemoveCurrentLevel(boolean removeCurrentLevel)

isRemoveNegative

public boolean isRemoveNegative()

setRemoveNegative

public void setRemoveNegative(boolean removeNegative)

loadLinearCSV

public void loadLinearCSV(String csvFile)
                   throws IOException

Throws:

IOException

onWrite

public void onWrite()

getCurves

public Map<Service,com.moseph.modelutils.curve.Curve> getCurves()

setCurve

public void setCurve(Service s,
                     com.moseph.modelutils.curve.Curve c)

getDisplay

public CurveCompetitivenessDisplay getDisplay()

Specified by:

getDisplay in interface CompetitivenessModel

Specified by:

getDisplay in interface Displayable