IReducedDataNode.m

classdef IReducedDataNode < DataTree.ILeafNode & IReducedData
  % %Interface for leaf nodes of the DataTree in Greedy.User.ReducedData
  % objects.
  %
  % These objects should be automatically generated out of a detailed data
  % strucuture by the .Greedy.User.ReducedData constructor.

  methods
    function subset_reduced_data = extract_reduced_data_subset(reduced_data, rmodel)
      % function subset_reduced_data = extract_reduced_data_subset(reduced_data, rmodel)
      % @copybrief .IReducedData.extract_reduced_data_subset()
      %
      % @copydetails .IReducedData.extract_reduced_data_subset()
      %
      % Parameters:
      %   rmodel: of type .Greedy.User.IReducedModel
      if needs_subset_copy(reduced_data, rmodel)
        subset_reduced_data = rmodel.bg_descr.reduced_data_constructor(rmodel, reduced_data);
      else
        subset_reduced_data = reduced_data;
      end
    end
  end

%  methods
%    function rdn = RbReducedData(rmodel)
%    end
%  end

  methods (Abstract)

    % function yesno = needs_subset_copy(this, rmodel);
    % returns whether the reduced data needs to be copied when a subset is
    % demanded by a call of extract_reduced_data_subset().
    %
    % Parameters:
    %   rmodel: of type ::GreedyUser::IReducedModel
    %
    % Return values:
    %   yesno: boolean flag indicating whether it is necessary to copy the
    %          object.
    yesno = needs_subset_copy(this, rmodel);

    %    conds = get_conds(this);
    %
  end

end