GammaCalculatorInterface.m

classdef GammaCalculatorInterface < handle
% BASE Basis class for the preparation and calculation of gamma
% Any subclass should also overwrite the 

    methods(Abstract)        
        % GEN_DETAILED_DATA
        %    This function is called by the basis generation algorithm and
        %    should be used to calculate all high dimensional quantities
        %    that are required for the fast online calculation of $\gamma$.
        data = gen_detailed_data(rmodel, model_data, detailed_data);
        
        % GEN_REDUCED_DATA
        %    The return value of this function should be a function handle
        %    that has the following form
        %      rb_gamma = fn(rmodel, reduced_data, sim)
        fn = gen_reduced_data(model, detailed_data, reduced_data);
    end
    
    methods
        function g = gamma(model, model_data, sim)
            % GAMMA This function should be implemented when this method
            % allows the calculation of the true gamma value
            error('Implement the function gamma(model, model_data, sim)');
        end
        
        function s = name(this)
            % This function should return the name of the gamma calculation
            % method. By default its just the class name!
            error('Implement this function!')
        end
        
    end
end