% UTP_AO_FIND a set of UTPs for the ao/find method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_find.m,v 1.7 2010/08/18 15:35:25 ingo Exp $
%

% <MethodDescription>
%
% The find method of the ao class computes the FIND particular samples that
% satisfy the input query and return a new AO.
%
% </MethodDescription>

function results = utp_ao_find(varargin)

  % Check the inputs
  if nargin == 0

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

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

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = get_test_objects_ao;
    pli = plist('QUERY', 'x < 4');
    
    % 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 with with different queries.
    results = [results utp_09];    % Test input data shape == output data shape
    results = [results utp_10];    % Test output of the data

    results = [results utp_11(mthd, at1, ple1, pli)];    % Test plotinfo doesn't disappear    
    
    results = [results utp_12];    % Test with AO(cdata)
    results = [results utp_13];    % Test with plist(query)

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

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

    try
      % <SyntaxCode>
      out = find(atvec, 'x < 4');
      % </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 'atvec'
    % 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 ~isequal(size(out), size(atvec)), atest = false; end
      % Check each output must have x-values which are smaler 4
      for kk=1:numel(out)
          x = atvec(kk).x;
          idx = find(x < 4);
          if any(abs(out(kk).x - atvec(kk).x(idx)) > TOL),atest = false; end
          if ~isequal(out(kk).y, atvec(kk).y(idx)),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 find method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Tests that the find method works with a matrix of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = find(atmat, 'y < 4');
      % </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 'atmat'
    % 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 ~isequal(size(out), size(atmat)), atest = false; end
      % Check each output must have y-values which are smaler 4
      for kk=1:numel(out)
        y = atmat(kk).y;
        idx = find(y < 4);
        if ~isa(out(kk).data, 'cdata')
          if any(abs(out(kk).x - atmat(kk).x(idx)) > TOL),atest = false; end
        end
        if ~isequal(out(kk).y, atmat(kk).y(idx)),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 find method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Tests that the find method works with a list of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = find(at1, at2, at3, 'x < 4');
      % </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 'atmat'
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    TOL   = 1e-14;
    atest = true;
    aoin  = [at1, at2, at3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(aoin)), atest = false; end
      % Check each output must have x-values which are smaler 4
      for kk=1:numel(out)
        if ~isa(out(kk).data, 'cdata')
          x = aoin(kk).x;
          idx = find(x < 4);
          if any(abs(out(kk).x - aoin(kk).x(idx)) > TOL),atest = false; end
          if ~isequal(out(kk).y, aoin(kk).y(idx)),atest = false; end
        else
          if ~eq(out(kk), aoin(kk), ple1), atest = false; end
        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 find method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Tests that the find method works with a mix of different shaped AOs
    % as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = find(at1, atmat, at3, atvec, 'y < 4');
      % </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 'atmat'
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    aoin  = [at1, reshape(atmat, 1, []), at3, reshape(atvec, 1, [])];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(aoin)), atest = false; end
      % Check each output must have y-values which are smaler 4
      for kk=1:numel(out)
        y = aoin(kk).y;
        idx = find(y < 4);
        if ~isa(out(kk).data, 'cdata')
          if any(abs(out(kk).x - aoin(kk).x(idx)) > TOL),atest = false; end
        end
        if ~isequal(out(kk).y, aoin(kk).y(idx)),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 find method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Test that the result of applying the find method can be processed back.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out  = find(at1, 'x < 4');
      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
    %    'finf'.
    % 2) Check that the re-built object is the same object as the input.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the last step in the history of 'out'
      if ~strcmp(out.hist.methodInfo.mname, 'find'), atest = false; end
      % The rebuilt object must be the same as 'out'
      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 find method can modify the input AO.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the find method can modify the input AO by calling with no
    % output and that the method doesn't change the input of the function
    % notation (with a equal sign).
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % copy at1 to work with
      amodi = ao(at1);
      aeq   = ao(at1);
      out = aeq.find('x < 4');
      amodi.find('x < 4');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that 'out' and 'aeq' are now different.
    % 2) Check that 'aeq' is not changed
    % 3) Check that the modified input is the abs value of the copy
    % 4) Check that out and amodi are the same
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check that 'out' and 'aeq' are now different.
      if eq(out, aeq, ple2), atest = false; end
      % Check that 'aeq' is not changed
      if ~eq(aeq, ao(at1), ple1), atest = false; end
      % Check that the modified input have the correct data
      x = at1.x;
      idx = find(x < 4);
      if any(abs(out.x - at1.x(idx)) > TOL),atest = false; end
      if ~isequal(out.y, at1.y(idx)),atest = false; end
      % Check that out and amodi are the same
      if ~eq(out, amodi, ple1), 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 that the find method works with different queries to the x-/y-
  % axis.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the find method works with different queries to the x-/y-
    % axis.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out1 = find(at1, 'x > 5 & x < 25');
      out2 = find(at1, 'x > 5 & y < .4');
      out3 = find(at1, 'y < 0.4 & y > -0.4');
      out4 = find(at1, 'x > 5', 'x < 25');
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      mout3 = rebuild(out3);
      mout4 = rebuild(out4);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      x = at1.x;
      y = at1.y;
      % Check 'out1'
      idx1 = find(x > 5 & x < 25);
      t0off = (out1.t0.utc_epoch_milli - at1.t0.utc_epoch_milli)/1e3;
      if any(abs(out1.x + t0off - at1.x(idx1)) > TOL),atest = false; end
      if ~isequal(out1.y, at1.y(idx1)),atest = false; end
      % Check 'out2'
      idx2 = find(x > 5 & y < .4);
      if any(abs(out2.x - at1.x(idx2)) > TOL),atest = false; end
      if ~isequal(out2.y, at1.y(idx2)),atest = false; end
      % Check 'out3'
      idx3 = find(y < 0.4 & y > -0.4);
      if any(abs(out3.x - at1.x(idx3)) > TOL),atest = false; end
      if ~isequal(out3.y, at1.y(idx3)),atest = false; end
      % Check 'out4'
      idx4 = find(x > 5 & x < 25);
      t0off = (out4.t0.utc_epoch_milli - at1.t0.utc_epoch_milli)/1e3;
      if any(abs(out4.x + t0off - at1.x(idx4)) > TOL),atest = false; end
      if ~isequal(out4.y, at1.y(idx4)),atest = false; end
      % Check the re-built objects
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, ple2), atest = false; end
      if ~eq(mout3, out3, ple2), atest = false; end
      if ~eq(mout4, out4, ple2), 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 shape of the output.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Test that the find 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>
      out1 = find(at5 ,'x > 5 & x < 20 & y < 1');
      out2 = find(at6, 'x > 5 & x < 20 & y < 1');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the shape 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) == 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>
  %
  % Check that the find method pass back the output objects to a list of
  % output variables or to a single variable.
  %
  % </TestDescription>
  function result = utp_10

    % <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>
      [o1, o2] = find(at5, at6, 'y < 5');
      o3  = abs(at5, at6, 'y < 5');
      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_10

 
  %% UTP_12

  % <TestDescription>
  %
  % Test that the find method works with AOs which have cdata.
  %
  % </TestDescription>
  function result = utp_12

    % <SyntaxDescription>
    %
    % Test that the find method works with AOs which have cdata.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      a1 = ao([1 -2 3; -4 7 -1 ; 5 3 -8]);
      a2 = ao(1:12);
      out1 = find(a1, 'y > 1');
      out2 = find(a2, 'y > 3 & y < 8');
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

    atest = true;
    if stest
      % <AlgoCode>
      % Check 'out1'
      y = a1.y;
      idx1 = find(y > 1);
      if ~isequal(out1.y, a1.y(idx1)),atest = false; end
      % Check 'out2'
      y = a2.y;
      idx2 = find(y > 3 & y < 8);
      if ~isequal(out2.y, a2.y(idx2)),atest = false; end
      % Check the re-built objects
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, ple2), 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 that the find method works with a plist which contains different
  % queries to the x-/y- axis.
  %
  % </TestDescription>
  function result = utp_13

    % <SyntaxDescription>
    %
    % Test that the find method works with a plist which contains different
    % queries to the x-/y- axis.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      
      out1 = find(at1, plist('query', 'x > 5 & x < 25'));
      out2 = find(at1, plist('query', 'x > 5 & y < .4'));
      out3 = find(at1, plist('query', 'y < 0.4 & y > -0.4'));
      out4 = find(at1, plist('query', 'x > 5 & x < 25'));
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      mout3 = rebuild(out3);
      mout4 = rebuild(out4);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      x = at1.x;
      y = at1.y;
      % Check 'out1'
      idx1 = find(x > 5 & x < 25);
      t0off = (out1.t0.utc_epoch_milli - at1.t0.utc_epoch_milli)/1000;
      if any(abs(out1.x + t0off - at1.x(idx1)) > TOL),atest = false; end
      if ~isequal(out1.y, at1.y(idx1)),atest = false; end
      % Check 'out2'
      idx2 = find(x > 5 & y < .4);
      if any(abs(out2.x - at1.x(idx2)) > TOL),atest = false; end
      if ~isequal(out2.y, at1.y(idx2)),atest = false; end
      % Check 'out3'
      idx3 = find(y < 0.4 & y > -0.4);
      if any(abs(out3.x - at1.x(idx3)) > TOL),atest = false; end
      if ~isequal(out3.y, at1.y(idx3)),atest = false; end
      % Check 'out4'
      idx4 = find(x > 5 & x < 25);
      t0off = (out4.t0.utc_epoch_milli - at1.t0.utc_epoch_milli)/1e3;
      if any(abs(out4.x + t0off - at1.x(idx4)) > TOL),atest = false; end
      if ~isequal(out4.y, at1.y(idx4)),atest = false; end
      % Check the re-built objects
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, ple2), atest = false; end
      if ~eq(mout3, out3, ple2), atest = false; end
      if ~eq(mout4, out4, ple2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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