Home > classes > @ao > minus.m

minus

PURPOSE ^

MINUS overloads - operator for analysis objects.

SYNOPSIS ^

function b = minus(varargin)

DESCRIPTION ^

 MINUS overloads - operator for analysis objects.

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

 DESCRIPTION: MINUS overloads - operator for analysis objects.

 CALL:        a = a1-a2

 VERSION:     $Id: minus.m,v 1.10 2007/11/02 13:17:41 ingo Exp $

 The following call returns a parameter list object that contains the
 default parameter values:

 >> pl = minus(ao, 'Params')

 HISTORY: 05-02-07 M Hewitson
             Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function b = minus(varargin)
0002 % MINUS overloads - operator for analysis objects.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: MINUS overloads - operator for analysis objects.
0007 %
0008 % CALL:        a = a1-a2
0009 %
0010 % VERSION:     $Id: minus.m,v 1.10 2007/11/02 13:17:41 ingo Exp $
0011 %
0012 % The following call returns a parameter list object that contains the
0013 % default parameter values:
0014 %
0015 % >> pl = minus(ao, 'Params')
0016 %
0017 % HISTORY: 05-02-07 M Hewitson
0018 %             Creation
0019 %
0020 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0021 
0022 ALGONAME = mfilename;
0023 VERSION  = '$Id: minus.m,v 1.10 2007/11/02 13:17:41 ingo Exp $';
0024 
0025 %% Check if this is a call for parameters
0026 if nargin == 2
0027   if isa(varargin{1}, 'ao') && ischar(varargin{2})
0028     in = char(varargin{2});
0029     if strcmp(in, 'Params')
0030       b = getDefaultPL();
0031       return
0032     elseif strcmp(in, 'Version')
0033       b = VERSION;
0034       return
0035     end
0036   end
0037 end
0038 
0039 
0040 %% capture input variable names
0041 invars = {};
0042 for j=1:nargin
0043   iname = inputname(j);
0044   if isempty(iname) && isnumeric(varargin{j})
0045     iname = num2str(varargin{j});
0046   elseif isempty(iname) && ischar(varargin{j})
0047     iname = varargin{j};
0048   end
0049   invars = [invars cellstr(iname)];
0050 end
0051 
0052 op = '-';
0053 
0054 [a1,a2,do] = aooperate(varargin, op);
0055 
0056 %--------- create output AO
0057 
0058 % make a new history object
0059 h = history(ALGONAME, VERSION, plist(), [a1.hist a2.hist]);
0060 h = set(h, 'invars', invars);
0061 
0062 % get names for output
0063 if isempty(char(invars{1}))
0064   n1 = a1.name;
0065 else
0066   n1 = char(invars{1});
0067 end
0068 if isempty(char(invars{2}))
0069   n2 = a2.name;
0070 else
0071   n2 = char(invars{2});
0072 end
0073 
0074 
0075 % make output analysis object
0076 b = ao(do, h);
0077 b = setnh(b, 'name', sprintf('%s %s %s', n1, op, n2));
0078 
0079 
0080 
0081 %% Get default params
0082 function pl_default = getDefaultPL()
0083 
0084   pl_default = plist();
0085 
0086 % END
0087

Generated on Fri 02-Nov-2007 19:39:27 by m2html © 2003