SGSolve
SGSolution_PencilSharpening Class Reference

Records the progress of SGSolver::solve(). More...

#include <sgsolution_pencilsharpening.hpp>

Collaboration diagram for SGSolution_PencilSharpening:

Public Member Functions

 SGSolution_PencilSharpening ()
 Default constructor.
 
 SGSolution_PencilSharpening (const SGGame &_game)
 Initializes an SGSolution object with a copy of the SGGame _game.
 
const SGGamegetGame () const
 Get method for the game.
 
const list< SGIteration_PencilSharpening > & getIterations () const
 Get method for the iterations.
 
const list< SGTuple > & getExtremeTuples () const
 Get method for the extremeTuples.
 
void clear ()
 
void push_back (const SGIteration_PencilSharpening &iteration)
 Adds a new iteration to the back of SGSolution::iterations.
 
void push_back (const SGTuple &tuple)
 Adds a new tuple to the back of SGSolution::extremeTuples.
 
void pop_back ()
 Pops the last tuple off of SGSolution::extremeTuples.
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 Serializes the SGSolution object using boost.
 

Static Public Member Functions

static void save (const SGSolution_PencilSharpening &soln, const char *filename)
 Static method for saving an SGSolution object to the file filename.
 
static void load (SGSolution_PencilSharpening &soln, const char *filename)
 Static method for loading an SGSolution object from the file filename.
 

Private Attributes

SGGame game
 
list< SGIteration_PencilSharpeningiterations
 
list< SGTupleextremeTuples
 

Friends

class boost::serialization::access
 

Detailed Description

Records the progress of SGSolver::solve().

This class contains a copy of the game used by SGSolver, a list of iterations and a list of extreme tuples generated by SGSolver::solve().

Part of the pencil-sharpening algorithm.

Member Function Documentation

◆ clear()

void SGSolution_PencilSharpening::clear ( )
inline

Resets the SGSolution object by clearing the iterations and extremeTuples lists.

Member Data Documentation

◆ extremeTuples

list<SGTuple> SGSolution_PencilSharpening::extremeTuples
private

The trajectory of the pivot tuple generated by SGSolver::solve().

◆ game

SGGame SGSolution_PencilSharpening::game
private

The game that was solved.

◆ iterations

list<SGIteration_PencilSharpening> SGSolution_PencilSharpening::iterations
private

A list of SGIteration objects tracking the progress of SGSolver::solve().


The documentation for this class was generated from the following file: