Package org.spectrumauctions.sats.core.model.mrvm

Class MRVMBidder

java.lang.Object

org.spectrumauctions.sats.core.model.SATSBidder

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

All Implemented Interfaces:

java.io.Serializable, org.marketdesignresearch.mechlib.core.bidder.Bidder, org.marketdesignresearch.mechlib.instrumentation.MipInstrumentationable

Direct Known Subclasses:

MRVMLocalBidder, MRVMNationalBidder, MRVMRegionalBidder

public abstract class MRVMBidder
extends SATSBidder

Author:

Michael Weiss

See Also:

Serialized Form

Field Summary

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

DEFAULT_DEMAND_QUERY_EPSILON, DEFAULT_DEMAND_QUERY_TIME_LIMIT

Method Summary

Modifier and Type	Method	Description
protected abstract void	bidderTypeSpecificDemandQueryMIPAdjustments(MRVM_MIP mip)	Allows a specific bidder type (subclass) to change the demand query mip before execution.
java.math.BigDecimal	calculateValue(org.marketdesignresearch.mechlib.core.Bundle bundle)	Returns the value this bidder has for a specific bundle.
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
abstract java.math.BigDecimal	gammaFactor(MRVMRegionsMap.Region r, java.util.Set<MRVMLicense> bundle)	Calculates the gamma factor, as explained in the model writeup.
abstract java.util.Map<MRVMRegionsMap.Region,java.math.BigDecimal>	gammaFactors(java.util.Set<MRVMLicense> bundle)	Calculates the gamma factors for all regions.
org.marketdesignresearch.mechlib.core.allocationlimits.AllocationLimit	getAllocationLimit()
java.math.BigDecimal	getAlpha()
java.util.LinkedHashSet<org.marketdesignresearch.mechlib.core.Bundle>	getBestBundles(org.marketdesignresearch.mechlib.core.price.Prices prices, int maxNumberOfBundles, boolean allowNegative)
java.math.BigDecimal	getBeta(MRVMRegionsMap.Region region)
<T extends BiddingLanguage> T	getValueFunction(java.lang.Class<T> clazz, RNGSupplier rngSupplier)
MRVMWorld	getWorld()
java.math.BigDecimal	getzHigh(MRVMRegionsMap.Region region)
java.math.BigDecimal	getzLow(MRVMRegionsMap.Region region)
int	hashCode()
java.math.BigDecimal	omegaFactor(MRVMRegionsMap.Region r, java.math.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.
void	setAllocationLimit(org.marketdesignresearch.mechlib.core.allocationlimits.AllocationLimit allocationLimit)
ContinuousPiecewiseLinearFunction	svFunction(MRVMRegionsMap.Region region)
java.math.BigDecimal	svFunction(MRVMRegionsMap.Region region, java.math.BigDecimal c)	Calculates the sv-function [See description in paper]

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

drawSimilarBidder, getDescription, getId, getLongId, getMipInstrumentation, getName, getPopulation, getSetup, getSetupType, getShortDescription, getStrategy, getValue, getValueFunction, getValueFunction, getWorldId, setMipInstrumentation, setStrategy, store, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.marketdesignresearch.mechlib.core.bidder.Bidder

getBestBundle, getBestBundles, getUtility, getValue, getValue, getValue

Method Detail

omegaFactor

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

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

svFunction

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

Calculates the sv-function [See description in paper]

svFunction

public ContinuousPiecewiseLinearFunction svFunction(MRVMRegionsMap.Region region)

gammaFactor

public abstract java.math.BigDecimal gammaFactor(MRVMRegionsMap.Region r,
                                                 java.util.Set<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 java.util.Map<MRVMRegionsMap.Region,java.math.BigDecimal> gammaFactors(java.util.Set<MRVMLicense> bundle)

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

Parameters:

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

calculateValue

public java.math.BigDecimal calculateValue(org.marketdesignresearch.mechlib.core.Bundle bundle)

Description copied from class: SATSBidder

Returns the value this bidder has for a specific bundle.

Specified by:

calculateValue in class SATSBidder

Parameters:

bundle - the bundle for which the value is asked

Returns:

bidder specific value for this bundle

getWorld

public MRVMWorld getWorld()

Specified by:

getWorld in class SATSBidder

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 java.math.BigDecimal getzLow(MRVMRegionsMap.Region region)

getzHigh

public java.math.BigDecimal getzHigh(MRVMRegionsMap.Region region)

getAlpha

public java.math.BigDecimal getAlpha()

getBeta

public java.math.BigDecimal getBeta(MRVMRegionsMap.Region region)

getBestBundles

public java.util.LinkedHashSet<org.marketdesignresearch.mechlib.core.Bundle> getBestBundles(org.marketdesignresearch.mechlib.core.price.Prices prices,
                                                                                            int maxNumberOfBundles,
                                                                                            boolean allowNegative)

bidderTypeSpecificDemandQueryMIPAdjustments

protected abstract void bidderTypeSpecificDemandQueryMIPAdjustments(MRVM_MIP mip)

Allows a specific bidder type (subclass) to change the demand query mip before execution. I.e. restrict demand query result to items where the bidder is interested in.

Parameters:

mip -

refreshReference

public void refreshReference(World world)

Description copied from class: SATSBidder

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 SATSBidder

See Also:

SATSBidder.refreshReference(World)

getValueFunction

public <T extends BiddingLanguage> T getValueFunction(java.lang.Class<T> clazz,
                                                      RNGSupplier rngSupplier)
                                               throws UnsupportedBiddingLanguageException

Specified by:

getValueFunction in class SATSBidder

Throws:

UnsupportedBiddingLanguageException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class SATSBidder

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class SATSBidder

hashCode

public int hashCode()

Overrides:

hashCode in class SATSBidder

getAllocationLimit

public org.marketdesignresearch.mechlib.core.allocationlimits.AllocationLimit getAllocationLimit()

setAllocationLimit

public void setAllocationLimit(org.marketdesignresearch.mechlib.core.allocationlimits.AllocationLimit allocationLimit)