org.volante.abm.example

Class SimpleProductionModel

java.lang.Object

org.volante.abm.example.SimpleProductionModel

All Implemented Interfaces:

ProductionModel, ProductionWeightReporter, Initialisable

public class SimpleProductionModel
extends Object
implements ProductionModel, ProductionWeightReporter

Simple exponential multiplicative function, i.e.: p_s = p_max * c_1 ^ w_1 * c_2 ^ w_2 *...*c_n ^ w_n

Constructor Summary

Constructors

Constructor and Description
SimpleProductionModel()
SimpleProductionModel(double[][] weights, double[] productionWeights) Takes an array of capital weights, in the form: { { c1s1, c2s1 ...

Method Summary

Modifier and Type	Method and Description
SimpleProductionModel	copyExact() Creates a new instance of SimpleProductionModel and copied capital weights and production weights.
SimpleProductionModel	copyWithNoise(ModelData data, com.moseph.modelutils.distribution.Distribution production, com.moseph.modelutils.distribution.Distribution importance) Creates a copy of this model, but with noise added to either the production weights or the importance weights.
com.moseph.modelutils.fastdata.DoubleMatrix<Capital,Service>	getCapitalWeights()
com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service>	getProductionWeights() Returns an agent's production weights.
void	initialise(ModelData data, RunInfo info, Region r)
void	production(Cell cell, com.moseph.modelutils.fastdata.DoubleMap<Service> production) Calculates production on the given cell, puts it into the supplied NumberMap
void	production(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> capitals, com.moseph.modelutils.fastdata.DoubleMap<Service> production)
void	production(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> capitals, com.moseph.modelutils.fastdata.DoubleMap<Service> production, Cell cell)
void	setWeight(Capital c, Service s, double weight) Sets the effect of a capital on provision of a service
void	setWeight(Service s, double weight) Sets the maximum level for a service
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleProductionModel

public SimpleProductionModel()

SimpleProductionModel

public SimpleProductionModel(double[][] weights,
                             double[] productionWeights)

Takes an array of capital weights, in the form: { { c1s1, c2s1 ... } //Weights for service 1 { c1s2, c2s2 ... } //Weights for service 2 ... i.e. first index is Services, second is baseCapitals

Parameters:

weights -

productionWeights -

Method Detail

initialise

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

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

r - region the initialisable object belongs to

Throws:

Exception

setWeight

public void setWeight(Capital c,
                      Service s,
                      double weight)

Sets the effect of a capital on provision of a service

Parameters:

c -

s -

weight -

setWeight

public void setWeight(Service s,
                      double weight)

Sets the maximum level for a service

Parameters:

s -

weight -

getProductionWeights

public com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> getProductionWeights()

Description copied from interface: ProductionWeightReporter

Returns an agent's production weights.

Specified by:

getProductionWeights in interface ProductionWeightReporter

Returns:

getCapitalWeights

public com.moseph.modelutils.fastdata.DoubleMatrix<Capital,Service> getCapitalWeights()

production

public void production(Cell cell,
                       com.moseph.modelutils.fastdata.DoubleMap<Service> production)

Description copied from interface: ProductionModel

Calculates production on the given cell, puts it into the supplied NumberMap

Specified by:

production in interface ProductionModel

production

public void production(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> capitals,
                       com.moseph.modelutils.fastdata.DoubleMap<Service> production)

production

public void production(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> capitals,
                       com.moseph.modelutils.fastdata.DoubleMap<Service> production,
                       Cell cell)

toString

public String toString()

Overrides:

toString in class Object

copyWithNoise

public SimpleProductionModel copyWithNoise(ModelData data,
                                           com.moseph.modelutils.distribution.Distribution production,
                                           com.moseph.modelutils.distribution.Distribution importance)

Creates a copy of this model, but with noise added to either the production weights or the importance weights. Either or both distributions can be null for zero noise

Parameters:

data -

production -

importance -

Returns:

new production model

copyExact

public SimpleProductionModel copyExact()

Creates a new instance of SimpleProductionModel and copied capital weights and production weights. CsvFile is not required after initialisation.

Returns:

exact copy of this production model