Package sudoku

Interface Summary

Interface	Description
Player.InitialisationProtocol	Protocol interface for messages for initialisation strategy.
Player.Protocol	Protocol interface for input messages.
SharedProtocols.AssessmentProtocol	Protocol for rewarding Players by the Teacher.
SharedProtocols.InspectionProtocol	Protocol for inspecting the Player by the Teacher, initiated by Supervisor.
SharedProtocols.NegotiationsProtocol	Protocol for negotiations between the Player and the Table.
SharedProtocols.NewIterationProtocol	Protocol for starting new iteration by the Teacher, affecting both the Player and the Table.
SharedProtocols.RegisteringProtocol	Protocol for registering both the Player and the Table by the Teacher.
SharedProtocols.TimeMeasurementProtocol	Protocol between TimerManager and Timers, used when some time is measured in parallel.
SharedProtocols.ValidationProtocol	Protocol for agents' validation with help of the Timer agent.
SudokuSupervisor.Protocol	Abstract interface for all commands (messages) passed to the Agent.
Table.InitialisationProtocol	Protocol interface for messages for initialisation strategy
Table.Protocol	Protocol interface for input messages.
Teacher.Protocol	Protocol interface for input messages.
Timer.Protocol	Protocol interface for input messages.
TimerManager.Protocol	Protocol interface for input messages.

Class Summary

Class	Description
AgentMap<T>	Map from global Table id to internal index and Table reference.
Pair<T1,T2>
Player	Playing agent, who actually learns to solve Sudoku.
Player.AdditionalInfoRequestMsg	Message received from the Table, requesting for additional info about other stakeholder's(s') digit.
Player.ConsentToStartIterationMsg	Message allowing the agent to start new iteration by sending new offers.
Player.CreateMsg	Message for creating the Player.
Player.GrantRewardMsg	Message from the Teacher granting the Player reward (or punishment if negative) for its choices.
Player.MemorisedDigitsRequestMsg	Message - request for memorised Digits and Masks for given Table IDs by the Player.
Player.NegotiationsFinishedMsg	Message received when the Table announces finish of the negotiations.
Player.NegotiationsMsg	Abstract class for messages received from Table Agent during negotiations.
Player.NegotiationsPositiveMsg	Message received when the Table announces positive result of the negotiations.
Player.RegisterTableMsg	Message for registering a Table.
Player.RejectOfferMsg	Message received when Player's offer is rejected, requesting for new offer.
Player.ResetMemoryMsg	Message commanding the agent to reset it's memory due to start of new iteration.
Player.ResetMemorySoftlyMsg	Message commanding the agent to reset it's memory softly due to start of new mini-iteration.
Player.WakeUpMsg	Message received from the Table when agent is not responding.
PlayerMemory
PlayerMemory.WeightValuePair
Position
SharedProtocols	Class of protocols for exchanged messages between different types of agents.
Sudoku	Class representing Sudoku riddle.
SudokuStart	Starting point of the whole application.
SudokuSupervisor	Simple agent-guardian of the whole multi-agent-system solving Sudoku.
SudokuSupervisor.IterationFinishedMsg	Message received from the Teacher on every iteration's finish, containing new solution of the Sudoku riddle.
SudokuSupervisor.SimulateTeacherCrashMsg	Message for making the Teacher crash.
SudokuSupervisor.TeacherWillRestartMsg	Message when Teacher is going to be restarted.
SudokuSupervisor.TerminateMsg	Message for controlled termination of the agent.
Table	Table agent, who moderates negotiations between 3 players for choosing the best number in the Sudoku cell.
Table.AcceptNegotiationsResultsMsg	Message telling that the Player accepted negotiations results.
Table.AdditionalInfoMsg	Message received from the Player, consisting of it's subjective weights of requested digits.
Table.CreateMsg	Message for creating the Table.
Table.NegotiationsMsg	Abstract class for messages received from the Player during negotiations.
Table.OfferMsg	Message received from the Player, consisting of it's subjectively the best digit to be inserted
Table.PlayerIsDeadMsg	Message received from the Player when agent is about to crash.
Table.RegisterPlayerMsg	Message for registering a Player.
Table.ResetMemoryMsg	Message commanding the agent to reset it's memory due to start of new iteration.
Table.WakeUpMsg	Message received from the Teacher when agent is not responding.
Table.WithdrawOfferMsg	Message received when the Player withdraws it's present offer.
TableMemory
TableOffer
Teacher	Agent that interprets development of the playing agents and rewards them.
Teacher.CreateMsg	Message for creating the Teacher.
Teacher.InspectChildDigitsMsg	Message commanding the Teacher to inspect it's Players' digits.
Teacher.IterationTimeoutMsg	Reply from the TimerManager, announcing that Teacher's tables are not responding.
Teacher.MemorisedDigitsMsg	Reply for a request for memorised Digits and Masks by the Player.
Teacher.PerformedMemoryResetMsg	The agent reports to the Teacher that it had performed reset of it's memory.
Teacher.PlayerPerformedMemoryResetMsg	The Player's version of PerformedMemoryResetMsg.
Teacher.RegisteredMsg	Message received after registering an agent.
Teacher.RegisteredPlayerMsg	Message received after registering a Player.
Teacher.RegisteredTableMsg	Message received after registering a Table.
Teacher.RewardReceivedMsg	Reply from the Player after granting it new reward.
Teacher.SimulateCrashMsg	Message for making the Teacher crash.
Teacher.TableFinishedNegotiationsMsg	Message reporting negotiation's finish for a one of Tables, providing solution - a digit
Teacher.TablePerformedMemoryResetMsg	The Table's version of PerformedMemoryResetMsg.
Teacher.TablesAreNotRespondingMsg	Reply from the TimerManager, announcing that Teacher's tables are not responding.
TeacherMemory
Timer	Simple reactive agent that replies after some time.
Timer.CreateMsg	Message creating the agent, as well as starting the countdown.
TimerManager	Agent that manages Timers (in parallel), responding to the Teacher.
TimerManager.CreateMsg	Message creating the agent.
TimerManager.NewIterationStartedMsg	Message from the Teacher announcing new big iteration.
TimerManager.RemindToCheckTablesMsg	Message from the Teacher waking him up after passing given time to check if its Tables are still alive.
TimerManager.TimePassedMsg	Message from the Timer announcing that given time has passed.

Enum Summary

Enum	Description
PlayerMemory.MaskState	Definition of sudoku field mask.

Exception Summary

Exception	Description
Player.BadFinishException	Custom exception thrown when Table finishes negotiations with a digit different from what was offered.
Player.BadRejectionException	Custom exception thrown when a Player receives RejectOfferMsg with a different digit it offered.
Player.DoubleFinishException	Custom exception thrown when Player receives NegotiationsFinishedMsg with the same digit from more than one Table.
Player.IncorrectRegisterException	Custom exception thrown when excessive Table is about to be registered to this Player
Sudoku.DigitImmutableException	Custom exception thrown when trying to modify hard-coded sudoku field.
Sudoku.DigitOutOfRangeException	Custom exception thrown when a board digit is negative or greater than sudoku rank (0 indicates an empty field).
Sudoku.IncorrectBoardSizeException	Custom exception thrown when trying to initialize board with incorrect size.
Table.IncorrectRegisterException	Custom exception thrown when 4th Player is about to be registered to this table.
TableMemory.OverwriteOfferException	Custom exception thrown when a Player is about to offer a digit the second time before rejection or withdrawal