% UTP_AO_MTIMES a set of UTPs for the ao/mtimes method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_mtimes.m,v 1.7 2011/02/17 21:19:03 mauro Exp $
%

% <MethodDescription>
%
% The mtimes method of the ao class computes the matrix product of the y data
% of the two inputs.
%
% </MethodDescription>

function results = utp_ao_mtimes(varargin)

  % Check the inputs
  if nargin == 0

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

    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 input data shape == output data shape
    results = [results utp_09];    % Test all data types

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

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

    try
      % <SyntaxCode>
      % We need a vector of AOs all the same size.
      % The shape of the data shouldn't have an effect to the algorithm.
      avec = [at1 ao(3) ao(1)];
      out = mtimes(avec);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the one output
      if numel(out) ~= 1, atest = false; end
      % Check the output against the matrix product of the inputs
      s = avec(1).data.getY;
      for jj=2:numel(avec)
        s = s * avec(jj).data.getY;
      end
      if ~isequal(s, out.data.getY), atest = false; end
      % Check the y-units
      if ~eq(out.yunits, at1.yunits), 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 mtimes method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      % We need a matrix of AOs all the same size
      amat = [at4 ao(1) ao(2); ao(3) ao(4) ao(5)];
      out = mtimes(amat);
      stest = true;
      % </SyntaxCode>
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' is 1
    % 2) Check that each output AO contains the correct data.
    % 3) Check that the output have the yunits of the AO which contains a yunits
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 1, atest = false; end
      % Check the output against the matrix product of the inputs
      s = amat(1).data.getY;
      for kk=2:numel(amat)
        s = s * amat(kk).data.getY;
      end
      if ~isequal(s, out.data.getY), atest = false; end
      % Check the units
      if ~eq(out.yunits, at4.yunits), 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 mtimes method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      out = mtimes(at1,ao(7),ao(4));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 1, atest = false; end
      % Check the output against the matrix product of the inputs
      s = at1.data.getY * 7 * 4;
      if ~isequal(s, out.data.getY), atest = false; end
      % Check the units
      if ~eq(out.yunits, at1.yunits), atest = false; 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 mtimes method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      % We need a vector of AOs all the same size
      avec = [ao(1) ao(2) ao(3)];
      % We need a matrix of AOs all the same size
      amat = [ao(4) ao(5) ao(6); ao(7) ao(8) ao(9)];
      % Compute matrix product
      out = mtimes(at5,avec,ao(10),amat,ao(11));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' is 1.
    % 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 numel(out) ~= 1, atest = false; end
      % Check the matrix product of all the inputs
      s = at5.data.getY;
      for jj=1:numel(avec)
        s = s * avec(jj).data.getY;
      end
      s = s * 10;
      for jj=1:numel(amat)
        s = s * amat(jj).data.getY;
      end
      s = s * 11;
      if ~isequal(s, 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_05

  %% UTP_06

  % <TestDescription>
  %
  % Tests that the mtimes method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

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

    try
      % <SyntaxCode>
      out  = mtimes(ao([3;4]),ao([5 8]));
      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
    %    'mtimes'.
    % 2) Check that the rebuilt 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, 'mtimes'), atest = false; end
      % Check the rebuilt object
      if ~eq(mout, out, ple2), atest = false; end
      % </AlgoCode>
      % delete test file
    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 mtimes method can not be used as a modifier method.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Tests that the mtimes method can not be used as a modifier method. The
    % command should fail.
    %
    % </SyntaxDescription>

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

    % <AlgoDescription>
    %
    % 1) Nothing to test.
    %
    % </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_07

  %% UTP_08

  % <TestDescription>
  %
  % Test the shape of the output.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the mtimes 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 = at5 * 5;
      out2 = 5 * at5;
      out3 = at6 * 5;
      out4 = 5 * at6;
      % </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) ~= size(at5.data.y, 1), atest = false; end
      if size(out2.data.y, 1) ~= size(at5.data.y, 1), atest = false; end
      if size(out3.data.y, 2) ~= size(at6.data.y, 2), atest = false; end
      if size(out4.data.y, 2) ~= size(at6.data.y, 2), atest = false; end
      % Check y-units
      if ~eq(out1.yunits, at5.yunits), atest = false; end
      if ~eq(out2.yunits, at5.yunits), atest = false; end
      if ~eq(out3.yunits, at6.yunits), atest = false; end
      if ~eq(out4.yunits, at6.yunits), 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 method with all data objects.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Test that the mtimes method works with cdata-, fsdata-, tsdata-, and xydata
    % objects
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out11 = at1 * 5;
      out12 = 5 * at1;
      out21 = at2 * 5;
      out22 = 5 * at2;
      out31 = at3 * 5;
      out32 = 5 * at3;
      out41 = at4 * 5;
      out42 = 5 * at4;
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the shpe of the data doesn't change.
    % 2) Check that re-building of output is the same as the output
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the shape of the output data
      if ~isequal(mtimes(at1.y, 5), out11.y), atest = false; end
      if ~isequal(mtimes(at1.y, 5), out12.y), atest = false; end
      if ~isequal(mtimes(at2.y, 5), out21.y), atest = false; end
      if ~isequal(mtimes(at2.y, 5), out22.y), atest = false; end
      if ~isequal(mtimes(at3.y, 5), out31.y), atest = false; end
      if ~isequal(mtimes(at3.y, 5), out32.y), atest = false; end
      if ~isequal(mtimes(at4.y, 5), out41.y), atest = false; end
      if ~isequal(mtimes(at4.y, 5), out42.y), atest = false; end
      % Check the rebuilding
      if ~eq(rebuild(out11), out11, ple2), atest = false; end
      if ~eq(rebuild(out12), out12, ple2), atest = false; end
      if ~eq(rebuild(out21), out21, ple2), atest = false; end
      if ~eq(rebuild(out22), out22, ple2), atest = false; end
      if ~eq(rebuild(out31), out31, ple2), atest = false; end
      if ~eq(rebuild(out32), out32, ple2), atest = false; end
      if ~eq(rebuild(out41), out41, ple2), atest = false; end
      if ~eq(rebuild(out42), out42, 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