net.sourceforge.jasa.report
Class PayoffReport

java.lang.Object
  net.sourceforge.jasa.report.AbstractAuctionReport
      net.sourceforge.jasa.report.AbstractMarketStatsReport
          net.sourceforge.jasa.report.DynamicSurplusReport
              net.sourceforge.jasa.report.PayoffReport

All Implemented Interfaces:

java.io.Serializable, AuctionReport

Direct Known Subclasses:

AgentPayoffReport, GroupPayoffReport, StrategyPayoffReport

public abstract class PayoffReport
extends DynamicSurplusReport
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

protected java.util.HashMap<java.lang.Object,net.sourceforge.jasa.report.PayoffStats>

table Maps keys representing groups onto the PayoffStats for that group.

Fields inherited from class net.sourceforge.jasa.report.DynamicSurplusReport

efficiency, equilibriaStats, P_DEF_BASE, P_QUANTITY, quantity, VAR_EFFICIENCY

Fields inherited from class net.sourceforge.jasa.report.AbstractAuctionReport

auction

Constructor Summary

PayoffReport()

Method Summary

void	calculate() Perform final calculations at the end of the market.
abstract java.lang.Object	getKey(AbstractTradingAgent agent) Map an agent onto a group.
abstract java.lang.String	getKeyName() Return user-friendly description of the space of groups.
double	getMeanPayoff(java.lang.Object key)
int	getNumberOfAgents(java.lang.Object key)
SummaryStats	getPayoffDistribution(java.lang.Object key)
double	getProfits(java.lang.Object key)
abstract java.lang.String	getReportText()
java.util.Map<java.lang.Object,java.lang.Number>	getVariableBindings()
void	initialise()
void	produceUserOutput()

Methods inherited from class net.sourceforge.jasa.report.DynamicSurplusReport

calculateTotalEquilibriumSurplus, calculateTotalProfits, compute, equilibriumSurplus, getEfficiency, getEquilibriumProfits, getQuantity, reset, setAuction, setQuantity, updateStats

Methods inherited from class net.sourceforge.jasa.report.AbstractMarketStatsReport

eventOccurred

Methods inherited from class net.sourceforge.jasa.report.AbstractAuctionReport

getAuction, getName

Methods inherited from class java.lang.Object

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

Field Detail

table

protected java.util.HashMap<java.lang.Object,net.sourceforge.jasa.report.PayoffStats> table

Maps keys representing groups onto the PayoffStats for that group.

Constructor Detail

PayoffReport

public PayoffReport()

Method Detail

calculate

public void calculate()

Description copied from class: AbstractMarketStatsReport

Perform final calculations at the end of the market.

Overrides:

calculate in class DynamicSurplusReport

getProfits

public double getProfits(java.lang.Object key)

getMeanPayoff

public double getMeanPayoff(java.lang.Object key)

getNumberOfAgents

public int getNumberOfAgents(java.lang.Object key)

getPayoffDistribution

public SummaryStats getPayoffDistribution(java.lang.Object key)

produceUserOutput

public void produceUserOutput()

Overrides:

produceUserOutput in class DynamicSurplusReport

getVariableBindings

public java.util.Map<java.lang.Object,java.lang.Number> getVariableBindings()

Overrides:

getVariableBindings in class DynamicSurplusReport

initialise

public void initialise()

Overrides:

initialise in class DynamicSurplusReport

getKey

public abstract java.lang.Object getKey(AbstractTradingAgent agent)

Map an agent onto a group.

Parameters:

agent - The agent to map from.

Returns:

An object representing the grouping of this agent.

getKeyName

public abstract java.lang.String getKeyName()

Return user-friendly description of the space of groups.

Returns:

A string describing the grouping of this historicalDataReport.

getReportText

public abstract java.lang.String getReportText()