candidate_evaluator.hpp

Go to the documentation of this file.

#ifndef FSTCANDIDATEEVALUATOR_H
#define FSTCANDIDATEEVALUATOR_H
 /*
=========================================================================
Copyright and license:
  * FST4 software (with the exception of any bundled or externally linked
    third-party components) is Copyright (C) 2000-present Institute of
    Information Theory and Automation of the Czech Academy of Sciences (UTIA).
  * FST4 is free software: you can redistribute it and/or modify it under
    the terms of the GNU Affero General Public License as published by the
    Free Software Foundation, version 3. The full text of the license is in
    the file LICENSE in the distribution root and at
    https://www.gnu.org/licenses/agpl-3.0.html.
  * FST4 is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
    License for more details.
  * Closed-source use without the AGPL's copyleft obligations requires a
    commercial license from UTIA; in case of interest write to
    utia@utia.cas.cz. LICENSING.md in the distribution root explains both
    options, the contributor license agreement that every contribution
    requires, and the contacts (technical questions and pull requests:
    somol@utia.cas.cz, with "FST" in the subject line).
========================================================================== */
 
#include <memory>
#include <functional>
#include <iostream>
#include "error.hpp"
#include "global.hpp"
#include "result_tracker.hpp"
 
namespace FST {

template<class RETURNTYPE, typename DIMTYPE, class SUBSET, class CRITERION>
class Candidate_Evaluator {
public:
        typedef std::shared_ptr<CRITERION> PCriterion;             
        typedef std::shared_ptr<SUBSET> PSubset;                   
        typedef std::shared_ptr<Result_Tracker<RETURNTYPE,SUBSET> > PResultTracker; 
        typedef std::function<bool(SUBSET&)> Generator;
        typedef std::function<void(const RETURNTYPE, const PSubset&, const DIMTYPE)> ResultCallback;
        typedef std::function<void(const int, const unsigned long long, const RETURNTYPE, const PSubset&)> BestCallback;
        typedef std::function<bool(const RETURNTYPE, const PSubset&, const RETURNTYPE, const PSubset&)> BetterPredicate;
 
        virtual ~Candidate_Evaluator() {}
 
        virtual unsigned int get_max_threads() const =0; 
        virtual bool is_threaded() const =0; 
 
        // batch mode
        // NOTE: crit is expected to be already initialize()d before use here
        virtual void initialize(const PCriterion &crit, const DIMTYPE max_candidates, ResultCallback on_result=ResultCallback()) =0; 
        virtual bool add_candidate(const PSubset &sub, const DIMTYPE feature=0) =0; 
        virtual bool collect() =0; 
        virtual bool getBestResult(RETURNTYPE &result, PSubset &sub, DIMTYPE &feature) =0; 
 
        // streaming mode
        // NOTE: crit is expected to be already initialize()d before use here
        virtual bool evaluate_stream(Generator generator, const PCriterion &crit, const PResultTracker tracker, BetterPredicate better, BestCallback on_best, RETURNTYPE &result, const PSubset bestsub) =0;
 
        virtual std::ostream& print(std::ostream& os) const {return os;} 

        virtual void invalidate_clones() {}
};

template<class RETURNTYPE, typename DIMTYPE, class SUBSET, class CRITERION>
inline std::ostream& operator<<(std::ostream& os, const Candidate_Evaluator<RETURNTYPE,DIMTYPE,SUBSET,CRITERION>& ce) {
        return ce.print(os);
}
 
} // namespace
#endif // FSTCANDIDATEEVALUATOR_H ///:~