--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/ao/utp_ao_linSubtract.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,425 @@
+% UTP_AO_LINSUBTRACT a set of UTPs for the ao/linSubtract method
+%
+% M Nofrarias 05-07-09
+%
+% $Id: utp_ao_linSubtract.m,v 1.3 2009/08/07 10:47:05 hewitson Exp $
+%
+
+% <MethodDescription>
+%
+% LINSUBTRACT subtracts a linear contribution from an input ao
+%
+% </MethodDescription>
+
+function results = utp_ao_linSubtract(varargin)
+  
+  % Check the inputs
+  if nargin == 0
+    
+    % Some keywords
+    class   = 'ao';
+    mthd    = 'linSubtract';
+    
+    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 output of the data
+    
+    pl = plist('coupling',{{'n(1)'},{'n(2)'}},'fc',[0.1 0.4]);
+    amat = [at1 at5 at6; at5 at6 at1];
+    results = [results utp_11(mthd, amat, ple1, pl)];    % 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>
+    
+    % <SyntaxCode>
+    try
+      % 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
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+    % </SyntaxCode>
+    
+    % <AlgoDescription>
+    %
+    % 1) Check that getInfo call returned an minfo object in all cases.
+    % 2) Check that all plists have the correct parameters.
+    %
+    % </AlgoDescription>
+    
+    % <AlgoCode>
+    atest = true;
+    if stest
+      % 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 ~= 5, atest = false; end
+        % Check key
+        % Check default value
+        % Check options
+      end
+    else
+      atest = false;
+    end
+    % </AlgoCode>
+    
+    % Return a result structure
+    result = utp_prepare_result(atest, stest, dbstack, mfilename);
+  end % END UTP_01
+  
+  %% UTP_02
+  
+  % <TestDescription>
+  %
+  % Tests that the linSubtract method works with a vector of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_02
+    
+    % <SyntaxDescription>
+    %
+    % Test that the linSubtract method works for a vector of AOs as input.
+    %
+    % </SyntaxDescription>
+    
+    % <SyntaxCode>
+    try
+      avec = [at1 at5 at6];
+      fs = at1.fs;
+      pl = plist('coupling',{{'n(1)'},{'n(2)'}},'fc',[0.1 0.4]);
+      out  = linSubtract(avec,pl);
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+    % </SyntaxCode>
+    
+    % <AlgoDescription>
+    %
+    % 1) Check that the number of elements in 'out' is the square of the
+    %    number in the input.
+    % 2) Check that each output AO contains the correct data.
+    %
+    % </AlgoDescription>
+    
+    % <AlgoCode>
+    atest = true;
+    if stest
+      % Check we have the correct number of outputs
+      if numel(out) ~= 1, atest = false; end
+    else
+      atest = false;
+    end
+    % </AlgoCode>
+    
+    % Return a result structure
+    result = utp_prepare_result(atest, stest, dbstack, mfilename);
+  end % END UTP_02
+  
+  %% UTP_03
+  
+  % <TestDescription>
+  %
+  % Tests that the linSubtract method works with a matrix of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_03
+    
+    % <SyntaxDescription>
+    %
+    % Test that the linSubtract method works for a matrix of AOs as input.
+    %
+    % </SyntaxDescription>
+    
+    % <SyntaxCode>
+    try
+      amat = [at1 at5 at6; at5 at6 at1];
+      pl = plist('coupling',{{'n(1)'},{'n(2)'}},'fc',[0.1 0.4]);
+      out  = linSubtract(amat,pl);
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+    % </SyntaxCode>
+    
+    % <AlgoDescription>
+    %
+    % 1) Check that the number of elements in 'out' is the square of the
+    %    number in the input.
+    % 2) Check that each output AO contains the correct data.
+    %
+    % </AlgoDescription>
+    
+    % <AlgoCode>
+    atest = true;
+    if stest
+      % Check we have the correct number of outputs
+      if numel(out) ~= 1, atest = false; end
+    else
+      atest = false;
+    end
+    % </AlgoCode>
+    
+    % Return a result structure
+    result = utp_prepare_result(atest, stest, dbstack, mfilename);
+  end % END UTP_03
+  
+  %% UTP_04
+  
+  % <TestDescription>
+  %
+  % Tests that the linSubtract method works with a list of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_04
+    
+    % <SyntaxDescription>
+    %
+    % Test that the linSubtract method works for a list of AOs as input.
+    %
+    % </SyntaxDescription>
+    
+    % <SyntaxCode>
+    try
+      pl = plist('coupling',{{'n(1)'},{'n(2)'}},'fc',[0.1 0.4]);
+      out = linSubtract(at1,at5,at6,pl);
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+    % </SyntaxCode>
+    
+    % <AlgoDescription>
+    %
+    % 1) Check that the number of elements in 'out' is the square of the
+    %    number in the input.
+    % 2) Check that each output AO contains the correct data.
+    %
+    % </AlgoDescription>
+    
+    % <AlgoCode>
+    atest = true;
+    if stest
+      % Check we have the correct number of outputs
+      if numel(out) ~= 1, atest = false; end
+    else
+      atest = false;
+    end
+    % </AlgoCode>
+    
+    % Return a result structure
+    result = utp_prepare_result(atest, stest, dbstack, mfilename);
+  end % END UTP_04
+  
+  %% UTP_05
+  
+  % <TestDescription>
+  %
+  % Tests that the linSubtract method works with a mix of different shaped AOs as
+  % input.
+  %
+  % </TestDescription>
+  function result = utp_05
+    
+    % <SyntaxDescription>
+    %
+    % Test that the linSubtract method works with an input of matrices and vectors
+    % and single AOs.
+    %
+    % </SyntaxDescription>
+    
+    % <SyntaxCode>
+    try
+      pl = plist('coupling',{{'n(1)'},{'n(2)'}},'fc',[0.1 0.4]);
+      out = linSubtract(at1,[at5 at6],at5,[at5 at1; at6 at1],at6,pl);
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+    % </SyntaxCode>
+    
+    % <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>
+    
+    % <AlgoCode>
+    atest = true;
+    if stest
+      % Check we have the correct number of outputs
+      if numel(out) ~= 1, atest = false; end
+    else
+      atest = false;
+    end
+    % </AlgoCode>
+    
+    % Return a result structure
+    result = utp_prepare_result(atest, stest, dbstack, mfilename);
+  end % END UTP_05
+  
+  %% UTP_06
+  % <TestDescription>
+  %
+  % Tests that the linSubtract method properly applies history.
+  %
+  % </TestDescription>
+  function result = utp_06
+    
+    % <SyntaxDescription>
+    %
+    % Test that the result of applying the linSubtract method can be processed back
+    % to an m-file.
+    %
+    % </SyntaxDescription>
+    
+    % <SyntaxCode>
+    try
+      pl = plist('coupling',{{'n(1)'},{'n(2)'}},'fc',[0.1 0.4]);
+      out  = linSubtract(at1,at5,at6,pl);
+      mout = rebuild(out);
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+    % </SyntaxCode>
+    
+    % <AlgoDescription>
+    %
+    % 1) Check that the last entry in the history of 'out' corresponds to
+    %    'linSubtract'.
+    % 2) Check that the re-built object is the same object as 'out'.
+    %
+    % </AlgoDescription>
+    
+    % <AlgoCode>
+    atest = true;
+    if stest
+      % Check the last step in the history of 'out'
+      if ~strcmp(out.hist.methodInfo.mname, 'linSubtract'), atest = false; end
+      % Check the re-built object
+      if ~eq(mout, out, ple2), atest = false; end
+    else
+      atest = false;
+    end
+    % </AlgoCode>
+    
+    % Return a result structure
+    result = utp_prepare_result(atest, stest, dbstack, mfilename);
+  end % END UTP_06
+  
+  %% UTP_07
+
+  % <TestDescription>
+  %
+  % Tests that the linSubtract method can not modify the input AO.
+  %
+  % </TestDescription>
+  function result = utp_07
+
+    % <SyntaxDescription>
+    %
+    % Test that the tfe method can not modify the input AO.
+    % The method must throw an error for the modifier call.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+       % copy at1 to work with
+      ain = ao(at1);
+      % modify ains[s[s[s[[[[[[s[
+      pl = plist('coupling',{{'n(1)'},{'n(2)'}},'fc',[0.1 0.4]);
+      ain.linSubtract(at1,at5,at6,pl);
+      % </SyntaxCode>
+      stest = false;
+    catch err
+      stest = true;
+    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_07
+  
+  
+  
+end
+