org.spectrumauctions.sats.core.model

Class Bidder<G extends Good>

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BMBidder, CATSBidder, GSVMBidder, LSVMBidder, MRVMBidder, SRVMBidder

public abstract class Bidder<G extends Good>
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Bidder(BidderSetup setup, long population, long id, long worldId)

Method Summary

Modifier and Type	Method and Description
abstract BigDecimal	calculateValue(Bundle<G> bundle) Returns the value this bidder has for a specific bundle.
abstract Bidder<G>	drawSimilarBidder(RNGSupplier rngSupplier)
boolean	equals(Object obj)
long	getId()
long	getPopulation()
protected BidderSetup	getSetup()
String	getSetupType()
double	getValue(Bundle<G> bundle) Deprecated.
<T extends BiddingLanguage> T	getValueFunction(Class<T> type) Use this method to get a desired value function representation (bidding language) for this bidder.
<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.
abstract <T extends BiddingLanguage> T	getValueFunction(Class<T> type, RNGSupplier rngSupplier)
abstract World	getWorld()
long	getWorldId()
int	hashCode()
abstract 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.
protected void	store()

Methods inherited from class java.lang.Object

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

Constructor Detail

Bidder

protected Bidder(BidderSetup setup,
                 long population,
                 long id,
                 long worldId)

Method Detail

getId

public long getId()

getSetupType

public String getSetupType()

Returns:

the name of the configuration (BidderSetup) with which the bidder was created.

getValue

@Deprecated
public double getValue(Bundle<G> bundle)

Deprecated.

Returns the value this bidder has for a specific bundle. Attention: May throw RuntimeExceptions if the items in the bundle are not of the correct world.

Parameters:

bundle - the bundle for which the value is asked

Returns:

bidder specific value for this bundle

calculateValue

public abstract BigDecimal calculateValue(Bundle<G> bundle)

Returns the value this bidder has for a specific bundle.

Parameters:

bundle - the bundle for which the value is asked

Returns:

bidder specific value for this bundle

getValueFunction

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

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.

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.

getValueFunction

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

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

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.

getValueFunction

public abstract <T extends BiddingLanguage> T getValueFunction(Class<T> type,
                                                               RNGSupplier rngSupplier)
                                                        throws UnsupportedBiddingLanguageException

Throws:

UnsupportedBiddingLanguageException

getPopulation

public long getPopulation()

Returns:

the population to which this bidder belongs. The population is not meaningful, if for a specific world instance, only one set of Bidders is created. However, if there are multiple sets of bidders (which should not be part of the same simulation) created, they have different population ids.

getWorld

public abstract World getWorld()

Returns:

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

store

protected void store()

refreshReference

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

getWorldId

public long getWorldId()

drawSimilarBidder

public abstract Bidder<G> drawSimilarBidder(RNGSupplier rngSupplier)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSetup

protected BidderSetup getSetup()