org.spectrumauctions.sats.core.model.mrvm

Class MRVMNationalBidder

java.lang.Object

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

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

org.spectrumauctions.sats.core.model.mrvm.MRVMNationalBidder

All Implemented Interfaces:

Serializable, GenericValueBidder<MRVMGenericDefinition>

public final class MRVMNationalBidder
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.
BigDecimal	getGamma(int uncoveredRegions) Reads the gammavalue form the stored map.
int	getKMax()
<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()

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

calculateValue, calculateValue, getAlpha, getBeta, getWorld, getzHigh, getzLow, omegaFactor, refreshReference, 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

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.

Specified by:

gammaFactor in class MRVMBidder

Parameters:

r - Not required for gamma calculation of national bidder and will be ignored

bundle - The complete bundle (not only containing the licenses of r).

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)

As gamma is not dependent on the region for national bidders, the returned map will contain the same value for all keys, i.e. the same gamma for all regions

Specified by:

gammaFactors in class MRVMBidder

Parameters:

bundle - The bundle for which the discounts will be calculated.

getKMax

public int getKMax()

getGamma

public BigDecimal getGamma(int uncoveredRegions)

Reads the gammavalue form the stored map. If uncoveredRegions greater than getKMax(), then the value for kMax is returned (see model writeup for explanation).

Parameters:

uncoveredRegions - the number of regions that are uncovered

Returns:

the gamma value for the number of uncovered regions

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.

hashCode

public int hashCode()

Overrides:

hashCode in class MRVMBidder

equals

public boolean equals(Object obj)

Overrides:

equals in class MRVMBidder