--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/ao/utp_ao_mpower.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,488 @@
+% UTP_AO_MPOWER a set of UTPs for the ao/mpower method
+%
+% M Hewitson 06-08-08
+%
+% $Id: utp_ao_mpower.m,v 1.6 2011/02/28 15:55:13 mauro Exp $
+%
+
+% <MethodDescription>
+%
+% The mpower method of the ao class computes the matrix power of the y data
+% of the two inputs.
+%
+% </MethodDescription>
+
+function results = utp_ao_mpower(varargin)
+
+  % Check the inputs
+  if nargin == 0
+
+    % Some keywords
+    class   = 'ao';
+    mthd    = 'mpower';
+
+    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
+
+    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 ~= 1, atest = false; end
+        % Check key
+        if ~io(3).plists.isparam('exponent'), atest = false; end
+        % Check default value
+        if ~isEmptyDouble(io(3).plists.find('exponent')), atest = false; end
+        % Check options
+        if ~isequal(io(3).plists.getOptionsForParam('exponent'), {[]}), 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 mpower method works with a vector of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_02
+
+    % <SyntaxDescription>
+    %
+    % Test that the mpower 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 = [at4 ao(3) ao(1)];
+      out = mpower(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 power 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
+      % </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 mpower method works with a matrix of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_03
+
+    % <SyntaxDescription>
+    %
+    % Test that the mpower 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 = mpower(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.
+    %
+    % </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 power 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
+      % </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 mpower method works with a list of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_04
+
+    % <SyntaxDescription>
+    %
+    % Test that the mpower method works for a list of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = mpower(at4,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 power of the inputs
+      s = at4.data.getY ^ 7 ^ 4;
+      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_04
+
+  %% UTP_05
+
+  % <TestDescription>
+  %
+  % Tests that the mpower method works with a mix of different shaped AOs as
+  % input.
+  %
+  % </TestDescription>
+  function result = utp_05
+
+    % <SyntaxDescription>
+    %
+    % Test that the mpower method works with an input of matrices and vectors
+    % and single AOs.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % This UTP doen't make sense.
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Nothing to check
+    %
+    % </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_05
+
+  %% UTP_06
+
+  % <TestDescription>
+  %
+  % Tests that the mpower method properly applies history.
+  %
+  % </TestDescription>
+  function result = utp_06
+
+    % <SyntaxDescription>
+    %
+    % Test that the result of applying the mpower method can be processed back
+    % to an m-file.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out1 = mpower(at4,5);
+      out2 = mpower(at4,ao(5));
+      mout1 = rebuild(out1);
+      mout2 = rebuild(out2);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that the last entry in the history of 'out1' and 'out2' corresponds to
+    %    'mpower'.
+    % 2) Check that the re-built objects are the same objectd as 'out1' and 'out2'.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check the last step in the history of 'out1' and 'out2'
+      if ~strcmp(out1.hist.methodInfo.mname, 'mpower'), atest = false; end
+      if ~strcmp(out2.hist.methodInfo.mname, 'mpower'), 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_06
+
+  %% UTP_07
+
+  % <TestDescription>
+  %
+  % Tests that the mpower method can modify the input AO.
+  %
+  % </TestDescription>
+  function result = utp_07
+
+    % <SyntaxDescription>
+    %
+    % Test that the mpower 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.mpower(5);
+      ain ^ 5;
+      % </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 mpower(at4).
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check that mpower modified the input by comparing to the copy
+      if eq(ao(at4), ain, ple1), atest = false; end
+      % Check that mpower doesn't modified the input for the function notation
+      if ~eq(aout, ain, ple1), atest = false; end
+      % Check that the modified input is the mpower value of the copy
+      if ~isequal(mpower(at4.y, 5), ain.y), 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 the shape of the output.
+  %
+  % </TestDescription>
+  function result = utp_08
+
+    % <SyntaxDescription>
+    %
+    % Test that the mpower 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>
+      % This UTP doesn't make sense because the AO must contain a square matrix
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Nothinf to check
+    %
+    % </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_08
+
+end