% UTP_AO_SEARCH a set of UTPs for the ao/search method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_search.m,v 1.6 2010/09/01 13:58:17 ingo Exp $
%

% <MethodDescription>
%
% The search method of the ao class selects AOs that match the given name.
%
% </MethodDescription>

function results = utp_ao_search(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'ao';
    mthd    = 'search';

    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = eval(['get_test_objects_' class]);

    % 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 history is working
    results = [results utp_07];    % Test the modify call works
    results = [results utp_08];    % Test output of the data

    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 ~= 2, atest = false; end
        % Check key
        if ~io(3).plists.isparam('regexp'), atest = false; end
        if ~io(3).plists.isparam('exact'), atest = false; end
        % Check default value
        if ~isEmptyChar(io(3).plists.find('regexp')), atest = false; end
        if ~isequal(io(3).plists.find('exact'), false), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('regexp'), {''}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('exact'), {false, true}), atest = false; end
      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 search method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the search method works for a vector of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Get all AOs with the regular expression '.*'
      out1 = search(atvec, '.*');
      % Get only the AO with the name 'at5'
      out2 = search(atvec, 'at5');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' are the same as in 'atvec'
    % 2) Check that the number of elements in 'out2'
    % 3) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out1), size(atvec)), atest = false; end
      if numel(out2) ~= 1, atest = false; end
      % Check the output except the history because the output have
      % one additionally history step
      if ~eq(out1, atvec, 'hist', 'UUID'), atest = false; end
      if ~eq(out2, at5, 'hist', 'UUID'), atest = false; 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 search method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the search method works for a matrix of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Get all AOs with the regular expression '.*'
      out1 = search(atmat, '.*');
      % Get only the AO with the name 'at5'
      out2 = search(atmat, 'at5');
      % </SyntaxCode      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' are the same as in 'atmat'
    % 2) Check that the number of elements in 'out2'
    % 3) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(numel(out1), numel(atmat)), atest = false; end
      if numel(out2) ~= 1, atest = false; end
      % Check the output except the history because the output have
      % one additionally history step
      if ~eq(reshape(out1, size(atmat)), atmat, 'hist', 'UUID'), atest = false; end
      if ~eq(out2, at5, 'hist', 'UUID'), atest = false; 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 search method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Test that the search method works for a list of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Get all AOs with the regular expression '.*'
      out1 = search(at1,at2,at3, '.*');
      % Get only the AO with the name 'at5'
      out2 = search(at1,at2,at3, 'at3');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' are the same as the input
    % 2) Check that the number of elements in 'out2'
    % 3) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out1) ~= 3, atest = false; end
      if numel(out2) ~= 1, atest = false; end
      % Check the output except the history because the output have
      % one additionally history step
      if ~eq(out1, [at1, at2, at3], 'hist', 'UUID'), atest = false; end
      if ~eq(out2, at3, 'hist', 'UUID'), atest = false; 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 search method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Test that the search method works with an input of matrices and vectors
    % and single AOs.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Get all AOs with the regular expression '.*'
      out1 = search(at1,atvec,at2,atmat,at3, '.*');
      % Get only the AO with the name 'at5'
      out2 = search(at1,atvec,at2,atmat,at3, 'at3');
      % Negative test with the name 'foo'
      out3 = search(at1,atvec,at2,atmat,at3, 'foo');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' are the same as the input
    % 2) Check that the number of elements in 'out2'
    % 3) Check that 'out3' doesn't contain an AO
    % 4) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [at1,reshape(atvec,1,[]),at2,reshape(atmat,1,[]),at3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out1) ~= 3+numel(atvec)+numel(atmat), atest = false; end
      if numel(out2) ~= 2, atest = false; end
      if numel(out3) ~= 0, atest = false; end
      % Check the output except the history because the output have
      % one additionally history step
      if ~eq(out1, aoin, 'hist', 'UUID'), atest = false; end
      if ~eq(out2, [at3, at3], 'hist', 'UUID'), atest = false; end
      if ~isempty(out3), atest = false; 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 search method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Test that the result of applying the search method can be processed back.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out1 = search(atmat, 'at[45]');
      out2 = search(atmat, plist('regexp', 'at[45]', 'exact', false));
      out3 = search(atmat, plist('regexp', 'at4', 'exact', true));
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      mout3 = rebuild(out3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the last entry in the history of 'out' corresponds to
    %    'search'.
    % 2) Check that the re-built object is the same object as the input.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the last step in the history of 'out'
      if ~strcmp(out1(1).hist.methodInfo.mname, 'search'), atest = false; end
      if ~strcmp(out1(2).hist.methodInfo.mname, 'search'), atest = false; end
      if ~strcmp(out2(1).hist.methodInfo.mname, 'search'), atest = false; end
      if ~strcmp(out2(2).hist.methodInfo.mname, 'search'), atest = false; end
      if ~strcmp(out3.hist.methodInfo.mname, 'search'), atest = false; end
      % The rebuilt object must be the same as 'out'
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, ple2), atest = false; end
      if ~eq(mout3, out3, ple2), 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>
  %
  % Tests that the modifier call for the search method doesn't work.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Tests that the modifier call for the search method doesn't work.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      atvec.search('at2');
      % </SyntaxCode>
      stest = false;
    catch err
      disp(err.message)
      stest = true;
    end

    % <AlgoDescription>
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_07

  %% UTP_08

  % <TestDescription>
  %
  % Check that the search method pass back the output objects to a list of
  % output variables or to a single variable.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Call the method with a list of output variables and with a single output
    % variable. Additionaly check that the rebuild method works on the output.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      [o1, o2] = search(at5, at6, 'at');
      o3  = search(at5, at6, 'at');
      mout1 = rebuild(o1);
      mout2 = rebuild(o2);
      mout3 = rebuild(o3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the output contains the right number of objects
    % 2) Check that the 'rebuild' method produces the same object as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the number of outputs
      if numel(o1) ~=1, atest = false; end
      if numel(o2) ~=1, atest = false; end
      if numel(o3) ~=2, atest = false; end
      % Check the rebuilding of the object
      if ~eq(o1, mout1, ple2), atest = false; end
      if ~eq(o2, mout2, ple2), atest = false; end
      if ~eq(o3, mout3, ple2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_08

end
