BasicTestsUtils

java.lang.Object
- org.volante.abm.example.BasicTestsUtils

Direct Known Subclasses:

BatchModeParseFilterTest, BestByCellAllocationTest, BestByCellGlobalAllocationTest, CapitalDynamicsInstitutionTest, CellDisplayCoordinatesTest, CellRasterReaderTest, CellTests, CsvBatchRunParserTest, CSVCapitalLoaderTest, CSVCapitalUpdaterTest, CurveCompetitionTest, CurveCompetitivenessDisplayTest, DefaultAgentTest, GeneticAlgorithmAllocationModelTest, GiveUpGiveInAllocationTest, InnovationTest, InnovationTestUtils, InstitutionsTest, IntegratedTest, IterativeCellSamplerTest, RegionLoaderTest, RegionTests, ScenarioLoadingDataTypesTest, SimpleAllocationTest, SimpleCompetitionTest, SimplePotentialAgentTest, SimpleProductionTest, SimpleRegionalDemandTest, SocialNetworkLoaderTest, TestBasicSetup, WorldLoaderTest
```
public class BasicTestsUtils
extends Object
```
Sets up a basic test environment and provides some features to compare data and syntactic sugar for tests. Public members that make up the test environment: - ModelData modelData - RunInfo runInfo - SimplePotentialAgent forestry - SimplePotentialAgent farmering - Set potentialAgents Models: - CompetitivenessModel competition - allocation - StaticPerCellDemandModel demandR1 - StaticPerCellDemandModel demandR2 2 region with models above, potential agents and 10 cells c per region: - Region r1 - Region r2 - Set regions - RegionSet w 2 Agents: - AbstractAgent a1 - AbstractAgent a2 - ABMPersister persister - sets for each regions cells rcells Static members: - SimpleProductionModel forestryProduction - SimpleProductionModel farmingProduction - SimplePotentialAgent forestry - SimplePotentialAgent farming - Set potentialAgents Considered Capitals are: HUMAN(0), INFRASTRUCTURE(1), ECONOMIC(2), NATURAL_GRASSLAND(3), NATURAL_FOREST(4), NATURAL_CROPS(5), NATURE_VALUE(6) Considered Services: HOUSING(0), TIMBER(1), FOOD(2), RECREATION(3), Further data as provided (all static):

Field Summary

Fields
Modifier and Type	Field and Description
`AbstractAgent`	`a1`
`AbstractAgent`	`a2`
`AllocationModel`	`allocation`
`Cell`	`c11` A whole bunch of cells to play with
`Cell`	`c12` A whole bunch of cells to play with
`Cell`	`c13` A whole bunch of cells to play with
`Cell`	`c14` A whole bunch of cells to play with
`Cell`	`c15` A whole bunch of cells to play with
`Cell`	`c16` A whole bunch of cells to play with
`Cell`	`c17` A whole bunch of cells to play with
`Cell`	`c18` A whole bunch of cells to play with
`Cell`	`c19` A whole bunch of cells to play with
`Cell`	`c21`
`Cell`	`c22`
`Cell`	`c23`
`Cell`	`c24`
`Cell`	`c25`
`Cell`	`c26`
`Cell`	`c27`
`Cell`	`c28`
`Cell`	`c29`
`static com.moseph.modelutils.fastdata.DoubleMap<Capital>`	`cellCapitalsA` Arbitrary `DoubleMap` A of cell capitals
`static com.moseph.modelutils.fastdata.DoubleMap<Capital>`	`cellCapitalsB` Arbitrary `DoubleMap` B of cell capitals
`CompetitivenessModel`	`competition` Default competition and allocation functions
`StaticPerCellDemandModel`	`demandR1`
`StaticPerCellDemandModel`	`demandR2`
`static double[][]`	`extensiveFarmingCapitalWeights`
`static com.moseph.modelutils.fastdata.DoubleMap<Service>`	`extensiveFarmingOnCA` Expected service provision from extensive farmers on a cell with cellCapitals A.
`static com.moseph.modelutils.fastdata.DoubleMap<Service>`	`extensiveFarmingOnCB` Expected service provision from extensive farmers on a cell with cellCapitals B.
`static double[]`	`extensiveFarmingProductionWeights`
`static SimplePotentialAgent`	`farming`
`static double`	`farmingGivingIn`
`static double`	`farmingGivingUp`
`static SimpleProductionModel`	`farmingProduction`
`static SimplePotentialAgent`	`forestry`
`static double[][]`	`forestryCapitalWeights`
`static double`	`forestryGivingIn`
`static double`	`forestryGivingUp`
`static com.moseph.modelutils.fastdata.DoubleMap<Service>`	`forestryOnCA` Expected service provision from foresters on a cell with cellCapitals A.
`static com.moseph.modelutils.fastdata.DoubleMap<Service>`	`forestryOnCB` Expected service provision from foresters on a cell with cellCapitals B.
`static SimpleProductionModel`	`forestryProduction`
`static double[]`	`forestryProductionWeights`
`static ModelData`	`modelData`
`ABMPersister`	`persister`
`static Set<PotentialAgent>`	`potentialAgents`
`Region`	`r1`
`Set<Cell>`	`r1cells`
`Region`	`r2`
`Set<Cell>`	`r2cells`
`protected static int`	`randomNumberCounter`
`Set<Region>`	`regions`
`static RunInfo`	`runInfo`
`RegionSet`	`w`

Constructor Summary

Constructors
Constructor and Description

BasicTestsUtils()
Initialises region set w

Constructors
Constructor and Description
`BasicTestsUtils()` Initialises region set `w`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`assertAgent(String id, double competitiveness, Cell... cells)` Asserts that the given cells are occupied by an agent with the given ID and given competitiveness.
`static <T extends com.moseph.modelutils.fastdata.Indexed> void`	`assertEqualMaps(String msg, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<T> exp, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<T> got)` Checks that two NumberMaps are the same
`static <T extends com.moseph.modelutils.fastdata.Indexed> void`	`assertEqualMaps(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<T> exp, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<T> got)` Compare maps of data
`static void`	`assertUnmanaged(Cell... cells)` Checks that the given cells are indeed unmanaged.
`static com.moseph.modelutils.fastdata.DoubleMap<Capital>`	`capitals(double... vals)` Creates a map using the `SimpleCapitals` and the given values.
`static <T extends com.moseph.modelutils.fastdata.Named & com.moseph.modelutils.fastdata.Indexed> void`	`checkDataType(com.moseph.modelutils.fastdata.NamedIndexSet<T> caps, String name, int index)` Checks whether the capital with the given name has the given index in the given capitals named index set.
`static void`	`checkOwnership(Cell[] cells, PotentialAgent... owners)` Checks whether the `i`th cell is occupied by an agent of the `i`th potential agent.
`static void`	`checkOwnership(Cell[] cells, String... owners)` Checks whether the `i`th cell is occupied by an agent with the `i`th ID.
`static <T> void`	`checkSet(Collection<T> got, T... ex)` Checks that an expected set is the same as the actual set Note: arguments are the opposite way round to normal, to allow user of varargs
`static <T> void`	`checkSet(String msg, Collection<T> got, T... ex)` Checks that an expected set is the same as the actual set Note: arguments are the opposite way round to normal, to allow user of varargs
`com.google.common.collect.Multiset<PotentialAgent>`	`countAgents(Region r)` Returns a Multiset which provides the opportunity to receive counts agents of each `PotentialAgent` in the given region.
`static <T extends com.moseph.modelutils.fastdata.Indexed> com.moseph.modelutils.fastdata.DoubleMap<T>`	`dm(com.moseph.modelutils.fastdata.IndexSet<T> ind, double... vals)` Creates a new double map with the given index set and values.
`static PotentialAgent`	`getSingleProductionAgent(String id, double givingUp, double givingIn, double amount, Service service, Capital... dependencies)` Return a `PotentialAgent` with the given ID and given giving in/put thresholds that produces only the given `Service` leveraging capitals according to given dependencies.
`void`	`initTestEnvironment()` Inits cells, regions, agents, cell sets, regions set, regionset.
`static void`	`print(Object... vals)` Log given objects in a line
`static com.moseph.modelutils.fastdata.DoubleMap<Service>`	`services(double... vals)` Create a map using the `SimpleServices` and the given values
`static void`	`setCapitals(Cell[] cells, double[]... capitals)` Set the `i`th given capitals for tje `i`th cell.
`Region`	`setupBasicWorld(boolean initialiseRegion, Cell... cells)` Sets up a very basic world containing one region with the given cells.
`Region`	`setupBasicWorld(Cell... cells)` Set up a basic world with the given cells.
`void`	`setupPersister()` Setup persister by default to look in test-data.
`protected void`	`setupPseudoRandomEngine()`
`Region`	`setupWorld(AllocationModel allocation, CompetitivenessModel competition, DemandModel demand, Set<PotentialAgent> potentialAgents, Cell... cells)` Creates a very basic world applying the given models.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- randomNumberCounter
```
protected static int randomNumberCounter
```
- modelData
```
public static ModelData modelData
```
- runInfo
```
public static RunInfo runInfo
```
- c11
```
public Cell c11
```
  A whole bunch of cells to play with
- c12
```
public Cell c12
```
  A whole bunch of cells to play with
- c13
```
public Cell c13
```
  A whole bunch of cells to play with
- c14
```
public Cell c14
```
  A whole bunch of cells to play with
- c15
```
public Cell c15
```
  A whole bunch of cells to play with
- c16
```
public Cell c16
```
  A whole bunch of cells to play with
- c17
```
public Cell c17
```
  A whole bunch of cells to play with
- c18
```
public Cell c18
```
  A whole bunch of cells to play with
- c19
```
public Cell c19
```
  A whole bunch of cells to play with
- c21
```
public Cell c21
```
- c22
```
public Cell c22
```
- c23
```
public Cell c23
```
- c24
```
public Cell c24
```
- c25
```
public Cell c25
```
- c26
```
public Cell c26
```
- c27
```
public Cell c27
```
- c28
```
public Cell c28
```
- c29
```
public Cell c29
```
- r1cells
```
public Set<Cell> r1cells
```
- r2cells
```
public Set<Cell> r2cells
```
- extensiveFarmingProductionWeights
```
public static double[] extensiveFarmingProductionWeights
```
- extensiveFarmingCapitalWeights
```
public static double[][] extensiveFarmingCapitalWeights
```
- forestryProductionWeights
```
public static double[] forestryProductionWeights
```
- forestryCapitalWeights
```
public static double[][] forestryCapitalWeights
```
- cellCapitalsA
```
public static com.moseph.modelutils.fastdata.DoubleMap<Capital> cellCapitalsA
```
  Arbitrary DoubleMap A of cell capitals
- cellCapitalsB
```
public static com.moseph.modelutils.fastdata.DoubleMap<Capital> cellCapitalsB
```
  Arbitrary DoubleMap B of cell capitals
- extensiveFarmingOnCA
```
public static com.moseph.modelutils.fastdata.DoubleMap<Service> extensiveFarmingOnCA
```
  Expected service provision from extensive farmers on a cell with cellCapitals A. Production of each service should be the production weight multiplied by each capital to the power of the relevant capitalWeight (using SimpleProductionModel).
- extensiveFarmingOnCB
```
public static com.moseph.modelutils.fastdata.DoubleMap<Service> extensiveFarmingOnCB
```
  Expected service provision from extensive farmers on a cell with cellCapitals B. Production of each service should be the production weight multiplied by each capital to the power of the relevant capitalWeight (using SimpleProductionModel).
- forestryOnCA
```
public static com.moseph.modelutils.fastdata.DoubleMap<Service> forestryOnCA
```
  Expected service provision from foresters on a cell with cellCapitals A. Production of each service should be the production weight multiplied by each capital to the power of the relevant capitalWeight (using SimpleProductionModel).
- forestryOnCB
```
public static com.moseph.modelutils.fastdata.DoubleMap<Service> forestryOnCB
```
  Expected service provision from foresters on a cell with cellCapitals B. Production of each service should be the production weight multiplied by each capital to the power of the relevant capitalWeight (using SimpleProductionModel).
- competition
```
public CompetitivenessModel competition
```
  Default competition and allocation functions
- allocation
```
public AllocationModel allocation
```
- demandR1
```
public StaticPerCellDemandModel demandR1
```
- demandR2
```
public StaticPerCellDemandModel demandR2
```
- forestryProduction
```
public static SimpleProductionModel forestryProduction
```
- farmingProduction
```
public static SimpleProductionModel farmingProduction
```
- forestryGivingUp
```
public static final double forestryGivingUp
```
  See Also:
  
  Constant Field Values
- forestryGivingIn
```
public static final double forestryGivingIn
```
  See Also:
  
  Constant Field Values
- farmingGivingUp
```
public static final double farmingGivingUp
```
  See Also:
  
  Constant Field Values
- farmingGivingIn
```
public static final double farmingGivingIn
```
  See Also:
  
  Constant Field Values
- forestry
```
public static SimplePotentialAgent forestry
```
- farming
```
public static SimplePotentialAgent farming
```
- potentialAgents
```
public static Set<PotentialAgent> potentialAgents
```
- r1
```
public Region r1
```
- r2
```
public Region r2
```
- regions
```
public Set<Region> regions
```
- w
```
public RegionSet w
```
- a1
```
public AbstractAgent a1
```
- a2
```
public AbstractAgent a2
```
- persister
```
public ABMPersister persister
```

Constructor Detail
- BasicTestsUtils
```
public BasicTestsUtils()
```
  Initialises region set w

Method Detail

setupPersister
```
public void setupPersister()
```
Setup persister by default to look in test-data. Init cells.

initTestEnvironment
```
public void initTestEnvironment()
```
Inits cells, regions, agents, cell sets, regions set, regionset.

checkSet
```
public static <T> void checkSet(String msg,
                                Collection<T> got,
                                T... ex)
```
Checks that an expected set is the same as the actual set Note: arguments are the opposite way round to normal, to allow user of varargs

Parameters:

msg - describe the origin and kind of compared data

got - actual data to compare

ex - expected data to compare with

checkSet
```
public static <T> void checkSet(Collection<T> got,
                                T... ex)
```
Checks that an expected set is the same as the actual set Note: arguments are the opposite way round to normal, to allow user of varargs

Parameters:

got - actual data to compare

ex - expected data to compare with

dm

public static <T extends com.moseph.modelutils.fastdata.Indexed> com.moseph.modelutils.fastdata.DoubleMap<T> dm(com.moseph.modelutils.fastdata.IndexSet<T> ind,
                                                                                                                double... vals)

Creates a new double map with the given index set and values. Not very useful, just syntatic sugar for commonly used tests

Parameters:: ind - index set; vals - values
Returns:: double map with given index and values

services

public static com.moseph.modelutils.fastdata.DoubleMap<Service> services(double... vals)

Create a map using the SimpleServices and the given values

Parameters:: vals -
Returns:

capitals

public static com.moseph.modelutils.fastdata.DoubleMap<Capital> capitals(double... vals)

Creates a map using the SimpleCapitals and the given values.

Parameters:: vals -
Returns:

assertEqualMaps

public static <T extends com.moseph.modelutils.fastdata.Indexed> void assertEqualMaps(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<T> exp,
                                                                                      com.moseph.modelutils.fastdata.UnmodifiableNumberMap<T> got)

Compare maps of data

Parameters:: exp - expected data; got - acutal data

assertEqualMaps

public static <T extends com.moseph.modelutils.fastdata.Indexed> void assertEqualMaps(String msg,
                                                                                      com.moseph.modelutils.fastdata.UnmodifiableNumberMap<T> exp,
                                                                                      com.moseph.modelutils.fastdata.UnmodifiableNumberMap<T> got)

Checks that two NumberMaps are the same

Parameters:: msg -; exp -; got -

assertUnmanaged
```
public static void assertUnmanaged(Cell... cells)
```
Checks that the given cells are indeed unmanaged.

Parameters:

cells -

assertAgent
```
public static void assertAgent(String id,
                               double competitiveness,
                               Cell... cells)
```
Asserts that the given cells are occupied by an agent with the given ID and given competitiveness.

Parameters:

id - agent ID to check

competitiveness - competitiveness to check

cells - cells to check

checkDataType

public static <T extends com.moseph.modelutils.fastdata.Named & com.moseph.modelutils.fastdata.Indexed> void checkDataType(com.moseph.modelutils.fastdata.NamedIndexSet<T> caps,
                                                                                                                           String name,
                                                                                                                           int index)

Checks whether the capital with the given name has the given index in the given capitals named index set.

Parameters:: caps -; name -; index -

checkOwnership

public static void checkOwnership(Cell[] cells,
                                  String... owners)

Checks whether the ith cell is occupied by an agent with the ith ID.

Parameters:: cells -; owners -

checkOwnership

public static void checkOwnership(Cell[] cells,
                                  PotentialAgent... owners)

Checks whether the ith cell is occupied by an agent of the ith potential agent.

Parameters:: cells -; owners -

setCapitals

public static void setCapitals(Cell[] cells,
                               double[]... capitals)

Set the ith given capitals for tje ith cell.

Parameters:: cells -; capitals -

print
```
public static void print(Object... vals)
```
Log given objects in a line

Parameters:

vals -

setupBasicWorld
```
public Region setupBasicWorld(Cell... cells)
                       throws Exception
```
Set up a basic world with the given cells.

Parameters:

cells -

Returns:

Throws:

Exception

getSingleProductionAgent

public static PotentialAgent getSingleProductionAgent(String id,
                                                      double givingUp,
                                                      double givingIn,
                                                      double amount,
                                                      Service service,
                                                      Capital... dependencies)

Return a PotentialAgent with the given ID and given giving in/put thresholds that produces only the given Service leveraging capitals according to given dependencies.

Parameters:: id -; givingUp -; givingIn -; amount -; service -; dependencies -
Returns:

countAgents
```
public com.google.common.collect.Multiset<PotentialAgent> countAgents(Region r)
```
Returns a Multiset which provides the opportunity to receive counts agents of each PotentialAgent in the given region.

Parameters:

r -

Returns:

setupBasicWorld
```
public Region setupBasicWorld(boolean initialiseRegion,
                              Cell... cells)
                       throws Exception
```
Sets up a very basic world containing one region with the given cells. As models the SimpleAllocationModel, SimpleCompetitivenessModel, and RegionalDemandModel are applied. Schedule is initialised.

Parameters:

initialiseRegion -

cells -

Returns:

Throws:

Exception

setupWorld

public Region setupWorld(AllocationModel allocation,
                         CompetitivenessModel competition,
                         DemandModel demand,
                         Set<PotentialAgent> potentialAgents,
                         Cell... cells)
                  throws Exception

Creates a very basic world applying the given models.

Parameters:: allocation -; competition -; demand -; potentialAgents -; cells -
Returns:
Throws:: Exception

setupPseudoRandomEngine

protected void setupPseudoRandomEngine()

Class BasicTestsUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

randomNumberCounter

modelData

runInfo

c11

c12

c13

c14

c15

c16

c17

c18

c19

c21

c22

c23

c24

c25

c26

c27

c28

c29

r1cells

r2cells

extensiveFarmingProductionWeights

extensiveFarmingCapitalWeights

forestryProductionWeights

forestryCapitalWeights

cellCapitalsA

cellCapitalsB

extensiveFarmingOnCA

extensiveFarmingOnCB

forestryOnCA

forestryOnCB

competition

allocation

demandR1

demandR2

forestryProduction

farmingProduction

forestryGivingUp

forestryGivingIn

farmingGivingUp

farmingGivingIn

forestry

farming

potentialAgents

r1

r2

regions

w

a1

a2

persister

Constructor Detail

BasicTestsUtils

Method Detail

setupPersister

initTestEnvironment

checkSet

checkSet

dm

services

capitals

assertEqualMaps

assertEqualMaps

assertUnmanaged

assertAgent

checkDataType

checkOwnership

checkOwnership

setCapitals

print

setupBasicWorld

getSingleProductionAgent