uk.ac.liv.auction.stats
Class GroupPayoffReport

java.lang.Object
  uk.ac.liv.auction.stats.AbstractAuctionReport
      uk.ac.liv.auction.stats.AbstractMarketStatsReport
          uk.ac.liv.auction.stats.DynamicSurplusReport
              uk.ac.liv.auction.stats.PayoffReport
                  uk.ac.liv.auction.stats.GroupPayoffReport

All Implemented Interfaces:

AuctionEventListener, AuctionReport, Parameterizable, Resetable, java.io.Serializable

public class GroupPayoffReport

extends PayoffReport

A report that lists the ratio of actual to theoretical profits of each agent group in the auction.

Version:

$Revision: 1.3 $

Author:

Steve Phelps

See Also:

AgentGroup, Serialized Form

Field Summary

Fields inherited from class uk.ac.liv.auction.stats.PayoffReport

totalProfits

Fields inherited from class uk.ac.liv.auction.stats.DynamicSurplusReport

equilibriaStats, P_QUANTITY, quantity

Fields inherited from class uk.ac.liv.auction.stats.AbstractAuctionReport

auction

Constructor Summary

GroupPayoffReport()

Method Summary

java.lang.Object	getKey(AbstractTradingAgent agent) Map an agent onto a group.
java.lang.String	getKeyName() Return user-friendly description of the space of groups.
java.lang.String	getReportText()

Methods inherited from class uk.ac.liv.auction.stats.PayoffReport

calculate, calculatePayoffs, getNumberOfAgents, getPayoff, getProfits, getTotalProfits, getVariables, initialise, produceUserOutput, setup

Methods inherited from class uk.ac.liv.auction.stats.DynamicSurplusReport

calculateTotalEquilibriumSurplus, equilibriumSurplus, eventOccurred, getEquilibriumProfits, getQuantity, recalculate, reset, setAuction, setQuantity, updateStats

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupPayoffReport

public GroupPayoffReport()

Method Detail

getKey

public java.lang.Object getKey(AbstractTradingAgent agent)

Description copied from class: PayoffReport

Map an agent onto a group.

Specified by:

getKey in class PayoffReport

Parameters:

agent - The agent to map from.

Returns:

An object representing the grouping of this agent.

getKeyName

public java.lang.String getKeyName()

Description copied from class: PayoffReport

Return user-friendly description of the space of groups.

Specified by:

getKeyName in class PayoffReport

Returns:

A string describing the grouping of this report.

getReportText

public java.lang.String getReportText()

Specified by:

getReportText in class PayoffReport