% UTP_PLIST_COMBINE a set of UTPs for the plist/combine method
%
% M Hewitson 06-08-08
%
% $Id: utp_plist_combine.m,v 1.3 2009/07/22 14:02:25 ingo Exp $
%

% <MethodDescription>
%
% The combine method of the plist class combine multiple parameter lists
% (PLIST) objects into a single PLIST object.
%
% </MethodDescription>

function results = utp_plist_combine(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'plist';
    mthd    = 'combine';
    
    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');
    
    % Test PLIST objects
    pl1 = plist('a', 1);
    pl2 = plist('b', 2);
    pl3 = plist('c', 3);
    pl4 = plist('d', 4, 'e', 5);
    plv = [pl1, pl2, pl3];
    plm = [pl1, pl2; pl3 pl4];
    
    % Exception list for the UTPs:
    [ple1,ple2,ple3,ple4,ple5,ple6] = get_test_ples();

    % Run the tests
    results = [results utp_01];    % getInfo call
    results = [results utp_02];    % Vector input
    results = [results utp_03];    % Matrix input
    results = [results utp_04];    % List input
    results = [results utp_05];    % Test with mixed input
    results = [results utp_06];    % Test the modify call works
    results = [results utp_07];    % Test with different inputs for the key/value pair
    
    disp('Done.');
    disp('******************************************************');
    
  elseif nargin == 1 % Check for UTP functions
    if strcmp(varargin{1}, 'isutp')
      results = 1;
    else
      results = 0;
    end
  else
    error('### Incorrect inputs')
  end
  
  %% UTP_01
  
  % <TestDescription>
  %
  % Tests that the getInfo call works for this method.
  %
  % </TestDescription>
  function result = utp_01
    
    
    % <SyntaxDescription>
    %
    % Test that the getInfo call works for no sets, all sets, and each set
    % individually.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % Call for no sets
      io(1) = eval([class '.getInfo(''' mthd ''', ''None'')']);
      % Call for all sets
      io(2) = eval([class '.getInfo(''' mthd ''')']);
      % Call for each set
      for kk=1:numel(io(2).sets)
        io(kk+2) = eval([class '.getInfo(''' mthd ''', ''' io(2).sets{kk} ''')']);
      end
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that getInfo call returned an minfo object in all cases.
    % 2) Check that all plists have the correct parameters.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % check we have minfo objects
      if isa(io, 'minfo')
        % SET 'None'
        if ~isempty(io(1).sets), atest = false; end
        if ~isempty(io(1).plists), atest = false; end
        % Check all Sets
        if ~any(strcmpi(io(2).sets, 'Default')), atest = false; end
        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
        % SET 'Default'
        if io(3).plists.nparams ~= 0, atest = false; end
        % Check key
        % Check default value
        % Check options
      end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_01
  
  %% UTP_02
  
  % <TestDescription>
  %
  % Tests that the combine method works with a vector of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % Test that the combine method combines all input PLIST objects to one object.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = combine(plv);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output is one PLIST object.
    % 2) Check that the output PLIST contains all key/value pairs.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isa(out, 'plist') && numel(out) ==1, atest = false; end
      % Check that the output have all key/value pairs
      for ii = 1:numel(plv)
        for kk = 1:plv(ii).nparams
          pp = plv(ii).params(kk);
          if ~isequal(out.find(pp.key), pp.getVal), atest = false; end
        end
      end
      
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_02
  
  %% UTP_03
  
  % <TestDescription>
  %
  % Tests that the combine method works with a matrix of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % Test that the combine method combines all input PLIST objects to one object.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = combine(plm);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output is one PLIST object.
    % 2) Check that the output PLIST contains all key/value pairs.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isa(out, 'plist') && numel(out) ==1, atest = false; end
      % Check that the output have all key/value pairs
      for ii = 1:numel(plm)
        for kk = 1:plm(ii).nparams
          pp = plm(ii).params(kk);
          if ~isequal(out.find(pp.key), pp.getVal), atest = false; end
        end
      end
      
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_03
  
  %% UTP_04
  
  % <TestDescription>
  %
  % Tests that the combine method works with a list of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % Test that the combine method combines all input PLIST objects to one object.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = combine(pl1, pl2, pl3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output is one PLIST object.
    % 2) Check that the output PLIST contains all key/value pairs.
    %
    % </AlgoDescription>
    
    atest = true;
    plin  = [pl1, pl2, pl3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isa(out, 'plist') && numel(out) ==1, atest = false; end
      % Check that the output have all key/value pairs
      for ii = 1:numel(plin)
        for kk = 1:plin(ii).nparams
          pp = plin(ii).params(kk);
          if ~isequal(out.find(pp.key), pp.getVal), atest = false; end
        end
      end
      
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_04
  
  %% UTP_05
  
  % <TestDescription>
  %
  % Tests that the combine method works with a mix of different shaped PLIST
  % objects as input.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % Test that the combine method combines all input PLIST objects to one object.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = combine(plm, plist('aa', 1));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output is one PLIST object.
    % 2) Check that the output PLIST contains all key/value pairs.
    %
    % </AlgoDescription>
    
    atest = true;
    plin  = [reshape(plm, 1, []), plist('aa', 1)];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isa(out, 'plist') && numel(out) ==1, atest = false; end
      % Check that the output have all key/value pairs
      for ii = 1:numel(plin)
        for kk = 1:plin(ii).nparams
          pp = plin(ii).params(kk);
          if ~isequal(out.find(pp.key), pp.getVal), atest = false; end
        end
      end
      
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_05
  
  %% UTP_06
  
  % <TestDescription>
  %
  % Tests that the combine method applies the modify command
  %
  % </TestDescription>
  function result = utp_06
    
    % <SyntaxDescription>
    %
    % Test that the combine method can modify the input PLIST by calling with no
    % output and that the method doesn't change the input of the function
    % notation (with a equal sign).
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % copy at1 to work with
      plin = plist(pl1);
      % modify ain
      out = plin.combine(pl2);
      plin.combine(pl2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that 'pl1' and 'plin' are now different.
    % 2) Check that 'ain' combine the key/value pair.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check that combine modified the input by comparing to the copy
      if eq(plist(pl1), plin, ple1), atest = false; end
      % Check that combine doesn't modified the input for the function notation
      if ~eq(out, plin, ple1), atest = false; end
      % Check that the modified input have the new key/value pairs
      if ~isequal(plin.find('a'), 1), atest = false; end
      if ~isequal(plin.find('b'), 2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_06
  
  %% UTP_07
  
  % <TestDescription>
  %
  % Test the combine method doen't overwrite existing keys.
  %
  % </TestDescription>
  function result = utp_07
    
    % <SyntaxDescription>
    %
    % Duplicate parameters which are given priority in the order in which
    % they appear in the input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      pl1 = plist('a', 1, 'b', 2, 'c', 3);
      pl2 = plist('b', 'new b', 'd', 4, 'c', 'new c');
      pl3 = plist('b', 'newer b', 'e', 5, 'd', 'new d');
      out = combine(pl1, pl2, pl3);
      pl1.combine(pl2, pl3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output have all key/value pairs in the order they
    %    appear.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check number of params
      if out.nparams ~= 5, atest = false; end
      if pl1.nparams ~= 5, atest = false; end
      % Check the params
      if ~isequal(out.find('a'), 1), atest = false; end
      if ~isequal(out.find('b'), 2), atest = false; end
      if ~isequal(out.find('c'), 3), atest = false; end
      if ~isequal(out.find('d'), 4), atest = false; end
      if ~isequal(out.find('e'), 5), atest = false; end
      if ~isequal(pl1.find('a'), 1), atest = false; end
      if ~isequal(pl1.find('b'), 2), atest = false; end
      if ~isequal(pl1.find('c'), 3), atest = false; end
      if ~isequal(pl1.find('d'), 4), atest = false; end
      if ~isequal(pl1.find('e'), 5), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_07
  
end