% UTP_AO_IFFT a set of UTPs for the ao/ifft method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_ifft.m,v 1.14 2011/02/07 11:15:36 luigi Exp $
%

% <MethodDescription>
%
% The ifft method of the ao class computes the inverse fast fourier
% transform of time-series AOs.
%
% </MethodDescription>

function results = utp_ao_ifft(varargin)

  % Check the inputs
  if nargin == 0

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

    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 the data shape
    results = [results utp_09];    % Test output of the data
    results = [results utp_10];    % Test against MATLAB's ifft - symmetric
    results = [results utp_11(mthd, at2, ple1)];    % Test plotinfo doesn't disappear    
    results = [results utp_12];    % Test against MATLAB's ifft - nonsymmetric

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

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

    try
      % <SyntaxCode>
      avec = [at2 at2];
      out  = ifft(avec);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' is the square of the
    %    number in the input.
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(avec), atest = false; end
      % Check each output
      for kk=1:numel(out)
        y = [avec(kk).y; avec(kk).data.getY(end-1:-1:2)];
        y = ifft(y, 'symmetric');
        % Compute time axis
        N = length(y);
        x = linspace(0, (N-1)/avec(kk).fs, N).';
        if any(abs(out(kk).x - x)>TOL), atest = false; end
        if ~isequal(out(kk).y, y), atest = false; end
      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 ifft method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      amat = [at2 at2 at2; at2 at2 at2];
      out  = ifft(amat);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' is the square of the
    %    number in the input.
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(amat), atest = false; end
      % Check each output
      for kk=1:numel(out)
        y = [amat(kk).y; amat(kk).data.getY(end-1:-1:2)];
        y = ifft(y, 'symmetric');
        % Compute time axis
        N = length(y);
        x = linspace(0, (N-1)/amat(kk).fs, N).';
        if any(abs(out(kk).x - x)>TOL), atest = false; end
        if ~isequal(out(kk).y, y), atest = false; end
      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 ifft method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

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

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

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' is the square of the
    %    number in the input.
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [at2, at2, at2];
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 3, atest = false; end
      % Check each output
      for kk=1:numel(out)
        y = [aoin(kk).y; aoin(kk).data.getY(end-1:-1:2)];
        y = ifft(y, 'symmetric');
        % Compute time axis
        N = length(y);
        x = linspace(0, (N-1)/aoin(kk).fs, N).';
        if any(abs(out(kk).x - x)>TOL), atest = false; end
        if ~isequal(out(kk).y, y), atest = false; end
      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 ifft method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      out = ifft(at2,[at2 at2],at2,[at2 at2; at2 at2],at2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

    atest = true;
    aoin  = [at2, reshape([at2 at2], 1, []), at2, reshape([at2 at2; at2 at2], 1, []), at2];
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 9, atest = false; end
      % Check each output
      for kk=1:numel(out)
        y = [aoin(kk).y; aoin(kk).data.getY(end-1:-1:2)];
        y = ifft(y, 'symmetric');
        % Compute time axis
        N = length(y);
        x = linspace(0, (N-1)/aoin(kk).fs, N).';
        if any(abs(out(kk).x - x)>TOL), atest = false; end
        if ~isequal(out(kk).y, y), atest = false; end
      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 ifft method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Test that the result of applying the ifft method can be processed back
    % to an m-file.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out  = ifft(at2);
      mout = rebuild(out);
      % </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
    %    'ifft'.
    % 2) % Check that the re-built object is the same object as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the last step in the history of 'out'
      if ~strcmp(out.hist.methodInfo.mname, 'ifft'), atest = false; end
      % Check the re-built object
      if ~eq(mout, out, 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 ifft method can modify the input AO.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the ifft method can modify the input AO by calling with no
    % output.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % copy at2 to work with
      ain = ao(at2);
      % modify ain
      aout = ifft(ain);
      ain.ifft;
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that 'at2' and 'ain' are now different.
    % 2) Check that 'ain' is ifft(at2).
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check that ifft modified the input by comparing to the copy
      if eq(ao(at2), ain, ple1), atest = false; end

      % Check that ifft doesn't modified the input for the function
      % notation
      if ~eq(aout, ain, ple1), atest = false; end
      % Check that the modified input is the ifft of the copy
      y = [at2.y; at2.data.getY(end-1:-1:2)];
      y = ifft(y, 'symmetric');
      % Compute time axis
      N = length(y);
      x = linspace(0, (N-1)/at2.fs, N).';
      if any(abs(ain.x - x)>TOL), atest = false; end
      if ~isequal(ain.y, y), 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>
  %
  % Tests that the ifft method keeps the data shape of the input object.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the ifft method keeps the data shape of the input object. The
    % input AO must be an AO with row data and an AO with column data.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      aa1  = at5.psd;
      aa2  = at6.psd;
      out1 = ifft(aa1);
      out2 = ifft(aa2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the shpe of the data doesn't change.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the shape of the output data
      if size(out1.data.y,1) == 1, atest = false; end
      if size(out2.data.y,2) == 2, 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>
  %
  % Check that the ifft method pass back the output objects to a list of
  % output variables or to a single variable.
  %
  % </TestDescription>
  function result = utp_09

    % <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>
      aa1  = at5.psd;
      aa2  = at6.psd;
      [o1, o2] = ifft(aa1, aa2);
      o3  = ifft(aa1, aa2);
      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_09

  %% UTP_10

  % <TestDescription>
  %
  % Tests that the ifft method agrees with MATLAB's ifft when
  % configured to use the same parameters.
  %
  % </TestDescription>
  function result = utp_10

    % <SyntaxDescription>
    %
    % Test that the applying ifft works on two AOs.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Construct two test AOs
      nsecs = 10;
      fs    = 1000;
      pl = plist('nsecs', nsecs, 'fs', fs, 'tsfcn', 'randn(size(t))');
      a1 = fft(ao(pl),plist('type','plain'));
      % Compute fft
      out = ifft(a1,plist('type','symmetric'));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that output agrees with the output of MATLAB's ifft.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Compute ifft using MATLAB's ifft
      yxx = ifft(a1.data.y, 'symmetric');
      if ~isequal(yxx(:), out.data.getY), 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_12

  % <TestDescription>
  %
  % Tests that the ifft method agrees with MATLAB's ifft when
  % configured to use the same parameters.
  %
  % </TestDescription>
  function result = utp_12

    % <SyntaxDescription>
    %
    % Test that the applying ifft works on a single AO with 'nonsymmetric'
    % option.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Construct two test AOs
      nsecs = 10;
      fs    = 1000;
      pl = plist('nsecs', nsecs, 'fs', fs, 'tsfcn', 'randn(size(t))');
      a1 = fft(ao(pl),plist('type','plain'));
      % Compute fft
      out = ifft(a1, plist('type', 'nonsymmetric'));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that output agrees with the output of MATLAB's ifft.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Compute ifft using MATLAB's ifft
      yxx = ifft(a1.data.y, 'nonsymmetric');
      if ~isequal(yxx(:), out.data.getY), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

end
