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.9 2007/06/22 08:32:49 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.9 2007/06/22 08:32:49 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 %% Check if this is a call for parameters
0023 if nargin == 2
0024   if isa(varargin{1}, 'ao') && ischar(varargin{2})
0025     in = char(varargin{2});
0026     if strcmp(in, 'Params')
0027       b = getDefaultPL();
0028       return
0029     end
0030   end
0031 end
0032 
0033 %% capture input variable names
0034 invars = {};
0035 for j=1:nargin
0036   iname = inputname(j);
0037   if isempty(iname) && isnumeric(varargin{j})
0038     iname = num2str(varargin{j});
0039   elseif isempty(iname) && ischar(varargin{j})
0040     iname = varargin{j};
0041   end
0042   invars = [invars cellstr(iname)];
0043 end
0044 
0045 ALGONAME = mfilename;
0046 VERSION  = '$Id: rdivide.m,v 1.9 2007/06/22 08:32:49 ingo Exp $';
0047 
0048 op = './';
0049 
0050 [a1,a2,do] = aooperate(varargin, op);
0051 
0052 %--------- create output AO
0053 
0054 % make a new history object
0055 h = history(ALGONAME, VERSION, [], [a1.hist a2.hist]);
0056 h = set(h, 'invars', invars);
0057 
0058 % get names for output
0059 if isempty(char(invars{1}))
0060   n1 = a1.name;
0061 else
0062   n1 = char(invars{1});
0063 end
0064 if isempty(char(invars{2}))
0065   n2 = a2.name;
0066 else
0067   n2 = char(invars{2});
0068 end
0069 
0070 % make output analysis object
0071 % op = op(2:end);
0072 b = ao(do, h);
0073 b = set(b, 'name', sprintf('%s %s %s', n1, op, n2));
0074 
0075 %% Get default params
0076 function pl_default = getDefaultPL()
0077 
0078 disp('* creating default plist...');
0079   pl_default = plist();
0080 disp('* done.');
0081 
0082 % END

Generated on Mon 03-Sep-2007 12:12:34 by m2html © 2003