search.hpp

Go to the documentation of this file.

#ifndef FSTSEARCH_H
#define FSTSEARCH_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 <iostream>
#include <sstream>
#include <string>
#include <ctime>
#include "error.hpp"
#include "global.hpp"
#include "result_tracker.hpp"
 
/*============== Template parameter type naming conventions ==============
--------- Numeric types: -------------------------------------------------
DATATYPE - data sample values - usually real numbers (but may be integers
          in text processing etc.)
REALTYPE - must be real numbers - for representing intermediate results of 
          calculations like mean, covariance etc.
IDXTYPE - index values for enumeration of data samples - (nonnegative) integers, 
          extent depends on numbers of samples in data
DIMTYPE - index values for enumeration of features (dimensions), or classes (not 
          class sizes) - (nonnegative) integers, usually lower extent than IDXTYPE, 
          but be aware of expressions like _classes*_features*_features ! 
          in linearized representations of feature matrices for all classes
BINTYPE - feature selection marker type - represents ca. <10 different feature 
          states (selected, deselected, sel./desel. temporarily 1st nested loop, 2nd...)
RETURNTYPE - criterion value: real value, but may be extended in future to support 
          multiple values 
--------- Class types: ---------------------------------------------------
SUBSET       - class of class type Subset 
CLASSIFIER   - class implementing interface defined in abstract class Classifier 
EVALUATOR    - class implementing interface defined in abstract class Sequential_Step 
DISTANCE     - class implementing interface defined in abstract class Distance 
DATAACCESSOR - class implementing interface defined in abstract class Data_Accessor 
INTERVALCONTAINER - class of class type Data_Intervaller 
CONTAINER    - STL container of class type Data_Interval  
========================================================================== */
 
namespace FST {

class msgbuf {
public:
        template<class T> msgbuf& operator<<(const T& t) {_s<<t; return *this;} 
        msgbuf& operator<<(std::ostream& (*manip)(std::ostream&)) {_s<<manip; return *this;} 
        std::ostream& stream() {return _s;} 
        std::string str() const {return _s.str();} 
private:
        std::ostringstream _s; 
};

template<class RETURNTYPE, class SUBSET>
class Search_Observer {
public:
        typedef std::shared_ptr<SUBSET> PSubset;                  
        virtual ~Search_Observer() {}
        virtual void on_progress(const std::string &msg) {} 
        virtual void on_solution(const RETURNTYPE value, const SUBSET &sub, const std::string &msg) {} 
};
 
template<class RETURNTYPE, typename DIMTYPE, class SUBSET, class CRITERION>
class Search;
 
template<class RETURNTYPE, typename DIMTYPE, class SUBSET, class CRITERION>
std::ostream& operator<<(std::ostream& os, const Search<RETURNTYPE,DIMTYPE,SUBSET,CRITERION>& sr);

template<class RETURNTYPE, typename DIMTYPE, class SUBSET, class CRITERION>
class Search { // abstract class
        friend std::ostream& operator<< <>(std::ostream& os, const Search<RETURNTYPE,DIMTYPE,SUBSET,CRITERION>& sr);
public:
        typedef std::shared_ptr<CRITERION> PCriterion;             
        typedef std::shared_ptr<SUBSET> PSubset;                   
        typedef std::shared_ptr<Result_Tracker<RETURNTYPE,SUBSET> > PResultTracker; 
        Search(): _detail(NORMAL) {}
        virtual ~Search() {}

        virtual bool search(const DIMTYPE target_d, RETURNTYPE &result, const PSubset sub, const PCriterion crit, std::ostream& os) =0;
 
        void enable_result_tracking(PResultTracker tracker) {_tracker=tracker;} 
        void disable_result_tracking() {_tracker.reset();} 
        bool result_tracker_active() const {return _tracker.get()!=0;} 
 
        void set_output_detail(OutputDetail detail) {_detail=detail;} 
        OutputDetail get_output_detail() const {return _detail;} 
        bool output_normal() const {return _detail==NORMAL || _detail==DETAILED;} 
        bool output_detailed() const {return _detail==DETAILED;} 
 
        typedef Search_Observer<RETURNTYPE,SUBSET> OBSERVER;      
        typedef std::shared_ptr<OBSERVER> PObserver;              
        void set_observer(PObserver observer) {_observer=observer;} 
 
        virtual std::ostream& print(std::ostream& os) const {return os;} 
 
protected:
        void report(std::ostream& os, const msgbuf &m) const {
                if(_observer) _observer->on_progress(m.str());
                else {std::ostringstream sos; sos<<m.str(); syncout::print(os,sos);}
        }

        void report_solution(std::ostream& os, const RETURNTYPE value, const SUBSET &sub, const msgbuf &m) const {
                if(_observer) _observer->on_solution(value,sub,m.str());
                else {std::ostringstream sos; sos<<m.str(); syncout::print(os,sos);}
        }
        PResultTracker _tracker;   
        OutputDetail _detail;      
        PObserver _observer;       
};

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