Mercurial > hg > ltpda
diff m-toolbox/classes/@pest/setYforParameter.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/@pest/setYforParameter.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,170 @@ +% SETYFORPARAMETER Sets the according y-value for the specified parameter. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: SETYFORPARAMETER Sets the according y-value for the +% specified parameter. +% +% CALL: obj = obj.setYforParameter('a', 1); +% obj = obj.setYforParameter('a', 1, 'b', 2); +% obj = obj.setYforParameter(plist('values', [1 2], +% 'params' {'a', 'b'})) +% +% INPUTS: obj - one pest model. +% pl - parameter list +% +% <a href="matlab:utils.helper.displayMethodInfo('pest', 'setYforParameter')">Parameters Description</a> +% +% VERSION: $Id: setYforParameter.m,v 1.7 2011/04/08 08:56:25 hewitson Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function varargout = setYforParameter(varargin) + + % Check if this is a call from a class method + callerIsMethod = utils.helper.callerIsMethod; + + if callerIsMethod + %%% make sure that the parameters and values are cell-arrays + objs = varargin{1}; + params = cellstr(varargin{2}); + vals = varargin{3}; + if ~iscell(vals) + vals = num2cell(vals); + end + + else + % Check if this is a call for parameters + if utils.helper.isinfocall(varargin{:}) + varargout{1} = getInfo(varargin{3}); + return + end + + %%% Collect input variable names + in_names = cell(size(varargin)); + for ii = 1:nargin,in_names{ii} = inputname(ii);end + + [objs, obj_invars, rest] = utils.helper.collect_objects(varargin(:), '', in_names); + [pls, invars, rest] = utils.helper.collect_objects(rest(:), 'plist'); + + params = {}; + vals = {}; + %%% If pls contains only one plist with the two keys 'params' and + %%% 'values' then set the property with a plist. + if length(pls) == 1 && isa(pls, 'plist') && nparams(pls) == 2 && isparam(pls, 'values') + params = cellstr(find(pls, 'params')); + vals = find(pls, 'values'); + if ~iscell(vals) + vals = num2cell(vals); + end + end + + while numel(rest) >= 2 + params = [params cellstr(rest{1})]; + if ~iscell(rest{2}) + vals = [vals num2cell(rest{2})]; + else + vals = [vals rest{2}]; + end + rest(2) = []; + rest(1) = []; + end + + %%% Combine plists + pls = combine(pls, plist('params', params, 'values', vals)); + + if numel(params) ~= numel(vals) + error('### Please specify one value per parameter.'); + end + + end % callerIsMethod + + %%% decide whether we modify the input pest object, or create a new one. + objs = copy(objs, nargout); + + for objLoop = 1:numel(objs) + + for ll=1:numel(params) + pname = params{ll}; + % get index of this param + idx = find(strcmp(objs(objLoop).names, pname)); + if isempty(idx) + objs(objLoop).names = [objs(objLoop).names {pname}]; + objs(objLoop).y = [objs(objLoop).y; vals{ll}]; + else + objs(objLoop).y(idx) = vals{ll}; + end + end + + if ~callerIsMethod + % set output history + objs(objLoop).addHistory(getInfo('None'), pls, obj_invars(objLoop), objs(objLoop).hist); + end + end + + %%% Set output + if nargout == numel(objs) + % List of outputs + for ii = 1:numel(objs) + varargout{ii} = objs(ii); + end + else + % Single output + varargout{1} = objs; + end + +end + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Local Functions % +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% FUNCTION: getInfo +% +% DESCRIPTION: Get Info Object +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function ii = getInfo(varargin) + if nargin == 1 && strcmpi(varargin{1}, 'None') + sets = {}; + pl = []; + else + sets = {'Default'}; + pl = getDefaultPlist; + end + % Build info object + ii = minfo(mfilename, 'pest', 'ltpda', utils.const.categories.helper, '$Id: setYforParameter.m,v 1.7 2011/04/08 08:56:25 hewitson Exp $', sets, pl); +end + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% FUNCTION: getDefaultPlist +% +% DESCRIPTION: Get Default Plist +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function plout = getDefaultPlist() + persistent pl; + if exist('pl', 'var')==0 || isempty(pl) + pl = buildplist(); + end + plout = pl; +end + +function pl = buildplist() + + pl = plist(); + + % Params + p = param({'params', 'A cell-array of parameter names.'}, {1, {'{}'}, paramValue.OPTIONAL}); + pl.append(p); + + % Value + p = param({'values', 'A cell-array of values, one for each parameter to set.'}, {1, {'{}'}, paramValue.OPTIONAL}); + pl.append(p); + +end +