Class sdm::Algorithm

Class List > sdm > Algorithm

The public interface common to all algorithms in SDM'Studio .More...

  • #include <algorithm.hpp>

Inherited by the following classes: sdm::AlphaStar, sdm::BackwardInduction, sdm::HSVI, sdm::QLearning, sdm::ValueIteration

Public Functions

Type Name
virtual void do_initialize () = 0
Initialize the algorithm.
virtual void do_save () = 0
Save the policy in a file.
virtual void do_solve () = 0
Solve the problem.
virtual void do_test () = 0
Test the result of the algorithm.
virtual double getResult () = 0
virtual int getTrial () = 0
virtual ~Algorithm ()

Detailed Description

Basic usage:

std::shared_ptr<Algorithm> algo = std::make_shared<AlgoName>(params...);
algo->do_initialize();
algo->do_solve();

Public Functions Documentation

function do_initialize

virtual void sdm::Algorithm::do_initialize () = 0

function do_save

virtual void sdm::Algorithm::do_save () = 0

function do_solve

virtual void sdm::Algorithm::do_solve () = 0

function do_test

virtual void sdm::Algorithm::do_test () = 0

function getResult

virtual double sdm::Algorithm::getResult () = 0

function getTrial

virtual int sdm::Algorithm::getTrial () = 0

function ~Algorithm

inline virtual sdm::Algorithm::~Algorithm () 

The documentation for this class was generated from the following file src/sdm/public/algorithm.hpp