% UTP_AO_STD a set of UTPs for the ao/std method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_std.m,v 1.14 2011/04/17 11:10:54 hewitson Exp $
%

% <MethodDescription>
%
% The std method of the ao class computes the standard deviation of the y
% and/or x data.
%
% </MethodDescription>

function results = utp_ao_std(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'ao';
    mthd    = 'std';
    
    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');
    
    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = eval(['get_test_objects_' class]);
    
    % Overide to include only data2D objects
    atmat = [at1 at5 at2; at2 at1 at6];
    
    % 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, [], ple3)];    % Vector input
    results = [results utp_03(mthd, atmat, @algo_test_y, [], ple3)];    % Matrix input
    results = [results utp_04(mthd, at1, at2, at3, @algo_test_y, [], ple3)];    % List input
    results = [results utp_05(mthd, at1, atvec, atmat, @algo_test_y, [], ple3)];    % Test with mixed input
    results = [results utp_06(mthd, at1, [], ple2)];    % Test history is working
    results = [results utp_07(mthd, at1, [], ple1)];    % Test the modify call works
    results = [results utp_108(mthd, at1, ple2)];    % Test with additional plist with the key 'axis'
    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)];    % 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;
    if ~isequal(std(in.data.getY).', out.data.getY)
      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')
        atest = true;
        % 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, '1D')), atest = false; end
        if ~any(strcmpi(io(2).sets, '2D')), atest = false; end
        if ~any(strcmpi(io(2).sets, '3D')), atest = false; end
        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
        % SET '1D'
        % Check key
        if ~io(3).plists.isparam('axis'), atest = false; end
        if ~io(3).plists.isparam('dim'), atest = false; end
        if ~io(3).plists.isparam('option'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('axis'), 'y'), atest = false; end
        if ~isEmptyDouble(io(3).plists.find('dim')), atest = false; end
        if ~isequal(io(3).plists.find('option'), 0), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('axis'),   {'y'}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('dim'),    {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('option'), {0}), atest = false; end
        % SET '2D'
        % Check key
        if ~io(4).plists.isparam('axis'), atest = false; end
        if ~io(4).plists.isparam('dim'), atest = false; end
        if ~io(4).plists.isparam('option'), atest = false; end
        % Check default value
        if ~isequal(io(4).plists.find('axis'), 'y'), atest = false; end
        if ~isEmptyDouble(io(4).plists.find('dim')), atest = false; end
        if ~isequal(io(4).plists.find('option'), 0), atest = false; end
        % Check options
        if ~isequal(io(4).plists.getOptionsForParam('axis'),   {'x', 'y', 'xy'}), atest = false; end
        if ~isequal(io(4).plists.getOptionsForParam('dim'),    {[]}), atest = false; end
        if ~isequal(io(4).plists.getOptionsForParam('option'), {0}), atest = false; end
        % SET '3D'
        % Check key
        if ~io(5).plists.isparam('axis'), atest = false; end
        if ~io(5).plists.isparam('dim'), atest = false; end
        if ~io(5).plists.isparam('option'), atest = false; end
        % Check default value
        if ~isequal(io(5).plists.find('axis'), 'z'), atest = false; end
        if ~isEmptyDouble(io(5).plists.find('dim')), atest = false; end
        if ~isequal(io(5).plists.find('option'), 0), atest = false; end
        % Check options
        if ~isequal(io(5).plists.getOptionsForParam('axis'),   {'x', 'y', 'z', 'xyz'}), atest = false; end
        if ~isequal(io(5).plists.getOptionsForParam('dim'),    {[]}), atest = false; end
        if ~isequal(io(5).plists.getOptionsForParam('option'), {0}), 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
  
  
end