--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/miir/utp_miir_setHistout.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,477 @@
+% UTP_MIIR_SETHISTOUT a set of UTPs for the miir/setHistout method
+%
+% M Hewitson 06-08-08
+%
+% $Id: utp_miir_setHistout.m,v 1.8 2011/04/19 18:14:01 ingo Exp $
+%
+
+% <MethodDescription>
+%
+% The setHistout method of the miir class sets the histout property.
+%
+% </MethodDescription>
+
+function results = utp_miir_setHistout(varargin)
+
+  % Check the inputs
+  if nargin == 0
+
+    % Some keywords
+    class   = 'miir';
+    mthd    = 'setHistout';
+
+    results = [];
+    disp('******************************************************');
+    disp(['****  Running UTPs for ' class '/' mthd]);
+    disp('******************************************************');
+
+    % Test MIIR objects
+    [iirhp,iirlp,iirbp,iirbr,iirpzm,iirab,iirv,iirm] = get_test_objects_miir;
+
+    % 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];    % Set the property with a plist
+
+    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('histout'), atest = false; end
+        % Check default value
+        if ~isEmptyDouble(io(3).plists.find('histout')), atest = false; end
+        % Check options
+        if ~isequal(io(3).plists.getOptionsForParam('histout'), {[]}), 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 setHistout method works with a vector of MIIR objects as input.
+  %
+  % </TestDescription>
+  function result = utp_02
+
+    % <SyntaxDescription>
+    %
+    % The setHistout should set the output history (histout) of each input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      vals = [1 2 3];
+      out = setHistout(iirv, vals);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check the histout has the correct values
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      if ~isequal(out.histout, vals), 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 setHistout method works with a matrix of MIIR objects as input.
+  %
+  % </TestDescription>
+  function result = utp_03
+
+    % <SyntaxDescription>
+    %
+    % The setHistout should set the output history (histout) of each input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      vals = [1 2 3];
+      out = setHistout(iirm, vals);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check the histout has the correct values
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      if ~isequal(out.histout, vals), 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 setHistout method works with a list of MIIR objects as input.
+  %
+  % </TestDescription>
+  function result = utp_04
+
+    % <SyntaxDescription>
+    %
+    % The setHistout should set the output history (histout) of each input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      vals = [1 2 3];
+      out = setHistout(iirhp,iirpzm,iirbp, vals);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check the histout has the correct values
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      if ~isequal(out.histout, vals), 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 setHistout method works with a mix of different shaped MIIR
+  % objects as input.
+  %
+  % </TestDescription>
+  function result = utp_05
+
+    % <SyntaxDescription>
+    %
+    % The setHistout method is not designed for this call, for that reason must
+    % this call fail.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      vals = [1 2 3];
+      out = setHistout(iirhp,iirv,iirpzm,iirm,iirbp, vals);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      stest = fail;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check the histout has the correct values
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      if ~isequal(out.histout, vals), 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 setHistout method properly applies history and that the
+  % option 'internal' suppresses the history.
+  %
+  % </TestDescription>
+  function result = utp_06
+
+    % <SyntaxDescription>
+    %
+    % Test that the result of applying the setHistout method can be processed back
+    % to an m-file.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out1 = setHistout(iirhp, [1 2 3]);
+      out2 = testCallerIsMethod(@setHistout, iirhp, [1 2 3]);
+      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' corresponds to
+    %    'setHistout'.
+    % 2) Check that the last entry in the history of 'out2' NOT corresponds to
+    %    'setHistout'.
+    % 3) Check that the method rebuild produces the same object as 'out'.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check the last step in the history of 'out1'
+      if ~(strcmp(out1.hist.methodInfo.mname, 'setHistout') && ...
+          eq(out1.hist.plistUsed, plist('histout', [1 2 3]), ple1))
+        atest = false;
+      end
+      % Check the last step in the history of 'out2'
+      if eq(out2.hist.plistUsed, plist('histout', [1 2 3]), ple1)
+        atest = false;
+      end
+      % Check the rebuilt object
+      if ~eq(mout1, out1, ple2), atest = false; end
+      e = ple2.find('EXCEPTIONS');
+      ple = plist('EXCEPTIONS', [e {'histout'}]);
+      if ~eq(mout2, out2, ple), 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 setHistout method can modify the input MIIR object.
+  %
+  % </TestDescription>
+  function result = utp_07
+
+    % <SyntaxDescription>
+    %
+    % Test that the setHistout method can modify the input MIIR object
+    % by calling with no output.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % copy iirhp to work with
+      ain = miir(iirhp);
+      % modify ain
+      aout = ain.setHistout([1 2 3]);
+      ain.setHistout([1 2 3]);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that 'iirhp' and 'ain' are now different.
+    % 2) Check that 'ain' has the correct histout field
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check that setHistout modified the input by comparing to the copy
+      if eq(miir(iirhp), ain, ple1), atest = false; end
+      % Check that setHistout doesn't modified the input for the function notation
+      if ~eq(aout, ain, ple1), atest = false; end
+      % Check that the modified object contains the changed value
+      if ~eq(ain.histout, [1 2 3]), 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 setHistout method can set the property with a plist.
+  %
+  % </TestDescription>
+  function result = utp_08
+
+    % <SyntaxDescription>
+    %
+    % Test that the setHistout method can modify the property 'histout'
+    % with a value in a plist.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      pl  = plist('histout', [1 2 3]);
+      out = iirhp.setHistout(pl);
+      mout = rebuild(out);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that 'ain' has the correct histout field
+    % 2) Check that the method rebuild produces the same object as 'out'.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check the field 'histout'
+      if ~eq(out.histout, [1 2 3]), atest = false; end
+      % Check the rebuilt 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