diff m-toolbox/classes/@smodel/linearize.m @ 0:f0afece42f48

Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/m-toolbox/classes/@smodel/linearize.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,105 @@
+% LINEARIZE output the derivatives of the model relative to the parameters.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: LINEARIZE output the derivatives of the model relative to
+% the parameters. Output is a collection of models corresponding to the
+% derivative of input model for each parameter
+%
+% CALL:        dmod = linearize(imod)
+%              
+% <a href="matlab:utils.helper.displayMethodInfo('smodel', 'linearize')">Parameters Description</a>
+%
+% VERSION:     $Id: linearize.m,v 1.9 2011/04/08 08:56:30 hewitson Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+function varargout = linearize(varargin)
+  
+  % Check if this is a call for parameters
+  if utils.helper.isinfocall(varargin{:})
+    varargout{1} = getInfo(varargin{3});
+    return
+  end
+  
+  % Check if the method was called by another method
+  callerIsMethod = utils.helper.callerIsMethod;
+  
+  % Collect input variable names
+  in_names = cell(size(varargin));
+  for ii = 1:nargin,in_names{ii} = inputname(ii);end
+  
+  % Collect all smodels and plists
+  [as, smodel_invars, rest] = utils.helper.collect_objects(varargin(:), 'smodel', in_names);
+  [pl, pl_invars, rest]     = utils.helper.collect_objects(rest(:), 'plist', in_names);
+  
+  % Combine input plists and default plist
+  pl = parse(pl, getDefaultPlist());
+
+  % run over input smodels
+  dmod(numel(as),1) = collection;
+  for jj = 1:numel(as)
+    imod = as(jj);
+    [mpars,idx] = sort(imod.params);
+    mvals = imod.values(idx);
+    imod.setParams(mpars, mvals);
+
+    pars = imod.params;
+
+    for ii = 1:numel(pars)
+      tmod = diff(imod, pars{ii}); % do symbolic derivative for smodel
+      % set the name of the parameter to the matrix, this is important to
+      % identify automatically to what derivatives we are referring
+      tmod.setName(pars{ii});
+      dmod(jj).addObjects(tmod);
+    end
+     dmod(jj).setName(sprintf('linearize(%s)', imod.name));
+  end
+  
+  if ~callerIsMethod
+    % Add history
+    dmod.addHistory(getInfo('None'), pl, smodel_invars, [as(:).hist]);  
+  end
+  
+  if nargout == 1
+    varargout{1} = dmod;
+  elseif nargout == numel(as)
+    % List of outputs
+    for jj = 1:numel(as)
+      varargout{jj} = dmod.index(jj);
+    end
+  else
+    error('Set at least one output value')
+  end
+  
+end
+
+%--------------------------------------------------------------------------
+% Get Info Object
+%--------------------------------------------------------------------------
+function ii = getInfo(varargin)
+  
+  if nargin == 1 && strcmpi(varargin{1}, 'None')
+    sets = {};
+    pls  = [];
+  else
+    sets = {'Default'};
+    pls  = getDefaultPlist;
+  end
+  % Build info object
+  ii = minfo(mfilename, 'smodel', 'ltpda', utils.const.categories.op, '$Id: linearize.m,v 1.9 2011/04/08 08:56:30 hewitson Exp $', sets, pls);
+  ii.setModifier(false);
+end
+
+%--------------------------------------------------------------------------
+% Get Default Plist
+%--------------------------------------------------------------------------
+function plout = getDefaultPlist()
+  persistent pl;  
+  if ~exist('pl', 'var') || isempty(pl)
+    pl = buildplist();
+  end
+  plout = pl;  
+end
+
+function pl = buildplist()
+  pl = plist.EMPTY_PLIST;
+end