ModelData.m

Go to the documentation of this file.

namespace data{


/* (Autoinserted by mtoc++)
 * This source code has been filtered by the mtoc++ executable,
 * which generates code that can be processed by the doxygen documentation tool.
 *
 * On the other hand, it can neither be interpreted by MATLAB, nor can it be compiled with a C++ compiler.
 * Except for the comments, the function bodies of your M-file functions are untouched.
 * Consequently, the FILTER_SOURCE_FILES doxygen switch (default in our Doxyfile.template) will produce
 * attached source files that are highly readable by humans.
 *
 * Additionally, links in the doxygen generated documentation to the source code of functions and class members refer to
 * the correct locations in the source code browser.
 * However, the line numbers most likely do not correspond to the line numbers in the original MATLAB source files.
 */

class ModelData
  :public data.FileData {
    private: /* ( Constant ) */

        static const FileTrajectoryDataFolder = "trajectories";

        static const FileTrajectoryIncompleteDataFolder = "trajectories_incomplete";

        static const FileTrajectoryFxiDataFolder = "trajectories_fx";

        static const SimCacheDataFolder = "simcache";

        
    public:

        matrix ParamSamples = "[]";
        data.ATrajectoryData TrajectoryData = "[]";
        data.ATrajectoryData TrajectoryIncompleteData = "[]";
        data.FileDataCollection TrajectoryFxiData = "[]";
        matrix<double> InputSpaceSpan = "[]";
        data.ApproxTrainData ApproxTrainData = "[]";
        data.ApproxTrainData JacobianTrainData = "[]";
        colvec<data.ProjectionSpace> ProjectionSpaces;
        struct JacSimTransData = struct;
    public:

        SimCache;

        
    public: /* ( Dependent ) */

        SampleCount;
    public: /* ( Dependent ) */

        ModelData(varargin) {
            if isempty(varargin)
                data_dir = fullfile(KerMor.App.TempDirectory,sprintf(" temp_md_%s ",...
                    IDGenerator.generateID));
            elseif isa(varargin[1]," models.BaseFullModel ")
                m = varargin[1];
                basedir = KerMor.App.DataDirectory;
                if length(varargin) > 1 && ischar(varargin[2])
                    basedir = varargin[2];
                end
                data_dir = fullfile(basedir,sprintf(" %s_id-%s ",m.SaveTag,m.ID));
            elseif ischar(varargin[1])
                data_dir = varargin[1];
            else
                error(" Invalid argument: %s ",class(varargin[1]));
            end
            this = this@data.FileData(data_dir);
            /*  Init with default memory data storages */
            this.TrajectoryData= data.MemoryTrajectoryData;
            this.TrajectoryIncompleteData= data.MemoryTrajectoryData;
            this.TrajectoryFxiData= data.MemoryTrajectoryData;

            /* % Sim cache is FileTrajectoryData by default */
            this.SimCache= data.FileTrajectoryData(fullfile(data_dir,this.SimCacheDataFolder));
            /*  Dont force uniform trajectory lengths for simulation cache */
            this.SimCache.UniformTrajectories= false;
        }
        function  addProjectionSpace(V,W,dims) {
            if ~isa(V," data.FileMatrix ")
                V = data.FileMatrix(V," Dir ",this.DataDirectory);
            end
            if ~isempty(W) && ~isa(W," data.FileMatrix ")
                W = data.FileMatrix(W," Dir ",this.DataDirectory);
            end
            s = data.ProjectionSpace(V,W,dims);
            if isempty(this.ProjectionSpaces)
                this.ProjectionSpaces= s;
            else
                this.ProjectionSpaces(end+1) = s;
            end
        }
        function matrix<double>mu = getParams(rowvec<int32> idx) {
            mu = [];
            if ~isempty(idx) && all(idx > 0) && all(idx < size(this.ParamSamples,2)+1)
                mu = this.ParamSamples(:,idx);
            else
                /* warning('models:ModelData','No parameter found for idx %d',idx); */
            end
        }
        function idx = getSampleIndex(colvec<double> mu) {
            idx = [];
            for n=1:this.SampleCount
                if all(abs(this.ParamSamples(:,n) - mu) < sqrt(eps))
                    idx = n;
                    return;
                end
            end
        }
        function  delete() {
            this.ProjectionSpaces= [];
            this.SimCache= [];
            this.TrajectoryData= [];
            this.TrajectoryIncompleteData= [];
            this.TrajectoryFxiData= [];
            this.ApproxTrainData= [];
            this.JacobianTrainData= [];
            if ~isempty(this.JacSimTransData)
                this.JacSimTransData.VFull= [];
            end
            delete@data.FileData(this);
        }


        function  relocate(char new_dir) {
            if nargin < 2
                new_dir = Utils.getDir(" Please specify the directory ",KerMor.App.DataDirectory);
                if new_dir == 0
                    fprintf(2," No directory selected. Aborting.\n ");
                    return;
                end
            end

            if ~isempty(this.TrajectoryData) && isa(this.TrajectoryData," data.FileData ")
                this.TrajectoryData.relocate(...
                    fullfile(new_dir,this.FileTrajectoryDataFolder));
            end
            if ~isempty(this.TrajectoryIncompleteData) && isa(this.TrajectoryIncompleteData," data.FileData ")
                this.TrajectoryIncompleteData.relocate(...
                    fullfile(new_dir,this.FileTrajectoryIncompleteDataFolder));
            end
            if ~isempty(this.TrajectoryFxiData) && isa(this.TrajectoryFxiData," data.FileData ")
                this.TrajectoryFxiData.relocate(...
                    fullfile(new_dir,this.FileTrajectoryFxiDataFolder));
            end
            if ~isempty(this.SimCache) && isa(this.SimCache," data.FileData ")
                this.SimCache.relocate(...
                    fullfile(new_dir,this.SimCacheDataFolder));
            end
            if ~isempty(this.ApproxTrainData)
                this.ApproxTrainData.relocate(new_dir);
            end
            if ~isempty(this.JacobianTrainData)
                this.JacobianTrainData.relocate(new_dir);
            end
            if ~isempty(this.ProjectionSpaces)
                for k=1:length(this.ProjectionSpaces)
                    this.ProjectionSpaces(k).relocate(new_dir);
                end
            end
            relocate@data.FileData(this, new_dir);
        }
        function  useFileTrajectoryData(logical overwrite) {
            if nargin < 2
                overwrite = false;
            end

            /*  complete trajectories */
            if ~overwrite && isa(this.TrajectoryData," data.FileTrajectoryData ")
                error(" TrajectoryData already is a data.FileTrajectoryData. Use 'true' parameter to overwrite. ");
            end
            old = this.TrajectoryData;
            this.TrajectoryData= [];
            this.TrajectoryData= data.FileTrajectoryData(...
                fullfile(this.DataDirectory,this.FileTrajectoryDataFolder));
            /*  Copy existing data */
            this.TrajectoryData.transferFrom(old);

            /*  incomplete trajectories */
            if ~overwrite && isa(this.TrajectoryIncompleteData," data.FileTrajectoryData ")
                error(" TrajectoryIncompleteData already is a data.FileTrajectoryData. Use 'true' parameter to overwrite. ");
            end
            old = this.TrajectoryIncompleteData;
            this.TrajectoryIncompleteData= [];
            this.TrajectoryIncompleteData= data.FileTrajectoryData(...
                fullfile(this.DataDirectory,this.FileTrajectoryIncompleteDataFolder));
            /*  Copy existing data */
            this.TrajectoryIncompleteData.transferFrom(old);

            /*  trajectory fxi data */
            if ~overwrite && isa(this.TrajectoryFxiData," data.FileTrajectoryData ")
                error(" TrajectoryFxiData already is a data.FileTrajectoryData. Use 'true' parameter to overwrite. ");
            end
            old = this.TrajectoryFxiData;
            this.TrajectoryFxiData= [];
            this.TrajectoryFxiData= data.FileTrajectoryData(...
                fullfile(this.DataDirectory,this.FileTrajectoryFxiDataFolder));
            /*  Copy existing data */
            this.TrajectoryFxiData.transferFrom(old);            
        }
        function [doublet , matrix<double>y , colvec<double>mu , integerinputidx , ct ] = getCachedTrajectory(nr) {
            [y, mu, inputidx, ct] = this.SimCache.getTrajectoryNr(nr);
            t = 0:mu(2):mu(1);
            mu = mu(3:end);
        }
    protected: /* ( Static ) */ /* ( Dependent ) */

        static function this = loadobj() {
            if ~isa(this," data.ModelData ")
                initfrom = this;
                this = data.ModelData(initfrom.fDataDir);
                this = loadobj@data.FileData(this,initfrom);
                if isfield(initfrom," V ") && ~isempty(initfrom.V)
                    this.addProjectionSpace(initfrom.V,initfrom.W,size(initfrom.V,1));
                end
            else
                this = loadobj@data.FileData(this);
            end
            if exist(this.DataDirectory," file ") == 0
                fprintf(2," If you have moved the folder or attempt to load data on a different machine, use the ModelData.relocate method.\n ");
            end
        }
        /* % Getter & Setter */
    public: /* ( Dependent ) */

        
#if 0 //mtoc++: 'get.SampleCount'
function value = SampleCount() {
            value = size(this.ParamSamples,2);
        }

#endif


        
#if 0 //mtoc++: 'set.ApproxTrainData'
function  ApproxTrainData(value) {
            if ~isempty(value) && ~isa(value, " data.ApproxTrainData ")
                error(" The ApproxTrainData must be a data.ApproxTrainData subclass. ");
            end
            if ~isequal(this.ApproxTrainData, value)
                this.ApproxTrainData= [];
                this.ApproxTrainData= value;
            end
        }

#endif


        
#if 0 //mtoc++: 'set.TrajectoryData'
function  TrajectoryData(value) {
            if ~isempty(value) && ~isa(value, " data.ATrajectoryData ")
                error(" The TrajectoryData must be a data.ATrajectoryData subclass. ");
            end
            /*  Precaution: Unset the old traj data as it may trigger deletion of the same folder
             * that is used by the new one. */
            if ~isequal(this.TrajectoryData,value)
                this.TrajectoryData= [];
                this.TrajectoryData= value;
            end
        }

#endif


        
#if 0 //mtoc++: 'set.JacobianTrainData'
function  JacobianTrainData(value) {
            if ~isempty(value) && ~isa(value, " data.ApproxTrainData ")
                error(" The JacobianTrainData must be a data.ApproxTrainData subclass. ");
            end
            if ~isequal(this.JacobianTrainData, value)
                this.JacobianTrainData= [];
                this.JacobianTrainData= value;
            end
        }

#endif


        
#if 0 //mtoc++: 'set.ProjectionSpaces'
function  ProjectionSpaces(value) {
            if ~isempty(value) && ~isa(value," data.ProjectionSpace ")
                error(" Value has to be a data.ProjectionSpace instance/array ");
            end
            this.ProjectionSpaces= value;
        }

#endif


};
}