--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/ao/utp_ao_hist.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,698 @@
+% UTP_AO_HIST a set of UTPs for the ao/hist method
+%
+% M Hewitson 06-08-08
+%
+% $Id: utp_ao_hist.m,v 1.12 2010/06/07 16:43:06 ingo Exp $
+%
+
+% <MethodDescription>
+%
+% The hist method of the ao class histograms the y
+% and/or x data.
+%
+% </MethodDescription>
+
+function results = utp_ao_hist(varargin)
+
+  % Check the inputs
+  if nargin == 0
+
+    % Some keywords
+    class   = 'ao';
+    mthd    = 'hist';
+
+    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 the data shape
+    results = [results utp_09];    % Test output of the data
+    results = [results utp_10];    % Test with plist: 'N'
+
+    results = [results utp_11(mthd, at1, ple1)];    % Test plotinfo doesn't disappear    
+    
+    results = [results utp_12];    % Test with plist: 'X'
+
+    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, 'Number of bins')), atest = false; end
+        if ~any(strcmpi(io(2).sets, 'Bin centres')), atest = false; end
+        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
+        %%%%%%%%%%   SET 'Number of bins'
+        if io(3).plists.nparams ~= 2, atest = false; end
+        % Check key
+        if ~io(3).plists.isparam('N'), atest = false; end
+        if ~io(3).plists.isparam('Norm'), atest = false; end
+        % Check default value
+        if ~isequal(io(3).plists.find('N'), 10), atest = false; end
+        if ~isequal(io(3).plists.find('Norm'), false), atest = false; end
+        % Check options
+        if ~isequal(io(3).plists.getOptionsForParam('N'), {10}), atest = false; end
+        if ~isequal(io(3).plists.getOptionsForParam('Norm'), {false, true}), atest = false; end
+        %%%%%%%%%%   SET 'Bin centres'
+        if io(4).plists.nparams ~= 1, atest = false; end
+        % Check key
+        if ~io(4).plists.isparam('X'), atest = false; end
+        % Check default value
+        if ~isEmptyDouble(io(3).plists.find('X')), atest = false; end
+        % Check options
+        if ~isequal(io(4).plists.getOptionsForParam('X'), {[]}), 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 hist method works with a vector of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_02
+
+    % <SyntaxDescription>
+    %
+    % Test that the hist method works for a vector of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = hist(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 histogram of the input
+      for kk=1:numel(out)
+        if ~isequal(hist(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 hist method works with a matrix of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_03
+
+    % <SyntaxDescription>
+    %
+    % Test that the hist method works for a matrix of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % We need a matrix without matrix cdata AOs in it
+      amat = [at1 at5 at6; at6 at1 at2];
+      out = hist(amat);
+      % </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(amat)), atest = false; end
+      % Check each output against the histogram value of the input
+      for kk=1:numel(out)
+        if ~isequal(hist(amat(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 hist method works with a list of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_04
+
+    % <SyntaxDescription>
+    %
+    % Test that the hist method works for a list of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = hist(at1,at2,at3);
+      % </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 histogram value of the input
+      if ~isequal(hist(at1.data.getY).', out(1).data.getY), atest = false; end
+      if ~isequal(hist(at2.data.getY).', out(2).data.getY), atest = false; end
+      if ~isequal(hist(at3.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 hist method works with a mix of different shaped AOs as
+  % input.
+  %
+  % </TestDescription>
+  function result = utp_05
+
+    % <SyntaxDescription>
+    %
+    % Test that the hist method works with an input of matrices and vectors
+    % and single AOs.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % We need a matrix without matrix cdata AOs in it
+      amat = [at1 at5 at6; at6 at1 at2];
+      out = hist(at1,atvec,at2,amat,at3);
+      % </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(amat)+numel(atvec)), atest = false; end
+      % Check the first input
+      nout = 1;
+      if ~isequal(hist(at1.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(hist(atvec(jj).data.getY).', out(nout).data.getY), atest = false; end
+        nout = nout+1;
+      end
+      % Check the 3rd input
+      if ~isequal(hist(at2.data.getY).', out(nout).data.getY), atest = false; end
+      nout = nout+1;
+      % Check the elements of the input matrix
+      for jj=1:numel(amat)
+        if ~isequal(hist(amat(jj).data.getY).', out(nout).data.getY), atest = false; end
+        nout = nout+1;
+      end
+      % Check the last input
+      if ~isequal(hist(at3.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 hist method properly applies history.
+  %
+  % </TestDescription>
+  function result = utp_06
+
+    % <SyntaxDescription>
+    %
+    % Test that the result of applying the hist method can be processed back
+    % to an m-file.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out  = hist(at1);
+      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
+    %    'hist'.
+    % 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, 'hist'), atest = false; end
+      % Check the re-built object
+      if ~eq(mout, out, ple4), 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 hist method can modify the input AO.
+  %
+  % </TestDescription>
+  function result = utp_07
+
+    % <SyntaxDescription>
+    %
+    % Test that the hist method can modify the input AO by calling with no
+    % output. Remark that the command at1.hist() doesn't call the histogram
+    % method because an AO have a property with the name 'hist'. Thus the
+    % command at1.hist returns the value in the property hist.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % copy at1 to work with
+      ain = ao(at1);
+      % modify ain
+      aout = hist(ain);
+      hist(ain);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that 'at1' and 'ain' are now different.
+    % 2) Check that 'ain' is hist(at1).
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check that hist modified the input by comparing to the copy
+      if eq(ao(at1), ain, ple1), atest = false; end
+      % Check that hist doesn't modified the input for the function notation
+      if ~eq(aout, ain, ple1), atest = false; end
+      % Check that the modified input is the hist of the copy
+      [n, x] = hist(at1.y, 10);
+      if ~isequal(n.', ain.y), atest = false; end
+      if ~isequal(x.', ain.x), 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 hist method keeps the data shape of the input object.
+  %
+  % </TestDescription>
+  function result = utp_08
+
+    % <SyntaxDescription>
+    %
+    % Test that the hist 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   = hist(at5);
+      out2   = hist(at6);
+      % </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(at5.data.y), atest = false; end
+      if size(out2.data.y) ~= size(at6.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_08
+
+  %% UTP_09
+
+  % <TestDescription>
+  %
+  % Check that the hist method pass back the output objects to a list of
+  % output variables or to a single variable.
+  %
+  % </TestDescription>
+  function result = utp_09
+
+    % <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] = hist(at5, at6);
+      o3  = hist(at5, at6);
+      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_09
+
+  %% UTP_10
+
+  % <TestDescription>
+  %
+  % Control the method with a plist.
+  %
+  % </TestDescription>
+  function result = utp_10
+
+    % <SyntaxDescription>
+    %
+    % Test the hist method with a factor and an offset.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      N    = 10;
+      pl   = plist('N', N);
+      out  = hist(at5, pl);
+      mout = rebuild(out);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that the hist method with defined number of bins
+    % 2) Check that the re-built object is the same object as 'out'.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      [n, x] = hist(at5.y, N);
+      if ~isequal(n.', out.y), atest = false; end
+      if ~isequal(x.', out.x), atest = false; end
+      if ~isequal(length(out.y), N), 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_10
+
+  %% UTP_12
+
+  % <TestDescription>
+  %
+  % Control the method with a plist.
+  %
+  % </TestDescription>
+  function result = utp_12
+
+    % <SyntaxDescription>
+    %
+    % Test the hist method with a factor and an offset.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      X    = [-1.5:.1:1.5];
+      pl   = plist('X', X);
+      out  = hist(at5, pl);
+      mout = rebuild(out);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that the hist method with set of bin centers
+    % 2) Check that the re-built object is the same object as 'out'.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      [n, x] = hist(at5.y, X);
+      if ~isequal(n.', out.y), atest = false; end
+      if ~isequal(x.', out.x), atest = false; end
+      if ~isequal(X.', out.x), atest = false; end
+      if ~isequal(length(out.y), length(X)), 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_12
+
+end