Home > classes > @ao > rdivide.m

rdivide

PURPOSE ^

RDIVIDE overloads ./ operator for analysis objects.

SYNOPSIS ^

function b = rdivide(varargin)

DESCRIPTION ^

 RDIVIDE overloads ./ operator for analysis objects.

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

 DESCRIPTION: RDIVIDE overloads ./ operator for analysis objects.

 CALL:        a = a1./scalar

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

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

 >> pl = rdivide(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 = rdivide(varargin)
0002 % RDIVIDE overloads ./ operator for analysis objects.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: RDIVIDE overloads ./ operator for analysis objects.
0007 %
0008 % CALL:        a = a1./scalar
0009 %
0010 % VERSION:     $Id: rdivide.m,v 1.11 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 = rdivide(ao, 'Params')
0016 %
0017 % HISTORY: 05-02-07 M Hewitson
0018 %             Creation
0019 %
0020 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0021 
0022 ALGONAME = mfilename;
0023 VERSION  = '$Id: rdivide.m,v 1.11 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 %% capture input variable names
0040 invars = {};
0041 for j=1:nargin
0042   iname = inputname(j);
0043   if isempty(iname) && isnumeric(varargin{j})
0044     iname = num2str(varargin{j});
0045   elseif isempty(iname) && ischar(varargin{j})
0046     iname = varargin{j};
0047   end
0048   invars = [invars cellstr(iname)];
0049 end
0050 
0051 op = './';
0052 
0053 [a1,a2,do] = aooperate(varargin, op);
0054 
0055 %--------- create output AO
0056 
0057 % make a new history object
0058 h = history(ALGONAME, VERSION, plist(), [a1.hist a2.hist]);
0059 h = set(h, 'invars', invars);
0060 
0061 % get names for output
0062 if isempty(char(invars{1}))
0063   n1 = a1.name;
0064 else
0065   n1 = char(invars{1});
0066 end
0067 if isempty(char(invars{2}))
0068   n2 = a2.name;
0069 else
0070   n2 = char(invars{2});
0071 end
0072 
0073 % make output analysis object
0074 % op = op(2:end);
0075 b = ao(do, h);
0076 b = setnh(b, 'name', sprintf('%s %s %s', n1, op, n2));
0077 
0078 %% Get default params
0079 function pl_default = getDefaultPL()
0080 
0081   pl_default = plist();
0082 
0083 % END

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