optimiser.hpp

Go to the documentation of this file.

#ifndef __OPTIMISER_H_
#define __OPTIMISER_H_

#include <optk/types.hpp>

namespace optk {

// forward declarations
class optimiser;
class optimisers;

// optk::opt_list is a list of optimisers.
typedef std::vector<optimiser *> opt_list;

class optimiser {

    public:
        optimiser (std::string name);

        ~optimiser ();

        virtual void clear ();

        std::string get_name () { return m_name; }

        // required methods ---------------------------------------------------

        virtual void update_search_space (sspace::sspace_t *space) {}

        virtual inst::set generate_parameters (int param_id) {
            return inst::set();
        }

        virtual void receive_trial_results (
            int param_id,
            inst::set params,
            double value
        ) {}

        // optional, convenience methods --------------------------------------

        void accept (optimisers *o);

    protected:

        void add_to_trials (int param_id, inst::node *n);

        std::unordered_map<int, inst::set> trials;

    private:
        std::string m_name;
        uint stepidx;

        double best_val;
        inst::set *best_params;
};

class optimisers {
    public:
        optimisers();

        void register_optimiser (optimiser *o);

        opt_list *collection();

    private:
        opt_list m_arr;
};

} // namespace optk

#endif // __OPTIMISER_H_