% UTP_AO_EQ a set of UTPs for the ao/eq method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_eq.m,v 1.11 2011/04/19 18:14:00 ingo Exp $
%

% <MethodDescription>
%
% The eq() method of the ao class ao1 == ao2 compares each element of an
% analysis object with the corresponding element of an second analysis object
% and returns a logical 1 (true) where ao1 and ao2 are equal,
% or logical 0 (false) where they are not equal.
%
% </MethodDescription>

function results = utp_ao_eq(varargin)

  % Check the inputs
  if nargin == 0

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

    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 with the exception list 'name'
    results = [results utp_08];    % Test with the exception list 'plotinfo'
    results = [results utp_09];    % Test with the exception list 't0'
    results = [results utp_10];    % Test with the exception list 'x'
    results = [results utp_11];    % Test with the exception list 'y'
    results = [results utp_12];    % Test with the exception list 'xunits'
    results = [results utp_13];    % Test with the exception list 'yunits'
    results = [results utp_14];    % Test with the exception list 'fs'
    results = [results utp_15];    % Test with the exception list 'description'
    results = [results utp_16];    % Test exception list in a plist

    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 number of SETS
        if numel(io(2).sets) ~= 1, atest = false; end
        % Check all Sets
        if ~any(strcmpi(io(2).sets, 'Default')), atest = false; end
        % SET 'Default'
        % Check key
        if ~io(3).plists.isparam('Exceptions'), atest = false; end
        if ~io(3).plists.isparam('Tol'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('Exceptions'), {}), atest = false; end
        if ~isequal(io(3).plists.find('Tol'), eps(1)), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('Exceptions'),   {{}}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('Tol'),    {eps(1)}), 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 eq method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the eq method works for a vector of AOs as input. Test the
    % positive and the negative case.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = at1.setName('my name');
      avec1 = [at4, at3, at2, at1];
      avec2 = [at4, at3, at2, aa];
      out1 = eq(avec1, avec1);
      out2 = eq(avec1, avec2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output of the eq function.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 1, atest = false; end
      if out2 ~= 0, 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 eq method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the eq method works for a matrix of AOs as input. Test the
    % positive and the negative case.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = at1.setName('my name');
      amat1 = [at4, at3, at1, at1, at2, at4];
      amat2 = [at4, at3, aa;  at1, at2, at4];
      out1 = eq(amat1, amat1);
      out2 = eq(amat1, amat2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output of the eq function.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 1, atest = false; end
      if out2 ~= 0, 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 eq method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % The eq method doesn't works for a list of AOs as input. Nothing to do.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    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_04

  %% UTP_05

  % <TestDescription>
  %
  % Tests that the eq method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % The eq method doesn't works for a list of AOs as input. Nothing to do.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    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_05

  %% UTP_06

  % <TestDescription>
  %
  % Tests that the eq method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % The eq method doesn't change the AO, thus will no history added.
    % Nothing to do
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    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_06

  %% UTP_07

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'name'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setName, at1, 'my name');
      out1 = eq(aa, at1);
      out2 = eqLocal(aa, at1, 'name');
      out3 = eqLocal(aa, at1, 'ao/name');
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_08

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'plotinfo'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setPlotinfo, at1, plist('line', 'k'));
      out1 = eq(aa, at1);
      out2 = eqLocal(aa, at1, 'plotinfo');
      out3 = eqLocal(aa, at1, 'ao/plotinfo');
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_09

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 't0'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setT0, at1, time(123));
      out1 = eq(aa, at1);
      out2 = eqLocal(aa, at1, 't0');
      out3 = eqLocal(aa, at1, 'tsdata/t0');
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_10

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_10

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'x'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setX, at1, randn(300,1));
      out1 = eq(aa, at1);
      out2 = eqLocal(aa, at1, 'x');
      out3 = eqLocal(aa, at1, 'tsdata/x');
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_11

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_11

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'y'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setY, at1, randn(300,1));
      out1 = eq(aa, at1);
      out2 = eqLocal(aa, at1, 'y');
      out3 = eqLocal(aa, at1, 'tsdata/y');
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_12

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_12

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'xunits'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setXunits, at1, 'Hz s^-2/3');
      out1 = eq(aa, at1);
      out2 = eqLocal(aa, at1, 'xunits');
      out3 = eqLocal(aa, at1, 'tsdata/xunits');
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_13

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_13

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'yunits'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setYunits, at1, 'Hz s^-2/3');
      out1 = eq(aa, at1);
      out2 = eqLocal(aa, at1, {'yunits', 'hist'});
      out3 = eqLocal(aa, at1, {'tsdata/yunits', 'hist'});
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_14

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_14

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'fs'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setFs, at2, 123.123);
      out1 = eq(aa, at2);
      out2 = eqLocal(aa, at2, 'fs');
      out3 = eqLocal(aa, at2, 'fsdata/fs');
      out4 = eq(aa.hist, at2.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_15

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_15

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'description'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because aa is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setDescription, at1, 'my description');
      out1 = eq(aa, at1);
      out2 = eqLocal(aa, at1, 'description');
      out3 = eqLocal(aa, at1, 'ao/description');
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_16

  % <TestDescription>
  %
  % Test the eq method with an exception list which is in a plist.
  %
  % </TestDescription>
  function result = utp_16

    % <SyntaxDescription>
    %
    % Test that the eq method uses the exception list in a plist.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa = testCallerIsMethod(@setName, at1, 'my name');
      pl = plist('Exceptions', {'name', 'UUID'});
      out1 = eq(aa, at1);
      out2 = eq(aa, at1, pl);
      out3 = eq(aa, at1, pl);
      out4 = eq(aa.hist, at1.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the shape of the output data
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  function res = eqLocal(obj1, obj2, ex)    
      e = ple1.find('EXCEPTIONS');
      ple = plist('EXCEPTIONS', [e cellstr(ex)]);
    
      res = eq(obj1, obj2, ple);
  end
  
end
