org.spectrumauctions.sats.core.model.mrvm

Class MRVMBidder

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, GenericValueBidder<MRVMGenericDefinition>

Direct Known Subclasses:

MRVMLocalBidder, MRVMNationalBidder, MRVMRegionalBidder

public abstract class MRVMBidder
extends Bidder<MRVMLicense>
implements GenericValueBidder<MRVMGenericDefinition>

Author:

Michael Weiss

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
BigDecimal	calculateValue(Bundle<MRVMLicense> bundle) Returns the value this bidder has for a specific bundle.
BigDecimal	calculateValue(Map<MRVMGenericDefinition,Integer> genericQuantities)
boolean	equals(Object obj)
abstract BigDecimal	gammaFactor(MRVMRegionsMap.Region r, Bundle<MRVMLicense> bundle) Calculates the gamma factor, as explained in the model writeup.
abstract Map<MRVMRegionsMap.Region,BigDecimal>	gammaFactors(Bundle<MRVMLicense> bundle) Calculates the gamma factors for all regions.
BigDecimal	getAlpha()
BigDecimal	getBeta(MRVMRegionsMap.Region region)
<T extends BiddingLanguage> T	getValueFunction(Class<T> clazz, long seed) Use this method to get a desired value function representation (bidding language) for this bidder.
MRVMWorld	getWorld()
BigDecimal	getzHigh(MRVMRegionsMap.Region region)
BigDecimal	getzLow(MRVMRegionsMap.Region region)
int	hashCode()
BigDecimal	omegaFactor(MRVMRegionsMap.Region r, BigDecimal sv) Calculates the omega factor (i.e., the regional value)
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.
ContinuousPiecewiseLinearFunction	svFunction(MRVMRegionsMap.Region region)
BigDecimal	svFunction(MRVMRegionsMap.Region region, BigDecimal c) Calculates the sv-function [See description in paper]

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

omegaFactor

public BigDecimal omegaFactor(MRVMRegionsMap.Region r,
                              BigDecimal sv)

Calculates the omega factor (i.e., the regional value)

svFunction

public BigDecimal svFunction(MRVMRegionsMap.Region region,
                             BigDecimal c)

Calculates the sv-function [See description in paper]

svFunction

public ContinuousPiecewiseLinearFunction svFunction(MRVMRegionsMap.Region region)

gammaFactor

public abstract 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.

Parameters:

r - The region for which the discount is requested

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

gammaFactors

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

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

Parameters:

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

calculateValue

public BigDecimal calculateValue(Bundle<MRVMLicense> bundle)

Description copied from class: Bidder

Returns the value this bidder has for a specific bundle.

Specified by:

calculateValue in class Bidder<MRVMLicense>

Parameters:

bundle - the bundle for which the value is asked

Returns:

bidder specific value for this bundle

calculateValue

public BigDecimal calculateValue(Map<MRVMGenericDefinition,Integer> genericQuantities)

Specified by:

calculateValue in interface GenericValueBidder<MRVMGenericDefinition>

See Also:

GenericValueBidder.calculateValue(java.util.Map)

getWorld

public MRVMWorld getWorld()

Specified by:

getWorld in class Bidder<MRVMLicense>

Returns:

World to which this bidder belongs. The implementing Bidder class, overriding this method, should return a world type corresponding to the specific model.

getzLow

public BigDecimal getzLow(MRVMRegionsMap.Region region)

getzHigh

public BigDecimal getzHigh(MRVMRegionsMap.Region region)

getAlpha

public BigDecimal getAlpha()

getBeta

public BigDecimal getBeta(MRVMRegionsMap.Region region)

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.

Specified by:

refreshReference in class Bidder<MRVMLicense>

See Also:

Bidder.refreshReference(World)

getValueFunction

public <T extends BiddingLanguage> T getValueFunction(Class<T> clazz,
                                                      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

Specified by:

getValueFunction in class Bidder<MRVMLicense>

Parameters:

clazz - 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 Bidder<MRVMLicense>

equals

public boolean equals(Object obj)

Overrides:

equals in class Bidder<MRVMLicense>