search_seq.hpp

Go to the documentation of this file.

#ifndef FSTSEARCHSEQ_H
#define FSTSEARCHSEQ_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 <cassert>
#include <iostream>
#include <sstream>
#include "error.hpp"
#include "global.hpp"
#include "search.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 {

enum SearchDirection {
  UNDEFINED=0,
  FORWARD=1,
  BACKWARD=2
};

template<class RETURNTYPE, typename DIMTYPE, class SUBSET, class CRITERION, class EVALUATOR>
class Search_Sequential : public Search<RETURNTYPE,DIMTYPE,SUBSET,CRITERION>{ // abstract class
public:
        typedef Search<RETURNTYPE,DIMTYPE,SUBSET,CRITERION> parent; 
        typedef std::shared_ptr<EVALUATOR> PEvaluator; 
        typedef std::shared_ptr<CRITERION> PCriterion; 
        typedef std::shared_ptr<SUBSET> PSubset; 
        Search_Sequential(const PEvaluator evaluator):Search<RETURNTYPE,DIMTYPE,SUBSET,CRITERION>(), _generalization_level(1), _initial_subset_enabled(false) {assert(evaluator); _evaluator=evaluator; notify("Search_Sequential constructor.");} 
        virtual ~Search_Sequential() {notify("Search_Sequential destructor.");}
 
        // NOTE: crit is expected to be already initialize()d before use here
        virtual bool search(const DIMTYPE target_d, RETURNTYPE &result, const PSubset sub, const PCriterion crit, std::ostream& os) override =0; 
        
        inline bool Step(const bool forward, RETURNTYPE &result, const PSubset sub, const PCriterion crit, std::ostream& os=std::cout);
 
        void set_generalization_level(const DIMTYPE g) {if(g>=1) _generalization_level=g;} 
        DIMTYPE get_generalization_level() const {return _generalization_level;} 
 
        // to be used only if the search is intended to be started from a pre-specified initial subset, otherwise the standard FORWARD methods start from empty set and BACKWARD methods start from full set
        void enable_initial_subset() {_initial_subset_enabled=true;} 
        void disable_initial_subset() {_initial_subset_enabled=false;} 
        bool initial_subset_enabled() const {return _initial_subset_enabled;} 
 
protected:
        PEvaluator _evaluator; 
        DIMTYPE _generalization_level; 
        bool _initial_subset_enabled; 
};
 
 
template<class RETURNTYPE, typename DIMTYPE, class SUBSET, class CRITERION, class EVALUATOR>
bool Search_Sequential<RETURNTYPE,DIMTYPE,SUBSET,CRITERION,EVALUATOR>::Step(const bool forward, RETURNTYPE &result, const PSubset sub, const PCriterion crit, std::ostream& os) // modifies sub, returns the evaluator's success flag
{
        assert(_evaluator);
        assert(sub);
        assert(crit);
 
        if(parent::output_detailed()) this->report(os, msgbuf() << "Search_Sequential::Step(): sub->get_d()="<<sub->get_d()<<" forward="<<forward <<" sub=" << *sub<<std::endl);
 
        bool success=true;
        bool _mode_change=(sub->get_forward_mode()!=forward);
 
        if(_mode_change) sub->set_forward_mode(forward);
        if(!_evaluator->evaluate_candidates(result, sub, crit, _generalization_level,os)) success=false;
        if(_mode_change) sub->set_forward_mode(!forward);
 
        return success;
}
 
 
} // namespace
#endif // FSTSEARCHSEQ_H ///:~