% UTP_MATRIX_TRANSPOSE a set of UTPs for the matrix/transpose method
%
% M Hewitson 06-08-08
%
% $Id: utp_matrix_transpose.m,v 1.4 2010/12/22 16:05:19 ingo Exp $
%

% <MethodDescription>
%
% The transpose method of the matrix transpose the inner objects.
%
% </MethodDescription>

function results = utp_matrix_transpose(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'matrix';
    mthd    = 'transpose';

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

    % Test MATRIX objects
    [ma1,ma2,ma3,ma4,mav,mam] = get_test_objects_matrix;

    % 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 that the method accepts plists
    results = [results utp_11(mthd, ma1, ple1, plist('NAME', 'foo'))];    % Test plotinfo doesn't disappear

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

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

    try
      % <SyntaxCode>
      out = transpose(mav);
      % </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 'mav'
    % 2) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(mav)), atest = false; end
      % Check 'objs' field of each output
      for oo = 1:numel(out)
        s = size(out(oo));
        for ll = 1:numel(s(1))
          for rr = 1:numel(s(2))
            if ~eq(out(oo).objs(ll,rr), mav(oo).objs(rr,ll), 'UUID'), atest = false; break; end
          end
        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 transpose method works with a matrix of MATRICES as input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      out = transpose(mam);
      % </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 'mam'
    % 2) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(mam)), atest = false; end
      % Check 'objs' field of each output
      for oo = 1:numel(out)
        s = size(out(oo));
        for ll = 1:numel(s(1))
          for rr = 1:numel(s(2))
            if ~eq(out(oo).objs(ll,rr), mam(oo).objs(rr,ll), 'UUID'), atest = false; break; end
          end
        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 transpose method works with a list of MATRICES as input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      out = transpose(ma1,ma2,ma3);
      % </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 contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    main = [ma1, ma2, ma3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(main)), atest = false; end
      % Check 'objs' field of each output
      for oo = 1:numel(out)
        s = size(out(oo));
        for ll = 1:numel(s(1))
          for rr = 1:numel(s(2))
            if ~eq(out(oo).objs(ll,rr), main(oo).objs(rr,ll), 'UUID'), atest = false; break; end
          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 transpose method works with a mix of different shaped
  % MATRICES as input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      out = transpose(ma1,mav,ma2,mam);
      % </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 contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    main = [ma1, reshape(mav, 1, []), ma2, reshape(mam, 1, [])];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(main)), atest = false; end
      % Check 'objs' field of each output
      for oo = 1:numel(out)
        s = size(out(oo));
        for ll = 1:numel(s(1))
          for rr = 1:numel(s(2))
            if ~eq(out(oo).objs(ll,rr), main(oo).objs(rr,ll), 'UUID'), atest = false; break; end
          end
        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 transpose method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

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

    try
      % <SyntaxCode>
      out = transpose(ma1);
      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
    %    'transpose'.
    % 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 'out1'
      if ~strcmp(out.hist.methodInfo.mname, 'transpose'),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 transpose method can modify the input MATRIX.
  %
  % </TestDescription>
  function result = utp_07
    
    % <SyntaxDescription>
    %
    % Test that the transpose method can modify the input MATRIX by calling
    % with no output.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      obj_modi = copy(ma1,1);
      obj_eq   = copy(ma1,1);

      out = obj_eq.transpose();
      obj_modi.transpose();
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that 'out' and 'obj_eq' are now different.
    % 2) Check that 'obj_eq' is not changed
    % 3) Check that the modified input is the transpose value of the copy
    % 4) Check that out and amodi are the same
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check that 'out' and 'obj_eq' are now different.
      if eq(out, obj_eq, ple2), atest = false; end
      % Check that 'obj_eq' is not changed
      if ~eq(obj_eq, ma1, ple1), atest = false; end
      % Check 'objs' field of each output
      for oo = 1:numel(out)
        s = size(out(oo));
        for ll = 1:numel(s(1))
          for rr = 1:numel(s(2))
            if ~eq(out(oo).objs(ll,rr), ma1(oo).objs(rr,ll), 'UUID'), atest = false; break; end
          end
        end
      end
      % Check that out and obj_modi are the same
      if ~eq(out, obj_modi, 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>
  %
  % Tests that the transpose method accepts plist as an input.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Tests that the transpose method accepts plist as an input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = ma1.transpose(plist());
      mout = rebuild(out);
      % </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 object as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check 'objs' field of each output
      for oo = 1:numel(out)
        s = size(out(oo));
        for ll = 1:numel(s(1))
          for rr = 1:numel(s(2))
            if ~eq(out(oo).objs(ll,rr), ma1(oo).objs(rr,ll), 'UUID'), atest = false; break; end
          end
        end
      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_08

end