% UTP_AO_KSTEST a set of UTPs for the ao/kstest method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_kstest.m,v 1.2 2011/07/14 07:11:00 mauro Exp $
%

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

function results = utp_ao_kstest(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'ao';
    mthd    = 'kstest';
 
    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 does not work
    results = [results utp_09];    % Test output of the data

    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, 'empirical')), atest = false; end
        if ~any(strcmpi(io(2).sets, 'normal')), atest = false; end
        if ~any(strcmpi(io(2).sets, 'chi2')), atest = false; end
        if ~any(strcmpi(io(2).sets, 'f')), atest = false; end
        if ~any(strcmpi(io(2).sets, 'gamma')), atest = false; end
        
        %%%%%%%%%%   SET 'empirical'        
        pn = 3;
        if io(pn).plists.nparams ~= 4, atest = false; end        
        % Check key
        if ~io(pn).plists.isparam('TESTDISTRIBUTION'), atest = false; end
        if ~io(pn).plists.isparam('ALPHA'), atest = false; end
        if ~io(pn).plists.isparam('SHAPEPARAM'), atest = false; end
        if ~io(pn).plists.isparam('CRITICALVALUE'), atest = false; end
        
        % Check default value
        if ~isequal(io(pn).plists.find('TESTDISTRIBUTION'), 'EMPIRICAL'), atest = false; end
        if ~isequal(io(pn).plists.find('ALPHA'), 0.05), atest = false; end
        if ~isequal(io(pn).plists.find('SHAPEPARAM'), 1), atest = false; end
        if ~isequal(io(pn).plists.find('CRITICALVALUE'), []), atest = false; end
        
        
        % Check options
        if ~isequal(io(pn).plists.getOptionsForParam('TESTDISTRIBUTION'),...
            {'EMPIRICAL','NORMAL','CHI2','F','GAMMA'}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('ALPHA'), {0.05}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('SHAPEPARAM'), {1}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('CRITICALVALUE'), {[]}), atest = false; end
        
        %%%%%%%%%%   SET 'normal'        
        pn = 4;
        if io(pn).plists.nparams ~= 6, atest = false; end        
        % Check key
        if ~io(pn).plists.isparam('TESTDISTRIBUTION'), atest = false; end
        if ~io(pn).plists.isparam('ALPHA'), atest = false; end
        if ~io(pn).plists.isparam('SHAPEPARAM'), atest = false; end
        if ~io(pn).plists.isparam('CRITICALVALUE'), atest = false; end
        if ~io(pn).plists.isparam('MEAN'), atest = false; end
        if ~io(pn).plists.isparam('STD'), atest = false; end
        
        % Check default value
        if ~isequal(io(pn).plists.find('TESTDISTRIBUTION'), 'EMPIRICAL'), atest = false; end
        if ~isequal(io(pn).plists.find('ALPHA'), 0.05), atest = false; end
        if ~isequal(io(pn).plists.find('SHAPEPARAM'), 1), atest = false; end
        if ~isequal(io(pn).plists.find('CRITICALVALUE'), []), atest = false; end
        if ~isequal(io(pn).plists.find('MEAN'), 0), atest = false; end
        if ~isequal(io(pn).plists.find('STD'), 1), atest = false; end
        
        
        % Check options
        if ~isequal(io(pn).plists.getOptionsForParam('TESTDISTRIBUTION'),...
            {'EMPIRICAL','NORMAL','CHI2','F','GAMMA'}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('ALPHA'), {0.05}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('SHAPEPARAM'), {1}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('CRITICALVALUE'), {[]}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('MEAN'), {0}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('STD'), {1}), atest = false; end
        
        %%%%%%%%%%   SET 'chi2'        
        pn = 5;
        if io(pn).plists.nparams ~= 5, atest = false; end        
        % Check key
        if ~io(pn).plists.isparam('TESTDISTRIBUTION'), atest = false; end
        if ~io(pn).plists.isparam('ALPHA'), atest = false; end
        if ~io(pn).plists.isparam('SHAPEPARAM'), atest = false; end
        if ~io(pn).plists.isparam('CRITICALVALUE'), atest = false; end
        if ~io(pn).plists.isparam('DOF'), atest = false; end
        
        % Check default value
        if ~isequal(io(pn).plists.find('TESTDISTRIBUTION'), 'EMPIRICAL'), atest = false; end
        if ~isequal(io(pn).plists.find('ALPHA'), 0.05), atest = false; end
        if ~isequal(io(pn).plists.find('SHAPEPARAM'), 1), atest = false; end
        if ~isequal(io(pn).plists.find('CRITICALVALUE'), []), atest = false; end
        if ~isequal(io(pn).plists.find('DOF'), 2), atest = false; end
        
        
        % Check options
        if ~isequal(io(pn).plists.getOptionsForParam('TESTDISTRIBUTION'),...
            {'EMPIRICAL','NORMAL','CHI2','F','GAMMA'}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('ALPHA'), {0.05}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('SHAPEPARAM'), {1}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('CRITICALVALUE'), {[]}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('DOF'), {2}), atest = false; end
        
        %%%%%%%%%%   SET 'f'        
        pn = 6;
        if io(pn).plists.nparams ~= 6, atest = false; end        
        % Check key
        if ~io(pn).plists.isparam('TESTDISTRIBUTION'), atest = false; end
        if ~io(pn).plists.isparam('ALPHA'), atest = false; end
        if ~io(pn).plists.isparam('SHAPEPARAM'), atest = false; end
        if ~io(pn).plists.isparam('CRITICALVALUE'), atest = false; end
        if ~io(pn).plists.isparam('DOF1'), atest = false; end
        if ~io(pn).plists.isparam('DOF2'), atest = false; end
        
        % Check default value
        if ~isequal(io(pn).plists.find('TESTDISTRIBUTION'), 'EMPIRICAL'), atest = false; end
        if ~isequal(io(pn).plists.find('ALPHA'), 0.05), atest = false; end
        if ~isequal(io(pn).plists.find('SHAPEPARAM'), 1), atest = false; end
        if ~isequal(io(pn).plists.find('CRITICALVALUE'), []), atest = false; end
        if ~isequal(io(pn).plists.find('DOF1'), 2), atest = false; end
        if ~isequal(io(pn).plists.find('DOF2'), 2), atest = false; end
        
        
        % Check options
        if ~isequal(io(pn).plists.getOptionsForParam('TESTDISTRIBUTION'),...
            {'EMPIRICAL','NORMAL','CHI2','F','GAMMA'}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('ALPHA'), {0.05}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('SHAPEPARAM'), {1}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('CRITICALVALUE'), {[]}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('DOF1'), {2}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('DOF2'), {2}), atest = false; end
        
        %%%%%%%%%%   SET 'gamma'        
        pn = 7;
        if io(pn).plists.nparams ~= 6, atest = false; end        
        % Check key
        if ~io(pn).plists.isparam('TESTDISTRIBUTION'), atest = false; end
        if ~io(pn).plists.isparam('ALPHA'), atest = false; end
        if ~io(pn).plists.isparam('SHAPEPARAM'), atest = false; end
        if ~io(pn).plists.isparam('CRITICALVALUE'), atest = false; end
        if ~io(pn).plists.isparam('SHAPE'), atest = false; end
        if ~io(pn).plists.isparam('SCALE'), atest = false; end
        
        % Check default value
        if ~isequal(io(pn).plists.find('TESTDISTRIBUTION'), 'EMPIRICAL'), atest = false; end
        if ~isequal(io(pn).plists.find('ALPHA'), 0.05), atest = false; end
        if ~isequal(io(pn).plists.find('SHAPEPARAM'), 1), atest = false; end
        if ~isequal(io(pn).plists.find('CRITICALVALUE'), []), atest = false; end
        if ~isequal(io(pn).plists.find('SHAPE'), 2), atest = false; end
        if ~isequal(io(pn).plists.find('SCALE'), 2), atest = false; end
        
        
        % Check options
        if ~isequal(io(pn).plists.getOptionsForParam('TESTDISTRIBUTION'),...
            {'EMPIRICAL','NORMAL','CHI2','F','GAMMA'}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('ALPHA'), {0.05}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('SHAPEPARAM'), {1}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('CRITICALVALUE'), {[]}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('SHAPE'), {2}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('SCALE'), {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 kstest method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      avec = [at5 at5];
      out1  = kstest(avec);
      out2  = kstest(avec, plist('testdistribution', 'normal'));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' is one less of the input.
    % 2) Check that the number of elements in 'out2' is the same of the
    %    number in the input.
    % 3) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out1) ~= numel(avec) - 1, atest = false; end
      if numel(out2) ~= numel(avec), atest = false; end
      % Check each output: class
      for kk = 1:numel(out1)
        if ~isa(out1(kk).data, 'cdata'), atest = false; end
      end
      for kk = 1:numel(out2)
        if ~isa(out2(kk).data, 'cdata'), atest = false; end
      end
      % Check each output: content
      for kk = 1:numel(out1)
        if ~isequal(out1(kk).data.y, false), atest = false; end
      end
      for kk = 1:numel(out2)
        if ~isequal(out2(kk).data.y, false), 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 kstest method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      amat = [at5 at5 at5; at5 at5 at5];
      out1  = kstest(amat);
      out2  = kstest(amat, plist('testdistribution', 'normal'));

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

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' is one less of the input.
    % 2) Check that the number of elements in 'out2' is the same of the
    %    number in the input.
    % 3) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out1) ~= numel(amat)-1, atest = false; end
      if numel(out2) ~= numel(amat), atest = false; end
      % Check each output: class
      for kk = 1:numel(out1)
        if ~isa(out1(kk).data, 'cdata'), atest = false; end
      end
      for kk = 1:numel(out2)
        if ~isa(out2(kk).data, 'cdata'), atest = false; end
      end
      % Check each output: content
      for kk = 1:numel(out1)
        if ~isequal(out1(kk).data.y, false), atest = false; end
      end
      for kk = 1:numel(out2)
        if ~isequal(out2(kk).data.y, false), 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 kstest method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      out1  = kstest(at5, at5, at5);
      out2  = kstest(at5, at5, at5, plist('testdistribution', 'normal'));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' is one less of the input.
    % 2) Check that the number of elements in 'out2' is the same of the
    %    number in the input.
    % 3) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out1) ~= 2, atest = false; end
      if numel(out2) ~= 3, atest = false; end
      % Check each output: class
      for kk = 1:numel(out1)
        if ~isa(out1(kk).data, 'cdata'), atest = false; end
      end
      for kk = 1:numel(out2)
        if ~isa(out2(kk).data, 'cdata'), atest = false; end
      end
      % Check each output: content
      for kk = 1:numel(out1)
        if ~isequal(out1(kk).data.y, false), atest = false; end
      end
      for kk = 1:numel(out2)
        if ~isequal(out2(kk).data.y, false), 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 kstest method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      out1  = kstest(at5,[at6 at6],at5,[at5 at5; at5 at5],at6);
      % </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  = [at1, reshape([at1 at1], 1, []), at1, reshape([at1 at1; at1 at1], 1, []), at1];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out1) ~= 8, atest = false; end
      % Check each output
      
      % </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 kstest method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

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

    try
      % <SyntaxCode>
      out1  = kstest(at5, at6);
      mout1 = rebuild(out1);
      % </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
    %    'kstest'.
    % 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(out1.hist.methodInfo.mname, 'kstest'), atest = false; end
      % Check the re-built object
      if ~eq(mout1, out1, 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 kstest method cannot modify the input AO.
  %
  % </TestDescription>
  function result = utp_07

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

    try
      % <SyntaxCode>
      % copy at2 to work with
      ain1 = ao(at5);
      ain2 = ao(at6);
      ainv = [ain1 ain2];
      % modify ain
      out1  = kstest(ainv);
      ainv.kstest();
      % </SyntaxCode>
      stest = false;
    catch err
      disp(err.message)
      stest = true;
    end

    % <AlgoDescription>
    %
    %
    % </AlgoDescription>

    atest = true;
    

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


  %% UTP_09

  % <TestDescription>
  %
  % Check that the kstest 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>
      [o11, o12] = kstest(at5, at6, at6);
      no1  = kstest(at5, at6, at6);
      mout11 = rebuild(o11);
      mout12 = rebuild(o12);
      moutn1 = rebuild(no1);
      
      % </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(o11) ~=1, atest = false; end
      if numel(o12) ~=1, atest = false; end
      if numel(no1) ~=2, atest = false; end
      % Check the rebuilding of the object
      if ~eq(o11, mout11, ple2), atest = false; end
      if ~eq(o12, mout12, ple2), atest = false; end
      if ~eq(no1, moutn1, 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

  

end