org.spectrumauctions.sats.core.model.mrvm

Class MRVMWorld

java.lang.Object

org.spectrumauctions.sats.core.model.World

org.spectrumauctions.sats.core.model.mrvm.MRVMWorld

All Implemented Interfaces:

Serializable

public final class MRVMWorld
extends World

Author:

Michael Weiss

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_NAME

Fields inherited from class org.spectrumauctions.sats.core.model.World

id, modelName

Constructor Summary

Constructors

Constructor and Description
MRVMWorld(MRVMWorldSetup worldSetup, RNGSupplier rngSupplier)

Method Summary

Modifier and Type	Method and Description
static BigDecimal	c(MRVMRegionsMap.Region r, Bundle<MRVMLicense> bundle) Defines the c-function, i.e., c(r,x) = sum_{b\in B} cap(b,r,x) [as explained in the paper]
static BigDecimal	capOfBand(MRVMBand band, int numberOfLicenses) Returns the capacity for having numberOfLicenses many MRVMLicense in MRVMBand band
List<MRVMBidder>	createPopulation(Collection<MRVMLocalBidderSetup> localSetups, Collection<MRVMRegionalBidderSetup> regionalSetups, Collection<MRVMNationalBidderSetup> nationalSetups, RNGSupplier rngSupplier)
List<MRVMBidder>	createPopulation(MRVMLocalBidderSetup localSetup, MRVMRegionalBidderSetup regionalSetup, MRVMNationalBidderSetup nationalSetup, RNGSupplier rngSupplier)
Set<MRVMBand>	getBands()
Set<MRVMLicense>	getLicenses()
static Map<MRVMBand,Bundle<MRVMLicense>>	getLicensesPerBand(Bundle<MRVMLicense> bundle) Sorts the licenses of a bundle into subbundles by their band.
static Map<MRVMBand,Bundle<MRVMLicense>>	getLicensesPerBand(Bundle<MRVMLicense> bundle, MRVMWorld world) Sorts the licenses of a bundle into subbundles by their band.
static Map<MRVMRegionsMap.Region,Bundle<MRVMLicense>>	getLicensesPerRegion(Bundle<MRVMLicense> bundle) Sorts the licenses of a bundle into subbundles by their region.
BigDecimal	getMaximumRegionalCapacity() Calculates the maximum capacity any region can have.
int	getNumberOfGoods()
MRVMRegionsMap	getRegionsMap()
static Map<MRVMBand,Integer>	quantitiesPerBand(Bundle<MRVMLicense> bundle) Counts the number of licenses for each band.
static Map<MRVMBand,Integer>	quantitiesPerBand(Bundle<MRVMLicense> bundle, MRVMWorld MRVMWorld) Counts the number of licenses for each band.
void	refreshFieldBackReferences() Some of the members of the World (e.g.
Collection<? extends Bidder<MRVMLicense>>	restorePopulation(long populationId) Restore serialized Bidder instances via population id

Methods inherited from class org.spectrumauctions.sats.core.model.World

equals, getId, getModelName, hashCode, openNewPopulation, restorePopulation, restorePopulation, store

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_NAME

public static final String MODEL_NAME

See Also:

Constant Field Values

Constructor Detail

MRVMWorld

public MRVMWorld(MRVMWorldSetup worldSetup,
                 RNGSupplier rngSupplier)

Method Detail

getNumberOfGoods

public int getNumberOfGoods()

Specified by:

getNumberOfGoods in class World

See Also:

World.getNumberOfGoods()

getBands

public Set<MRVMBand> getBands()

getLicenses

public Set<MRVMLicense> getLicenses()

Specified by:

getLicenses in class World

See Also:

World.getLicenses()

restorePopulation

public Collection<? extends Bidder<MRVMLicense>> restorePopulation(long populationId)

Description copied from class: World

Restore serialized Bidder instances via population id

Specified by:

restorePopulation in class World

Parameters:

populationId - the population id

Returns:

the deserialized bidders

See Also:

World.restorePopulation(long)

refreshFieldBackReferences

public void refreshFieldBackReferences()

Description copied from class: World

Some of the members of the World (e.g. licenses) have circular references back to the world.
As the used gsonSerializer cannot handle this yet, the circular references are not serialized and have to be restored after deserialization by calling this method.

This method will be removed in a later version and the problem be solved during deserialization.

Specified by:

refreshFieldBackReferences in class World

See Also:

World.refreshFieldBackReferences()

getRegionsMap

public MRVMRegionsMap getRegionsMap()

getLicensesPerBand

public static Map<MRVMBand,Bundle<MRVMLicense>> getLicensesPerBand(Bundle<MRVMLicense> bundle)

Sorts the licenses of a bundle into subbundles by their band. The returned map contains all bands of the world as keys, even such which are not present with any licenses in the bundle.

Parameters:

bundle - Must be nonempty

getLicensesPerBand

public static Map<MRVMBand,Bundle<MRVMLicense>> getLicensesPerBand(Bundle<MRVMLicense> bundle,
                                                                   MRVMWorld world)

Sorts the licenses of a bundle into subbundles by their band. The returned map contains all bands of the world as keys, even such which are not present with any licenses in the bundle.

quantitiesPerBand

public static Map<MRVMBand,Integer> quantitiesPerBand(Bundle<MRVMLicense> bundle)

Counts the number of licenses for each band. The returned map contains all bands of the world as keys, even such which are not present with any licenses in the bundle.

Parameters:

bundle - Must be nonempty

quantitiesPerBand

public static Map<MRVMBand,Integer> quantitiesPerBand(Bundle<MRVMLicense> bundle,
                                                      MRVMWorld MRVMWorld)

Counts the number of licenses for each band. The returned map contains all bands of the world as keys, even such which are not present with any licenses in the bundle.

Parameters:

bundle - Must be nonempty

c

public static BigDecimal c(MRVMRegionsMap.Region r,
                           Bundle<MRVMLicense> bundle)

Defines the c-function, i.e., c(r,x) = sum_{b\in B} cap(b,r,x) [as explained in the paper]

getMaximumRegionalCapacity

public BigDecimal getMaximumRegionalCapacity()

Calculates the maximum capacity any region can have. The result is cached, hence, calling the method multiple time is not costly.

capOfBand

public static BigDecimal capOfBand(MRVMBand band,
                                   int numberOfLicenses)

Returns the capacity for having numberOfLicenses many MRVMLicense in MRVMBand band

getLicensesPerRegion

public static Map<MRVMRegionsMap.Region,Bundle<MRVMLicense>> getLicensesPerRegion(Bundle<MRVMLicense> bundle)

Sorts the licenses of a bundle into subbundles by their region.

Returns:

map that contains all regions of the world as keys, even such which are not present with any licenses in the bundle.

createPopulation

public List<MRVMBidder> createPopulation(MRVMLocalBidderSetup localSetup,
                                         MRVMRegionalBidderSetup regionalSetup,
                                         MRVMNationalBidderSetup nationalSetup,
                                         RNGSupplier rngSupplier)

createPopulation

public List<MRVMBidder> createPopulation(Collection<MRVMLocalBidderSetup> localSetups,
                                         Collection<MRVMRegionalBidderSetup> regionalSetups,
                                         Collection<MRVMNationalBidderSetup> nationalSetups,
                                         RNGSupplier rngSupplier)