% UTP_PZMODEL_EQ a set of UTPs for the pzmodel/eq method
%
% M Hewitson 06-08-08
%
% $Id: utp_pzmodel_eq.m,v 1.8 2011/04/19 18:14:01 ingo Exp $
%

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

function results = utp_pzmodel_eq(varargin)

  % Check the inputs
  if nargin == 0

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

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

    % Test PZMODEL objects
    [pz1, pz2, pz3, pz4, pz5, pzv, pzm] = get_test_objects_pzmodel;

    % 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 'iunits'
    results = [results utp_09];    % Test with the exception list 'ounits'
    results = [results utp_10];    % 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 PZMODEL objects as input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      pzm = pz2.setName('my name');
      pzv1 = [pz5, pz3, pz4, pz2];
      pzv2 = [pz5, pz3, pz4, pzm];
      out1 = eq(pzv1, pzv1);
      out2 = eq(pzv1, pzv2);
      % </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 PZMODEL objects as input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      pzm = pz2.setName('my name');
      pzmm1 = [pz5, pz3, pz2, pz2, pz4, pz5];
      pzmm2 = [pz5, pz3, pzm; pz2, pz4, pz5];
      out1 = eq(pzmm1, pzmm1);
      out2 = eq(pzmm1, pzmm2);
      % </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 PZMODEL objects as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % The eq method doesn't works for a list of PZMODEL objects 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 PZMODEL objects
  % as input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % The eq method doesn't works for a list of PZMODEL objects 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 PZMODEL object, 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 pzm is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      pzm = testCallerIsMethod(@setName, pz2, 'my name');
      out1 = eq(pzm, pz2);
      out2 = eqLocal(pzm, pz2, 'name');
      out3 = eqLocal(pzm, pz2, 'pzmodel/name');
      out4 = eq(pzm.hist, pz2.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 'iunits'. Use the option 'internal'
    % to suppress the history. It is necessary to add 'created' to the exception
    % list because pzm is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      pzm = testCallerIsMethod(@setIunits, pz2, unit('Hz'));
      out1 = eq(pzm, pz2);
      out2 = eqLocal(pzm, pz2, 'iunits');
      out3 = eqLocal(pzm, pz2, 'pzmodel/iunits');
      out4 = eq(pzm.hist, pz2.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 'ounits'. Use the option 'internal'
    % to suppress the history. It is necessary to add 'created' to the exception
    % list because pzm is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      pzm = testCallerIsMethod(@setOunits, pz2, unit('V'));
      out1 = eq(pzm, pz2);
      out2 = eqLocal(pzm, pz2, 'ounits');
      out3 = eqLocal(pzm, pz2, 'pzmodel/ounits');
      out4 = eq(pzm.hist, pz2.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 which is in a plist.
  %
  % </TestDescription>
  function result = utp_10

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

    try
      % <SyntaxCode>
      pzm = testCallerIsMethod(@setName, pz2, 'my name');
      pl = plist('Exceptions', {'name', 'UUID'});
      out1 = eq(pzm, pz2);
      out2 = eq(pzm, pz2, pl);
      out3 = eq(pzm, pz2, pl);
      out4 = eq(pzm.hist, pz2.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_10

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