Home > classes > @ao > le.m

le

PURPOSE ^

LE overloads <= operator for analysis objects. Compare the y-axis values.

SYNOPSIS ^

function varargout = le(varargin)

DESCRIPTION ^

 LE overloads <= operator for analysis objects. Compare the y-axis values.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: LE overloads <= operator for analysis objects.
              Compare the y-axis values.

 CALL:        a = b<=c;

 INPUTS:      b - Analysis object
              c - Analysis object Or a number

 OUTPUTS:
              a - a cdata Analysis Object containing logical values from the
                  comparison.

 M-FILE INFO: Get information about this methods by calling
              >> ao.getInfo('le')

              Get information about a specified set-plist by calling:
              >> ao.getInfo('le', 'None')

 VERSION:     $Id: le.m,v 1.15 2008/09/05 11:05:29 ingo Exp $

 HISTORY:     06-02-2007 M Hewitson
                 Creation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % LE overloads <= operator for analysis objects. Compare the y-axis values.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: LE overloads <= operator for analysis objects.
0005 %              Compare the y-axis values.
0006 %
0007 % CALL:        a = b<=c;
0008 %
0009 % INPUTS:      b - Analysis object
0010 %              c - Analysis object Or a number
0011 %
0012 % OUTPUTS:
0013 %              a - a cdata Analysis Object containing logical values from the
0014 %                  comparison.
0015 %
0016 % M-FILE INFO: Get information about this methods by calling
0017 %              >> ao.getInfo('le')
0018 %
0019 %              Get information about a specified set-plist by calling:
0020 %              >> ao.getInfo('le', 'None')
0021 %
0022 % VERSION:     $Id: le.m,v 1.15 2008/09/05 11:05:29 ingo Exp $
0023 %
0024 % HISTORY:     06-02-2007 M Hewitson
0025 %                 Creation
0026 %
0027 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0028 
0029 function varargout = le(varargin)
0030 
0031   % Check if this is a call for parameters
0032   if utils.helper.isinfocall(varargin{:})
0033     varargout{1} = getInfo(varargin{3});
0034     return
0035   end
0036 
0037   if ~(nargin == 2 && ...
0038       ((isa(varargin{1}, 'ao') && isa(varargin{2}, 'ao')) || ...
0039       (isa(varargin{1}, 'ao') && isnumeric(varargin{2}))))
0040     error('### comparisons only between analysis objects and/or numbers.')
0041   end
0042 
0043   x = varargin{1}.data.getY;
0044 
0045   if isa(varargin{2}, 'ao')
0046     y = varargin{2}.data.getY;
0047   else
0048     y = varargin{2}*ones(size(x));
0049   end
0050 
0051   a = x <= y;
0052 
0053   % Set output
0054   varargout{1} = a;
0055 end
0056 
0057 %--------------------------------------------------------------------------
0058 % Get Info Object
0059 %--------------------------------------------------------------------------
0060 function ii = getInfo(varargin)
0061   if nargin == 1 && strcmpi(varargin{1}, 'None')
0062     sets = {};
0063     pl   = [];
0064   else
0065     sets = {'Default'};
0066     pl   = getDefaultPlist;
0067   end
0068   % Build info object
0069   ii = minfo(mfilename, 'ao', '', utils.const.categories.relop, '$Id: le.m,v 1.15 2008/09/05 11:05:29 ingo Exp $', sets, pl);
0070 end
0071 
0072 %--------------------------------------------------------------------------
0073 % Get Default Plist
0074 %--------------------------------------------------------------------------
0075 function pl_default = getDefaultPlist()
0076   pl_default = plist();
0077 end
0078

Generated on Mon 08-Sep-2008 13:18:47 by m2html © 2003