% UTP_AO_SIMPLIFYYUNITS a set of UTPs for the ao/simplifyYunits method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_simplifyYunits.m,v 1.8 2009/08/07 11:27:08 hewitson Exp $
%

% <MethodDescription>
%
% The simplifyYunits method of the ao class simplify the 'yunits' property
% of the ao.
%
% </MethodDescription>

function results = utp_ao_simplifyYunits(varargin)

  % Check the inputs
  if nargin == 0

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

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

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = get_test_objects_ao;

    % 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 output of the data
    results = [results utp_09];    % Test with different complex y-units
    results = [results utp_10];    % Test with exception list
    results = [results utp_11(mthd, at1, ple1)];    % Test plotinfo doesn't disappear
    results = [results utp_12];    % Test doesn't apply prefixes to 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, '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('prefixes'), atest = false; end
        if ~io(3).plists.isparam('exceptions'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('prefixes'), true), atest = false; end
        if ~isEmptyChar(io(3).plists.find('exceptions')), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('prefixes'), {true, false}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('exceptions'), {''}), 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 simplifyYunits method works with a vector of AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      objs = atvec.setYunits('km V^1/3 mm^-2 V^-1');
      out  = simplifyYunits(objs);
      % </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;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(atvec)), atest = false; end
      % Check the output
      for kk = 1:numel(out)
        % Check the new y-units
        if ~eq(out(kk).yunits, unit('m^-1 V^-2/3')), atest = false; end
        % Check that simplifyYunits also modify the y-units depending on
        % the prefixes: Here multiply the y-values with 1e9
        if ~isequal(objs(kk).y .* 1e9, out(kk).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 simplifyYunits method works with a matrix of AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      objs = atmat.setYunits('km kV^1/3 km^-1');
      out  = simplifyYunits(objs);
      % </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;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(atmat)), atest = false; end
      % Check the output
      for kk = 1:numel(out)
        % Check the new y-units
        if ~eq(out(kk).yunits, unit('V^(1/3)')), atest = false; end
        % Check that simplifyYunits also modify the y-units depending on
        % the prefixes: Here multiply the y-values with 10
        if abs(objs(kk).y .* 10 - out(kk).y) > eps(out(kk).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 simplifyYunits method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      obj1 = at1.setYunits('km V^1/3 mm^-2 V^-1');
      obj2 = at2.setYunits('km V^1/3 mm^-2 V^-1');
      obj3 = at3.setYunits('km V^1/3 mm^-2 V^-1');
      out = simplifyYunits(obj1, obj2, obj3);
      % </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 = [obj1, obj2, obj3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 3, atest = false; end
      % Check the output
      for kk = 1:numel(out)
        % Check the new y-units
        if ~eq(out(kk).yunits, unit('m^-1 V^-2/3')), atest = false; end
        % Check that simplifyYunits also modify the y-units depending on
        % the prefixes: Here multiply the y-values with 1e9
        if ~isequal(aoin(kk).y .* 1e9, out(kk).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 simplifyYunits method works with a mix of different
  % shaped AOs as input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      objv = atvec.setYunits('km V^1/3 mm^-2 V^-1');
      objm = atmat.setYunits('km V^1/3 mm^-2 V^-1');
      obj1 = at1.setYunits('km V^1/3 mm^-2 V^-1');
      obj2 = at2.setYunits('km V^1/3 mm^-2 V^-1');
      out = simplifyYunits(obj1, objm, objv, obj2);
      % </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  = [obj1, reshape(objm, 1, []), reshape(objv, 1, []), obj2];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(aoin), atest = false; end
      % Check the output
      for kk = 1:numel(out)
        % Check the new y-units
        if ~eq(out(kk).yunits, unit('m^-1 V^-2/3')), atest = false; end
        % Check that simplifyYunits also modify the y-units depending on
        % the prefixes: Here multiply the y-values with 1e9
        if ~isequal(aoin(kk).y .* 1e9, out(kk).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 simplifyYunits method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

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

    try
      % <SyntaxCode>
      out  = simplifyYunits(at1);
      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
    %    'simplifyYunits'.
    % 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, 'simplifyYunits'), 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 simplifyYunits method can modify the input AO.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the simplifyYunits 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
      aa = at1.setYunits('km V^1/3 mm^-2 V^-1');
      amodi = ao(aa);
      aeq   = ao(aa);
      out = aeq.simplifyYunits();
      amodi.simplifyYunits();
      % </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 simplifies the y-units of the copy
    % 4) Check that out and amodi are the same
    %
    % </AlgoDescription>

    atest = true;
    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(aa), ple1), atest = false; end
      % Check that the modified input simplifies the y-units of the copy
      if ~eq(amodi.yunits, unit('m^-1 V^-2/3')), atest = false; end
      % Check that simplifyYunits also modify the y-units depending on
      % the prefixes: Here multiply the y-values with 1e9
      if ~isequal(aa.y .* 1e9, amodi.y), 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>
  %
  % Check that the simplifyYunits method pass back the output objects to a
  % list of output variables or to a single variable.
  %
  % </TestDescription>
  function result = utp_08

    % <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] = simplifyYunits(at5, at6);
      o3  = simplifyYunits(at5, at6);
      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_08

  %% UTP_09

  % <TestDescription>
  %
  % Test that the simplifyYunits works for different complex y-units.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Test that the simplifyYunits works for different complex y-units.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % No changes to the data AND units
      a1 = at1.setYunits('m Hz^-2 V^2/3');
      out1 = a1.simplifyYunits();

      % No changes to the data
      a2 = at1.setYunits('m^2 m^-3 m^2/3');
      out2 = a2.simplifyYunits();

      % The data is multiplied with the pefix 1e6
      a3 = at1.setYunits('km^2 km^-2/3');
      out3 = a3.simplifyYunits();

      % Re-build the object
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      mout3 = rebuild(out3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the correct data
    % 2) Check that the re-built object is the same as in 'out[1..3]'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check 'out1'
      if ~eq(out1, a1, ple3), atest = false; end
      % Check 'out2'
      if ~eq(out2.yunits, unit('m^-1/3'), ple3), atest = false; end
      e = ple3.find('EXCEPTIONS');
      ple = plist('EXCEPTIONS', [e {'yunits'}]);
      if ~eq(out1, a1, ple), atest = false; end
      % Check 'out3' -> data is multiplied by 1e4
      % REMARK: The optimal value is 1e4 but in case of rounding proplems
      %         is the value '1e6 * 1e3 .^ (-2/3)'
      fact = 1e6 * 1e3 .^ (-2/3);
      if ~eq(out3.yunits, unit('m^4/3')), atest = false; end
      if ~isequal(out3.y, a3.y .* fact), 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
      % </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 that the simplifyYunits works with a exception list.
  %
  % </TestDescription>
  function result = utp_10

    % <SyntaxDescription>
    %
    % Test that the simplifyYunits works with a exception list.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      a1   = at1.setYunits('km^2 nm^-2/3 m');
      ple  = plist('exceptions', 'nm');
      out1 = a1.simplifyYunits(ple);
      
      a2   = at1.setYunits('km^2 km^-2/3 Hz^1/2 Hz');
      ple  = plist('exceptions', 'Hz', 'prefixes', false);
      out2 = a2.simplifyYunits(ple);

      % Re-build the object
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the correct data
    % 2) Check that the re-built object is the same as in 'out[1..2]'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check 'out1'
      if ~eq(out1.yunits, unit('m^3 nm^-2/3')), atest = false; end
      if ~isequal(out1.y, a1.y .* 1e6), atest = false; end
      e = ple3.find('EXCEPTIONS');
      ple = plist('EXCEPTIONS', [e {'y', 'yunits'}]);
      if ~eq(out1, a1, ple), atest = false; end
      % Check 'out2'
      if ~eq(out2.yunits, unit('km^4/3 Hz^1/2 Hz')), atest = false; end
      e = ple3.find('EXCEPTIONS');
      ple = plist('EXCEPTIONS', [e {'yunits'}]);
      if ~eq(out2, a2, ple), 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_10

  %% UTP_12

  % <TestDescription>
  %
  % Test that the simplifyYunits doesn't apply the prefixes to the data.
  %
  % </TestDescription>
  function result = utp_12

    % <SyntaxDescription>
    %
    % Test that the simplifyYunits doesn't apply the prefixes to the data.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      a1   = at1.setYunits('km^2 nm^-2/3 m');
      ple  = plist('prefixes', false);
      out1 = a1.simplifyYunits(ple);
      
      a2   = at1.setYunits('km^2 km^-2/3 Hz^1/2 Hz');
      ple  = plist('prefixes', false);
      out2 = a2.simplifyYunits(ple);

      % Re-build the object
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the correct data
    % 2) Check that the re-built object is the same as in 'out[1..2]'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check 'out1'
      if ~eq(out1.yunits, unit('km^2 nm^-2/3 m')), atest = false; end
      e = ple3.find('EXCEPTIONS');
      ple = plist('EXCEPTIONS', [e {'yunits'}]);
      if ~eq(out1, a1, ple), atest = false; end
      % Check 'out2'
      if ~eq(out2.yunits, unit('km^4/3 Hz^3/2')), atest = false; end
      if ~eq(out2, a2, ple), 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

end
