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.13 2008/07/31 17:08:28 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.13 2008/07/31 17:08:28 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 %   % Collect input variable names
0038 %   in_names = cell(size(varargin));
0039 %   for ii = 1:nargin,in_names{ii} = inputname(ii);end
0040 %
0041 %   % Collect all AOs and plists
0042 %   as = utils.helper.collect_objects(varargin(:), 'ao', in_names);
0043 %
0044 %   if numel(as) ~= 2
0045 %     error('### This method compares two AOs.');
0046 %   end
0047 
0048   if ~(nargin == 2 && ...
0049       ((isa(varargin{1}, 'ao') && isa(varargin{2}, 'ao')) || ...
0050       (isa(varargin{1}, 'ao') && isnumeric(varargin{2}))))
0051     error('### comparisons only between analysis objects and/or numbers.')
0052   end
0053 
0054   x = varargin{1}.data.getY;
0055 
0056   if isa(varargin{2}, 'ao')
0057     y = varargin{2}.data.getY;
0058   else
0059     y = varargin{2}*ones(size(x));
0060   end
0061 
0062   a = x <= y;
0063 
0064 %   % Create Output
0065 %   a = ao(double(as(1).data.y <= as(2).data.y));
0066 %   a.setName(sprintf('%s <= %s', ao_invars{1}, ao_invars{2}), 'internal');
0067 %
0068 %   % Add history
0069 %   a.addHistory(getInfo, plist, ao_invars, [as(1).hist as(2).hist]);
0070 
0071   % Set output
0072   varargout{1} = a;
0073 end
0074 
0075 %--------------------------------------------------------------------------
0076 % Get Info Object
0077 %--------------------------------------------------------------------------
0078 function ii = getInfo(varargin)
0079   if nargin == 1 && strcmpi(varargin{1}, 'None')
0080     sets = {};
0081     pl   = [];
0082   else
0083     sets = {'Default'};
0084     pl   = getDefaultPlist;
0085   end
0086   % Build info object
0087   ii = minfo(mfilename, 'ao', '', 'Relational Operator', '$Id: le.m,v 1.13 2008/07/31 17:08:28 ingo Exp $', sets, pl);
0088 end
0089 
0090 %--------------------------------------------------------------------------
0091 % Get Default Plist
0092 %--------------------------------------------------------------------------
0093 function pl_default = getDefaultPlist()
0094   pl_default = plist();
0095 end
0096

Generated on Mon 25-Aug-2008 22:39:29 by m2html © 2003