org.spectrumauctions.sats.core.model.bvm

Class BMBidder

java.lang.Object

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

org.spectrumauctions.sats.core.model.bvm.BMBidder

All Implemented Interfaces:

Serializable, GenericValueBidder<BMBand>

public final class BMBidder
extends Bidder<BMLicense>
implements GenericValueBidder<BMBand>

Author:

Michael Weiss

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BMBidder(long population, int bidderId, BMWorld world, BMBidderSetup setup, UniformDistributionRNG rng) Create a new bidder.

Method Summary

Modifier and Type	Method and Description
BigDecimal	calculateValue(Bundle<BMLicense> bundle) Returns the value this bidder has for a specific bundle.
BigDecimal	calculateValue(Map<BMBand,Integer> genericQuantities)
boolean	equals(Object obj)
BigDecimal	getBaseValue(BMBand band)
<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.
BMWorld	getWorld()
int	hashCode()
int	highestSynergyQuantity(BMBand band)
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.
BigDecimal	synergyFactor(BMBand band, int quantity) Returns the synergy factor for a given band and quantity.

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

Constructor Detail

BMBidder

public BMBidder(long population,
                int bidderId,
                BMWorld world,
                BMBidderSetup setup,
                UniformDistributionRNG rng)

Create a new bidder. The use of this constructor is not recommended. Use BMWorld.createPopulation(java.util.Collection) instead, to create new bidder sets.

Method Detail

calculateValue

public BigDecimal calculateValue(Bundle<BMLicense> bundle)

Description copied from class: Bidder

Returns the value this bidder has for a specific bundle.

Specified by:

calculateValue in class Bidder<BMLicense>

Parameters:

bundle - the bundle for which the value is asked

Returns:

bidder specific value for this bundle

See Also:

Bidder.getValue(Bundle)

synergyFactor

public BigDecimal synergyFactor(BMBand band,
                                int quantity)

Returns the synergy factor for a given band and quantity. Special Cases (rules apply in this order):
- returns 1 for quantity 1
- returns 0 for quantity 0
- If no synergy factors stored for band, returns 1
- The highest explicitely stored quantity is defined as the upper limit of items with synergies, see highestSynergyQuantity(BMBand).
- If quantity has no specified synergy factor, the synergy factor for next lower known quantity is returned.

getBaseValue

public BigDecimal getBaseValue(BMBand band)

highestSynergyQuantity

public int highestSynergyQuantity(BMBand band)

Returns:

the maximal number of items within a band, for which synergies apply. For additional items in the same band, only their base value (without synergies) is added to the total value, if they are not excluded by the positiveValueThreshold.

getWorld

public BMWorld getWorld()

Specified by:

getWorld in class Bidder<BMLicense>

Returns:

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

See Also:

Bidder.getWorld()

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<BMLicense>

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.

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<BMLicense>

See Also:

Bidder.refreshReference(World)

hashCode

public int hashCode()

Overrides:

hashCode in class Bidder<BMLicense>

equals

public boolean equals(Object obj)

Overrides:

equals in class Bidder<BMLicense>

calculateValue

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

Specified by:

calculateValue in interface GenericValueBidder<BMBand>