--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/ao/utp_ao_scale.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,631 @@
+% UTP_AO_SCALE a set of UTPs for the ao/scale method
+%
+% M Hewitson 06-08-08
+%
+% $Id: utp_ao_scale.m,v 1.7 2010/06/07 16:43:06 ingo Exp $
+%
+
+% <MethodDescription>
+%
+% The scale method of the ao class scales the y-data in the AO by the
+% specified factor.
+%
+% </MethodDescription>
+
+function results = utp_ao_scale(varargin)
+
+  % Check the inputs
+  if nargin == 0
+
+    % Some keywords
+    class   = 'ao';
+    mthd    = 'scale';
+
+    results = [];
+    disp('******************************************************');
+    disp(['****  Running UTPs for ' class '/' mthd]);
+    disp('******************************************************');
+
+    % Test AOs
+    [at1,at2,at3,at4,at5,at6,atvec,atmat] = eval(['get_test_objects_' class]);
+    pli = plist('FACTOR', 2, 'neval', true);
+    
+    % 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(mthd, atvec, @algo_test_y, pli, ple3)];    % Vector input
+    results = [results utp_03(mthd, atmat, @algo_test_y, pli, ple3)];    % Matrix input
+    results = [results utp_04(mthd, at1, at2, at3, @algo_test_y, pli, ple3)];    % List input
+    results = [results utp_05(mthd, at1, atvec, atmat, @algo_test_y, pli, ple3)];    % Test with mixed input
+    results = [results utp_06(mthd, at1, pli, ple2)];    % Test history is working
+    results = [results utp_07(mthd, at1, pli, ple1)];    % Test the modify call works
+    results = [results utp_09(mthd, at5, at6)];    % Test input data shape == output data shape
+    results = [results utp_10(mthd, at5, at6, ple2)];    % Test output of the data
+    results = [results utp_11(mthd, at1, ple1, pli)];    % 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
+  
+  %% Algorithm test for UTP 02,03,04,05
+  
+  function atest = algo_test_y(in, out, pli)    
+    atest = true;
+    sc = pli.find('FACTOR');
+    if ~isequal(in.y .* sc, out.y), atest = false; end
+  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('factor'), atest = false; end
+        if ~io(3).plists.isparam('yunits'), atest = false; end
+        % Check default value
+        if ~isequal(io(3).plists.find('factor'), 1), atest = false; end
+        if ~isEmptyChar(io(3).plists.find('yunits')), atest = false; end
+        % Check options
+        if ~isequal(io(3).plists.getOptionsForParam('factor'), {1}), atest = false; end
+        if ~isequal(io(3).plists.getOptionsForParam('yunits'), {''}), 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 scale method works with a vector of AOs as input.
+%   %
+%   % </TestDescription>
+%   function result = utp_02
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the scale method works for a vector of AOs as input.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       sc  = 2.2;
+%       out = scale(atvec, sc);
+%       % </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 scaled input
+%       for kk=1:numel(out)
+%         if ~isequal(atvec(kk).y .* sc, 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 scale method works with a matrix of AOs as input.
+%   %
+%   % </TestDescription>
+%   function result = utp_03
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the scale method works for a matrix of AOs as input.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       sc  = 1-2i;
+%       out = scale(atmat, sc);
+%       % </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 scaled input
+%       for kk=1:numel(out)
+%         if ~isequal(atmat(kk).y .* sc, 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 scale method works with a list of AOs as input.
+%   %
+%   % </TestDescription>
+%   function result = utp_04
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the scale method works for a list of AOs as input.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       sc  = -5;
+%       out = scale(at1,at2,at3,sc);
+%       % </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 = [at1,at2,at3];
+%     if stest
+%       % <AlgoCode>
+%       % Check we have the correct number of outputs
+%       if numel(out) ~= 3, atest = false; end
+%       % Check each output against the scaled input
+%       for kk=1:numel(out)
+%         if ~isequal(aoin(kk).y .* sc, 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 scale method works with a mix of different shaped AOs as
+%   % input.
+%   %
+%   % </TestDescription>
+%   function result = utp_05
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the scale method works with an input of matrices and
+%     % vectors and single AOs.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       sc  = 1/3;
+%       out = scale(at1,atvec,at2,atmat,at3,sc);
+%       % </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  = [at1,reshape(atvec,1,[]),at2,reshape(atmat,1,[]),at3];
+%     if stest
+%       % <AlgoCode>
+%       % Check we have the correct number of outputs
+%       if numel(out) ~= numel(aoin), atest = false; end
+%       % Check each output against the scaled input
+%       for kk=1:numel(out)
+%         if ~isequal(aoin(kk).y .* sc, 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 scale method properly applies history.
+%   %
+%   % </TestDescription>
+%   function result = utp_06
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the result of applying the scale method can be processed back.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       out  = scale(at1, 1.1);
+%       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
+%     %    'scale'.
+%     % 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, 'scale'), 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 scale method can modify the input AO.
+%   %
+%   % </TestDescription>
+%   function result = utp_07
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the scale 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.scale(1.1);
+%       amodi.scale(1.1);
+%       % </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 scaled value 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(at1), ple1), atest = false; end
+%       % Check that the modified input is the scaled value of the copy
+%       if ~isequal(at1.y .* 1.1, 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>
+%   %
+%   % Test that the scale method uses the plist to get the factor.
+%   %
+%   % </TestDescription>
+%   function result = utp_08
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the scale method uses the plist to get the factor.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       sc  = 1+1.1i;
+%       pl1 = plist('factor', sc);
+%       pl2 = plist('factor', ao(sc));
+%       pl3 = plist('factor', sc, 'yunits', 'Hz^2');
+%       out1 = scale(at1, pl1);
+%       out2 = scale(at1, pl2);
+%       out3 = scale(at1, pl3);
+%       mout1 = rebuild(out1);
+%       mout2 = rebuild(out2);
+%       mout3 = rebuild(out3);
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check the output
+%     % 4) Check that the re-built object is the same as in 'out[1..3]'.
+%     %
+%     % </AlgoDescription>
+% 
+%     atest = true;
+%     if stest
+%       % <AlgoCode>
+%       % Check each output
+%       if ~isequal(out1.y, at1.y .* sc), atest = false; end
+%       if ~isequal(out2.y, at1.y .* sc), atest = false; end
+%       if ~isequal(out3.y, at1.y .* sc), atest = false; end
+%       if ~eq(out3.yunits, unit('Hz^2')), atest = false; end
+%       % Check the re-built objects
+%       if ~eq(mout1, out1, ple1), atest = false; end
+%       if ~eq(mout2, out2, ple1), atest = false; end
+%       if ~eq(mout3, out3, ple1), 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 scale 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 = scale(at5, 2);
+%       out2 = scale(at6, 2);
+%       % </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 scale 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] = scale(at5, at6, -2);
+%       o3  = scale(at5, at6, -2);
+%       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