data_accessor_universe.hpp

Go to the documentation of this file.

#ifndef FSTDATAACCESSORUNIVERSE_H
#define FSTDATAACCESSORUNIVERSE_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 <sstream>
#include "error.hpp"
#include "global.hpp"
#include "data_accessor_splitting_mem.hpp"
 
namespace FST {

template<typename DATATYPE, typename IDXTYPE, class INTERVALCONTAINER>
class Data_Accessor_Universe : public Clonable_Impl<Data_Accessor_Universe<DATATYPE,IDXTYPE,INTERVALCONTAINER>,Data_Accessor_Splitting_Mem<DATATYPE,IDXTYPE,INTERVALCONTAINER>,CLONE_INHERIT,CLONE_WEAK_SHARING,CLONE_INHERIT>
{
        public:
                typedef Data_Accessor_Splitting_Mem<DATATYPE,IDXTYPE,INTERVALCONTAINER> DASM; 
                typedef typename DASM::DAS DAS; 
                typedef Clonable_Impl<Data_Accessor_Universe,DASM,CLONE_INHERIT,CLONE_WEAK_SHARING,CLONE_INHERIT> parent_impl;
                typedef std::shared_ptr<Data_Scaler<DATATYPE> > PScaler; 
                typedef typename DASM::PSplitters PSplitters; 
                Data_Accessor_Universe(const unsigned int n_features, const PSplitters _dsp, const PScaler _dsc) : parent_impl("",_dsp,_dsc), _n(n_features) {notify("Data_Accessor_Universe constructor.");}
                virtual ~Data_Accessor_Universe(){notify("Data_Accessor_Universe destructor.");}

                virtual void initialize() override
                {
                        if(Clonable::is_sharing_clone()) throw fst_error("Data_Accessor_Universe::initialize() called from shared_clone instance.");
                        if(_n==0) throw fst_error("Data_Accessor_Universe: the feature universe must have at least 1 feature.");
                        {std::ostringstream sos; sos << "Feature universe: " << _n << " features, no data (--features)" << std::endl; syncout::print(std::cout,sos);}
                        DAS::initialize(_n, typename DAS::CLASSSIZES()); // features=N, zero classes; no buffer, no scaling, no splitter set_n
                }
 
                // The three overrides below implement a trivial split protocol: exactly one (empty) split per
                // enumeration round. There is nothing to split, but callers iterate splits unconditionally. The
                // base machinery is bypassed on purpose: it would run the configured splitter over zero classes,
                // tripping its (correct) debug assertions in Debug builds.
                virtual bool getFirstSplit() override {DAS::enum_split[DAS::getSplittingDepth()]=1; return true;} 
                virtual bool getNextSplit() override {DAS::enum_split[DAS::getSplittingDepth()]=0; return false;} 
                virtual unsigned int getNoOfSplits() const override {return 1;} 
 
                virtual std::ostream& print(std::ostream& os) const override {os << "Data_Accessor_Universe(features=" << _n << ", data-free)"; return os;}
        protected:
                friend parent_impl; 
                Data_Accessor_Universe(const Data_Accessor_Universe &dau, int x) : parent_impl(dau, x), _n(dau._n) {};
        protected:
                unsigned int _n; 
 
                // the file hooks exist to satisfy the DASM pure-virtual contract; initialize() is
                // overridden above so the read hooks never run, and the shape hooks report the
                // honest degenerate values should diagnostics ever query them
                virtual void initial_data_read() override {} 
                virtual void initial_file_prepare() override {} 
                virtual unsigned int file_getNoOfClasses() const override {return 0;} 
                virtual unsigned int file_getNoOfFeatures() const override {return _n;} 
                virtual IDXTYPE file_getClassSize(unsigned int) const override {return 0;} 
};
 
} // namespace
#endif // FSTDATAACCESSORUNIVERSE_H ///:~