Interface.m

classdef Interface < handle
  % Interface for parameter sampling classes producing discrete parameter
  % sample in the parameter space `{\cal M}`.
  %
  % Attention: An object must be initialized by init_sample() before it is
  % fully functional. This can be checked by the init_required() method.

  properties (SetAccess = private, Dependent, Abstract)
    % matrix storing the parameter vectors in the parameter samples as row
    % vectors.
    sample;
  end

  properties (Access = protected)
    % boolean indicating whether the object has already been initialized by a
    % call of init_sample().
    init_done = false;
  end

  methods (Abstract)

    init_sample(this, dmodel);
    % function init_sample(this, dmodel);
    % initializes the parameter sampling object

    size = size(this);
    % function size = size(this);
    % returns the number of parameter vectors in this sampling
    %
    % Return values:
    %  size: sample size
  end

  methods
    function please_init = init_required(this)
      % function please_init = init_required(this)
      % returns a boolean indicating whether the object is fully functional, or
      % must be initialized by a call to init_sample().
      %
      % Return values:
      %   please_init: boolean indicating whether init_sample() needs to be
      %                executed.
      please_init = ~this.init_done;
    end
  end
end