% UTP_AO_CAT a set of UTPs for the ao/cat method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_cat.m,v 1.3 2009/08/07 10:05:38 hewitson Exp $
%

% <MethodDescription>
%
% The cat method of the ao class concatenate AOs into a row vector.
%
% </MethodDescription>

function results = utp_ao_cat(varargin)

  % Check the inputs
  if nargin == 0

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

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

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = get_test_objects_ao;

    % 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(mthd, atvec, @algo_test_y, [], ple3)];    % Vector input
    results = [results utp_03(mthd, atmat, @algo_test_y, [], ple3)];    % Matrix input
    results = [results utp_04(mthd, at1, at2, at3, @algo_test_y, [], ple3)];    % List input
    results = [results utp_05(mthd, at1, atvec, atmat, @algo_test_y, [], ple3)];    % Test with mixed input
    results = [results utp_06];    % Test history is working
    results = [results utp_07];    % Test the modify call works not

    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
  
  %% Algorithm test for UTP 02,03,04,05
  
  function atest = algo_test_y(in, out, pli)    
    atest = true;
    if ~isequal(in.data.getY, out.data.getY)
      atest = false;
    end
  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_06

  % <TestDescription>
  %
  % The cat method doesn't apply history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % The cat method doesn't apply history.
    %
    % </SyntaxDescription>

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

    % <AlgoDescription>
    %
    % 1) Nothing to test
    %
    % </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_06

  %% UTP_07

  % <TestDescription>
  %
  % The cat method can not be used as a modifer method.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % The cat method can not be used as a modifer method. In this case
    % throws the method an error.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % copy at1 to work with
      amodi = ao(at1);
      aeq   = ao(at1);
      out = aeq.cat();
      amodi.cat();
      stest = false;
      % </SyntaxCode>
    catch
      stest = true;
    end

    % <AlgoDescription>
    %
    % 1) Nothing to test.
    %
    % </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

end
