% UTP_PLIST_NPARAMS a set of UTPs for the plist/nparams method
%
% M Hewitson 06-08-08
%
% $Id: utp_plist_nparams.m,v 1.3 2009/07/22 14:02:26 ingo Exp $
%

% <MethodDescription>
%
% The nparams method of the plist class returns the number of param objects
% in the list
%
% </MethodDescription>

function results = utp_plist_nparams(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'plist';
    mthd    = 'nparams';
    
    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');
    
    % Test PLIST objects
    [pl1, pl2, pl3, pl4, plv, plm] = get_test_objects_plist;
    
    % 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
    
    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 nparams method works with a vector of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % Test that the nparams method returns the number of PARAM objects in
    % the PLIST objects.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = nparams(plv);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the number of outputs is the same as the number of
    %    input PLIST objects.
    % 2) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(plv), atest = false; end
      % Check the output
      for ii = 1:numel(plv)
        if numel(plv(ii).params) ~= out(ii), atest = false; 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 nparams method works with a vector of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % Test that the nparams method returns the number of PARAM objects in
    % the PLIST objects.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = nparams(plm);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the number of outputs is the same as the number of
    %    input PLIST objects.
    % 2) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(plm), atest = false; end
      % Check the output
      for ii = 1:numel(plm)
        if numel(plm(ii).params) ~= out(ii), atest = false; 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 nparams method works with a list of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % Test that the nparams method returns the number of PARAM objects in
    % the PLIST objects.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = nparams(pl1, pl2, pl3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the number of outputs is the same as the number of
    %    input PLIST objects.
    % 2) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    plin  = [pl1, pl2, pl3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(plin), atest = false; end
      % Check the output
      for ii = 1:numel(plin)
        if numel(plin(ii).params) ~= out(ii), atest = false; 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 nparams method works with a mix of different shaped PLIST
  % objects as input.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % Test that the nparams method returns the number of PARAM objects in
    % the PLIST objects.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = nparams(plm, pl1, plv);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the number of outputs is the same as the number of
    %    input PLIST objects.
    % 2) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    plin  = [reshape(plm, 1, []), pl1, reshape(plv, 1, [])];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(plin), atest = false; end
      % Check the output
      for ii = 1:numel(plin)
        if numel(plin(ii).params) ~= out(ii), atest = false; 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 nparams method applies the modify command
  %
  % </TestDescription>
  function result = utp_06
    
    % <SyntaxDescription>
    %
    % Test that the nparams method can used in the modifier style.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out1 = pl1.nparams();
      out2 = plv.nparams();
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= numel(pl1.params), atest = false; end
      if out2 ~= [3 6 4], atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_06
  
end
