--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/ao/utp_ao_svd.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,664 @@
+% UTP_AO_SVD a set of UTPs for the ao/svd method
+%
+% M Hewitson 06-08-08
+%
+% $Id: utp_ao_svd.m,v 1.10 2011/04/17 11:11:35 hewitson Exp $
+%
+
+% <MethodDescription>
+%
+% The svd method of the ao class computes the singular value decomposition of the y data
+%
+% </MethodDescription>
+
+function results = utp_ao_svd(varargin)
+
+  % Check the inputs
+  if nargin == 0
+
+    % Some keywords
+    class   = 'ao';
+    mthd    = 'svd';
+
+    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 with additional plist with the key 'axis'
+    results = [results utp_09];    % Test input data shape == output data shape
+    results = [results utp_10];    % 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')
+        atest = true;
+        % 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, '1D')), atest = false; end
+        if ~any(strcmpi(io(2).sets, '2D')), atest = false; end
+        if ~any(strcmpi(io(2).sets, '3D')), atest = false; end
+        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
+        % SET '1D'
+        % Check key
+        if ~io(3).plists.isparam('axis'), atest = false; end
+        if ~io(3).plists.isparam('dim'), atest = false; end
+        if ~io(3).plists.isparam('option'), atest = false; end
+        % Check default value
+        if ~isequal(io(3).plists.find('axis'), 'y'), atest = false; end
+        if ~isEmptyDouble(io(3).plists.find('dim')), atest = false; end
+        if ~isEmptyChar(io(3).plists.find('option')), atest = false; end
+        % Check options
+        if ~isequal(io(3).plists.getOptionsForParam('axis'),   {'y'}), atest = false; end
+        if ~isequal(io(3).plists.getOptionsForParam('dim'),    {[]}), atest = false; end
+        if ~isequal(io(3).plists.getOptionsForParam('option'), {''}), atest = false; end
+        % SET '2D'
+        % Check key
+        if ~io(4).plists.isparam('axis'), atest = false; end
+        if ~io(4).plists.isparam('dim'), atest = false; end
+        if ~io(4).plists.isparam('option'), atest = false; end
+        % Check default value
+        if ~isequal(io(4).plists.find('axis'), 'y'), atest = false; end
+        if ~isEmptyDouble(io(4).plists.find('dim')), atest = false; end
+        if ~isEmptyChar(io(4).plists.find('option')), atest = false; end
+        % Check options
+        if ~isequal(io(4).plists.getOptionsForParam('axis'),   {'x', 'y', 'xy'}), atest = false; end
+        if ~isequal(io(4).plists.getOptionsForParam('dim'),    {[]}), atest = false; end
+        if ~isequal(io(4).plists.getOptionsForParam('option'), {''}), atest = false; end
+        % SET '3D'
+        % Check key
+        if ~io(5).plists.isparam('axis'), atest = false; end
+        if ~io(5).plists.isparam('dim'), atest = false; end
+        if ~io(5).plists.isparam('option'), atest = false; end
+        % Check default value
+        if ~isequal(io(5).plists.find('axis'), 'z'), atest = false; end
+        if ~isEmptyDouble(io(5).plists.find('dim')), atest = false; end
+        if ~isEmptyChar(io(5).plists.find('option')), atest = false; end
+        % Check options
+        if ~isequal(io(5).plists.getOptionsForParam('axis'),   {'x', 'y', 'z', 'xyz'}), atest = false; end
+        if ~isequal(io(5).plists.getOptionsForParam('dim'),    {[]}), atest = false; end
+        if ~isequal(io(5).plists.getOptionsForParam('option'), {''}), 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 svd method works with a vector of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_02
+
+    % <SyntaxDescription>
+    %
+    % Test that the svd method works for a vector of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      atvec = [at4, at4, at4];
+      out = svd(atvec);
+      % </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 each output against the singular value decomposition of the input
+      for kk=1:numel(out)
+        if ~isequal(svd(atvec(kk).data.getY), out(kk).data.getY)
+          atest = false;
+          break;
+        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 svd method works with a matrix of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_03
+
+    % <SyntaxDescription>
+    %
+    % Test that the svd method works for a matrix of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      atmat = [at4 at4 at4; at4 at4 at4];
+      out = svd(atmat);
+      % </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 each output against the singular value decomposition of the input
+      for kk=1:numel(out)
+        if ~isequal(svd(atmat(kk).data.getY), out(kk).data.getY)
+          atest = false;
+          break;
+        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 svd method works with a list of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_04
+
+    % <SyntaxDescription>
+    %
+    % Test that the svd method works for a list of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = svd(at4, at4, at4);
+      % </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;
+    if stest
+      % <AlgoCode>
+      % Check we have the correct number of outputs
+      if numel(out) ~= 3, atest = false; end
+      % Check each output against the singular value decomposition of the input
+      if ~isequal(svd(at4.data.getY), out(1).data.getY), atest = false; end
+      if ~isequal(svd(at4.data.getY), out(2).data.getY), atest = false; end
+      if ~isequal(svd(at4.data.getY), out(3).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_04
+
+  %% UTP_05
+
+  % <TestDescription>
+  %
+  % Tests that the svd method works with a mix of different shaped AOs as
+  % input.
+  %
+  % </TestDescription>
+  function result = utp_05
+
+    % <SyntaxDescription>
+    %
+    % Test that the svd method works with an input of matrices and vectors
+    % and single AOs.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      atmat = [at4 at4; at4 at4];
+      atvec = [at4 at4];
+      out = svd(at4,atvec,at4,atmat,at4);
+      % </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;
+    if stest
+      % <AlgoCode>
+      % Check we have the correct number of outputs
+      if numel(out) ~= (3+numel(atmat)+numel(atvec)), atest = false; end
+      % Check the first input
+      nout = 1;
+      if ~isequal(svd(at4.data.getY), out(nout).data.getY), atest = false; end
+      nout = nout+1;
+      % Check the elements of the input vector
+      for jj=1:numel(atvec)
+        if ~isequal(svd(atvec(jj).data.getY), out(nout).data.getY), atest = false; end
+        nout = nout+1;
+      end
+      % Check the 3rd input
+      if ~isequal(svd(at4.data.getY), out(nout).data.getY), atest = false; end
+      nout = nout+1;
+      % Check the elements of the input matrix
+      for jj=1:numel(atmat)
+        if ~isequal(svd(atmat(jj).data.getY), out(nout).data.getY), atest = false; end
+        nout = nout+1;
+      end
+      % Check the last input
+      if ~isequal(svd(at4.data.getY), out(nout).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 svd method properly applies history.
+  %
+  % </TestDescription>
+  function result = utp_06
+
+    % <SyntaxDescription>
+    %
+    % Test that the result of applying the svd method can be processed back
+    % to an m-file.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = svd(at4);
+      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
+    %    'svd'.
+    % 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(out.hist.methodInfo.mname, 'svd'), 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 svd method can modify the input AO.
+  %
+  % </TestDescription>
+  function result = utp_07
+
+    % <SyntaxDescription>
+    %
+    % Test that the svd 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 at4 to work with
+      ain = ao(at4);
+      % modify ain
+      aout = ain.svd();
+      ain.svd();
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that 'at4' and 'ain' are now different.
+    % 2) Check that 'ain' is svd(at4).
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check that svd modified the input by comparing to the copy
+      if eq(ao(at4), ain, ple1), atest = false; end
+      % Check that svd doesn't modified the input for the function notation
+      if ~eq(aout, ain, ple1), atest = false; end
+      % Check that the modified input is the svd value of the copy
+      if ~isequal(svd(at4.data.getY), ain.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_07
+
+  %% UTP_08
+
+  % <TestDescription>
+  %
+  % Control the method with a plist.
+  %
+  % </TestDescription>
+  function result = utp_08
+
+    % <SyntaxDescription>
+    %
+    % Test that the svd method can modify the single axis controlled by the
+    % plist and the resuld can be processed back to an m-file.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      op1 = 0;
+      op2 = 'econ';
+      pl0 = plist('option', op1);
+      pl1 = plist('option', op2);
+      out1 = svd(at4, pl0);
+      out2 = svd(at4, pl1);
+      mout1 = rebuild(out1);
+      mout2 = rebuild(out2);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that the svd method applies with different options.
+    % 2) Check that the re-built objects are the same object as 'out[1..2]'.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check each output against the singular value decomposition of the input
+      if ~isequal(svd(at4.data.getY, op1), out1.data.getY), atest = false; end
+      if ~isequal(svd(at4.data.getY, op2), out2.data.getY), atest = false; end
+      % Check the re-built object
+      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_08
+
+  %% UTP_09
+
+  % <TestDescription>
+  %
+  % Control the method with a plist.
+  %
+  % </TestDescription>
+  function result = utp_09
+
+    % <SyntaxDescription>
+    %
+    % Test that the svd 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 = svd(at4);
+      out2 = svd(at4);
+      % </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) ~= size(svd(at4.data.y)), atest = false; end
+      if size(out2.data.y) ~= size(svd(at4.data.y)), 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 svd 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>
+      at4_10 = at4+10;
+      [o1, o2] = svd(at4, at4_10);
+      o3  = svd(at4, at4_10);
+      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
+
+end