% UTP_MFIR_NE a set of UTPs for the mfir/ne method
%
% M Hewitson 06-08-08
%
% $Id: utp_mfir_ne.m,v 1.6 2011/04/19 18:14:01 ingo Exp $
%

% <MethodDescription>
%
% The ne() method of the mfir class fir1 ~= fir2 compares each element of an
% mfir object with the corresponding element of an second fir object and returns
% a logical 1 (true) where fir1 and fir2 are not equal, or logical 0 (false)
% where they are equal.
%
% </MethodDescription>

function results = utp_mfir_ne(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'mfir';
    mthd    = 'ne';

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

    % Test MFIR objects
    [firhp,firlp,firbp,firbr,firpzm,firao,firv,firm] = get_test_objects_mfir;

    % 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 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 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 ne method works with a vector of MFIR objects as input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      fir   = firpzm.setName('my name');
      iirv1 = [firao, firbr, firhp, firpzm];
      iirv2 = [firao, firbr, firhp, fir];
      out1 = ne(iirv1, iirv1);
      out2 = ne(iirv1, iirv2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

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

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

    try
      % <SyntaxCode>
      fir   = firpzm.setName('my name');
      firm1 = [firao, firbr, firpzm, firpzm, firhp, firao];
      firm2 = [firao, firbr, fir;    firpzm, firhp, firao];
      out1 = ne(firm1, firm1);
      out2 = ne(firm1, firm2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

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

    % <SyntaxDescription>
    %
    % The ne method doesn't works for a list of MFIR 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 ne method works with a mix of different shaped MFIR objects
  % as input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % The ne method doesn't works for a list of MFIR 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 ne method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % The ne method doesn't change the MFIR 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 ne method with an exception list.
  % The function mfir/ne use the function mfir/eq so it is not necessary to check
  % all possibilities of the exception list.
  % 
  % </TestDescription>
  function result = utp_07

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

    try
      % <SyntaxCode>
      fir  = testCallerIsMethod(@setName, firpzm, 'my name');
      out1 = ne(fir, firpzm);
      out2 = ne(fir, firpzm, 'name',    'created', 'UUID');
      out3 = ne(fir, firpzm, 'mfir/name', 'created', 'UUID');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 1, atest = false; end
      if out2 ~= 0, atest = false; end
      if out3 ~= 0, 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 ne method with an exception list which is in a plist.
  %
  % </TestDescription>
  function result = utp_08

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

    try
      % <SyntaxCode>
      fir  = testCallerIsMethod(@setName, firpzm, 'my name');
      pl   = plist('Exceptions', {'name', 'created', 'UUID'});
      out1 = ne(fir, firpzm);
      out2 = ne(fir, firpzm, pl);
      out3 = ne(fir, firpzm, pl);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the shape of the output data
      if out1 ~= 1, atest = false; end
      if out2 ~= 0, atest = false; end
      if out3 ~= 0, 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