% UTP_PARFRAC_GETUPPERFREQ a set of UTPs for the parfrac/getupperFreq method
%
% M Hewitson 06-08-08
%
% $Id: utp_parfrac_getupperFreq.m,v 1.3 2011/04/04 13:39:11 ingo Exp $
%

% <MethodDescription>
%
% The getupperFreq method of the parfrac class gets the frequency of the
% lowest pole in the model. This is a very simple method which accepts only
% one parfrac as input thus are the most general units test not possible.
%
% </MethodDescription>

function results = utp_parfrac_getupperFreq(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'parfrac';
    mthd    = 'getupperFreq';

    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');

    % 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];    % Algorithm test
    results = [results utp_03];    % Negative test with more than one parfrac

    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 ~= 0, atest = false; end
        % Check key
        % Check default value
        % Check options
      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 the getupperFreq method of the parfrac class.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the getupperFreq returns the lowest frequence of the pole
    % in the parfrac object.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      p1 = pz(3,2); % f = 3
      p2 = pz(40);  % f = 40
      p3 = pz(2,3); % f = 2
      p4 = pz(100); % f = 100
      pole_ri = [p1.ri.', p2.ri.', p3.ri.', p4.ri.'];
      res     = [1 2 3 4 5 6];
      pf = parfrac(res, pole_ri);
      out = getupperFreq(pf);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-15;
    if stest
      % <AlgoCode>
      if abs(out-100)>TOL, 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 the getupperFreq method of the parfrac class.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the getupperFreq throws an error if the input are more than
    % one parfrac.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      p1 = pz(3,2); % f = 3
      p2 = pz(40);  % f = 40
      p3 = pz(2,3); % f = 2
      p4 = pz(100); % f = 100
      pole_ri = [p1.ri.', p2.ri.', p3.ri.', p4.ri.'];
      res     = [1 2 3 4 5 6];
      pf = parfrac(res, pole_ri, []);
      out = getupperFreq([pf, pf]);
      stest = false;
      % </SyntaxCode>
    catch
      stest = true;
    end

    % <AlgoDescription>
    %
    % 1) Nothing to test
    %
    % </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_03

end