org.spectrumauctions.sats.core.model.mrvm

Class MRVMRegionalBidder

java.lang.Object

org.spectrumauctions.sats.core.model.Bidder<MRVMLicense>

org.spectrumauctions.sats.core.model.mrvm.MRVMBidder

org.spectrumauctions.sats.core.model.mrvm.MRVMRegionalBidder

All Implemented Interfaces:

Serializable, GenericValueBidder<MRVMGenericDefinition>

public final class MRVMRegionalBidder
extends MRVMBidder

Author:

Michael Weiss

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BigDecimal	gammaFactor(MRVMRegionsMap.Region r, Bundle<MRVMLicense> bundle) Calculates the gamma factor, as explained in the model writeup.
Map<MRVMRegionsMap.Region,BigDecimal>	gammaFactors(Bundle<MRVMLicense> bundle) Calculates the gamma factors for all regions.
int	getHomeId()
<T extends BiddingLanguage> T	getValueFunction(Class<T> type, long seed) Use this method to get a desired value function representation (bidding language) for this bidder.
int	hashCode()
void	refreshReference(World world) To prevent from creating too many identical world instances, worlds are not serialized and deserialized with the bidder As a temporary solution, the world instance is re-added after deserialization by calling this method. This method will be removed in a later version and be done automatically during deserialization.

Methods inherited from class org.spectrumauctions.sats.core.model.mrvm.MRVMBidder

calculateValue, calculateValue, getAlpha, getBeta, getWorld, getzHigh, getzLow, omegaFactor, svFunction, svFunction

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

getId, getPopulation, getSetupType, getValue, getValueFunction, getWorldId, store

Methods inherited from class java.lang.Object

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

Method Detail

getHomeId

public int getHomeId()

gammaFactor

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

Calculates the gamma factor, as explained in the model writeup.
The gamma factor represents a bidder-specific discount of the the regional (omega) values. If the two regions are not disconnected, the value is 0.

Specified by:

gammaFactor in class MRVMBidder

Parameters:

bundle - Is not required for calculation of regional bidders gamma factors and will be ignored.

r - The region for which the discount is requested

gammaFactors

public Map<MRVMRegionsMap.Region,BigDecimal> gammaFactors(Bundle<MRVMLicense> bundle)

Calculates the gamma factors for all regions. For explanations of the gamma factors, see MRVMBidder.gammaFactor(MRVMRegionsMap.Region, Bundle)

Specified by:

gammaFactors in class MRVMBidder

Parameters:

bundle - Is not required for calculation of regional bidders gamma factors and will be ignored.

getValueFunction

public <T extends BiddingLanguage> T getValueFunction(Class<T> type,
                                                      long seed)
                                               throws UnsupportedBiddingLanguageException

Description copied from class: Bidder

Use this method to get a desired value function representation (bidding language) for this bidder. Note that this method may cause your compiler to throw a warning, as the generics of generic Bidding Languages (such as XOR) is not specified in .class. generic

Overrides:

getValueFunction in class MRVMBidder

Parameters:

type - the type of the value function

Returns:

the value function of this bidder

Throws:

UnsupportedBiddingLanguageException - Throws this exception for all bidding languages which are not supported by the implementing bidder class. This javadoc should be extended by the implementing class, specifying which value function representation are supported.

refreshReference

public void refreshReference(World world)

Description copied from class: Bidder

To prevent from creating too many identical world instances, worlds are not serialized and deserialized with the bidder
As a temporary solution, the world instance is re-added after deserialization by calling this method.

This method will be removed in a later version and be done automatically during deserialization.

Overrides:

refreshReference in class MRVMBidder

See Also:

Bidder.refreshReference(World)

hashCode

public int hashCode()

Overrides:

hashCode in class MRVMBidder

equals

public boolean equals(Object obj)

Overrides:

equals in class MRVMBidder