Как работать с парами имя / значение аргументов функции в MATLAB - PullRequest
63 голосов
/ 05 мая 2010

У меня есть функция, которая принимает необязательные аргументы в качестве пар имя / значение.

function example(varargin)
% Lots of set up stuff
vargs = varargin;
nargs = length(vargs);
names = vargs(1:2:nargs);
values = vargs(2:2:nargs);

validnames = {'foo', 'bar', 'baz'};    
for name = names
   validatestring(name{:}, validnames);
end

% Do something ...
foo = strmatch('foo', names);
disp(values(foo))
end

example('foo', 1:10, 'bar', 'qwerty')

Кажется, что при извлечении соответствующих значений требуется много усилий (и она все еще не особенно надежнаопять плохо указаны входы).Есть ли лучший способ обработки этих пар имя / значение?Есть ли вспомогательные функции, которые поставляются с MATLAB для помощи?

Ответы [ 13 ]

56 голосов
/ 05 мая 2010

Я предпочитаю использовать структуры для своих опций. Это дает вам простой способ хранения опций и простой способ их определения. Кроме того, все становится довольно компактным.

function example(varargin)

%# define defaults at the beginning of the code so that you do not need to
%# scroll way down in case you want to change something or if the help is
%# incomplete
options = struct('firstparameter',1,'secondparameter',magic(3));

%# read the acceptable names
optionNames = fieldnames(options);

%# count arguments
nArgs = length(varargin);
if round(nArgs/2)~=nArgs/2
   error('EXAMPLE needs propertyName/propertyValue pairs')
end

for pair = reshape(varargin,2,[]) %# pair is {propName;propValue}
   inpName = lower(pair{1}); %# make case insensitive

   if any(strcmp(inpName,optionNames))
      %# overwrite options. If you want you can test for the right class here
      %# Also, if you find out that there is an option you keep getting wrong,
      %# you can use "if strcmp(inpName,'problemOption'),testMore,end"-statements
      options.(inpName) = pair{2};
   else
      error('%s is not a recognized parameter name',inpName)
   end
end
43 голосов
/ 05 мая 2010

InputParser помогает в этом.Подробнее см. Входы функции анализа .

12 голосов
/ 06 мая 2010

Я мог бы часами тратить на это, но у меня все еще нет хорошего гештальтового представления об общей обработке подписи Matlab. Но вот пара советов.

Во-первых, возьмите laissez faire подход к проверке типов ввода. Доверяй звонящему. Если вы действительно хотите сильное тестирование типов, вам нужен статический язык, такой как Java. Старайтесь обеспечивать безопасность типов везде, где есть в Matlab, и у вас в конечном итоге будет значительная часть вашего LOC и время выполнения, посвященное тестам времени выполнения и принуждению в пользовательском пространстве, что обуславливает большую мощность и скорость разработки Matlab. , Я научился этому нелегко.

Для сигнатур API (функций, предназначенных для вызова из других функций, а не из командной строки), рассмотрите возможность использования одного аргумента Args вместо varargin. Затем его можно передавать между несколькими аргументами без необходимости преобразовывать его в разделенный запятыми список для подписей varargin. Структуры, как говорит Джонас, очень удобны. Есть также хороший изоморфизм между структурами и n-by-2 {name, value; ...} ячейками, и вы можете настроить пару функций для преобразования между ними внутри ваших функций в зависимости от того, что он хочет использовать внутри.

function example(args)
%EXAMPLE
%
% Where args is a struct or {name,val;...} cell array

Независимо от того, используете ли вы inputParser или прокручиваете свой собственный синтаксический анализатор name / val, как в этих других прекрасных примерах, упакуйте его в отдельную стандартную функцию, которую вы будете вызывать из верхней части ваших функций, имеющих сигнатуры name / val. Сделайте так, чтобы он принимал список значений по умолчанию в структуре данных, которую удобно записывать, и ваши вызовы синтаксического анализа будут выглядеть как объявления сигнатур функций, которые помогают удобочитаемости и позволяют избежать копирования и вставки стандартного кода.

Вот как могут выглядеть парсинговые вызовы.

function out = my_example_function(varargin)
%MY_EXAMPLE_FUNCTION Example function 

% No type handling
args = parsemyargs(varargin, {
    'Stations'  {'ORD','SFO','LGA'}
    'Reading'   'Min Temp'
    'FromDate'  '1/1/2000'
    'ToDate'    today
    'Units'     'deg. C'
    });
fprintf('\nArgs:\n');
disp(args);

% With type handling
typed_args = parsemyargs(varargin, {
    'Stations'  {'ORD','SFO','LGA'}     'cellstr'
    'Reading'   'Min Temp'              []
    'FromDate'  '1/1/2000'              'datenum'
    'ToDate'    today                   'datenum'
    'Units'     'deg. C'                []
    });
fprintf('\nWith type handling:\n');
disp(typed_args);

% And now in your function body, you just reference stuff like
% args.Stations
% args.FromDate

А вот функция для реализации анализа имени / val таким образом. Вы можете выдвинуть это и заменить его на inputParser, ваши собственные соглашения о типах и т. Д. Я думаю, что соглашение о ячейках n-на-2 создает приятный для чтения исходный код; рассмотреть вопрос о сохранении этого. Структуры обычно удобнее иметь в принимающем коде, но ячейки n-на-2 удобнее создавать с использованием выражений и литералов. (Структуры требуют продолжения ", ..." в каждой строке и защиты значений ячеек от расширения до нескалярных структур.)

function out = parsemyargs(args, defaults)
%PARSEMYARGS Arg parser helper
%
% out = parsemyargs(Args, Defaults)
%
% Parses name/value argument pairs.
%
% Args is what you pass your varargin in to. It may be
%
% ArgTypes is a list of argument names, default values, and optionally
% argument types for the inputs. It is an n-by-1, n-by-2 or n-by-3 cell in one
% of these forms forms:
%   { Name; ... }
%   { Name, DefaultValue; ... }
%   { Name, DefaultValue, Type; ... }
% You may also pass a struct, which is converted to the first form, or a
% cell row vector containing name/value pairs as 
%   { Name,DefaultValue, Name,DefaultValue,... }
% Row vectors are only supported because it's unambiguous when the 2-d form
% has at most 3 columns. If there were more columns possible, I think you'd
% have to require the 2-d form because 4-element long vectors would be
% ambiguous as to whether they were on record, or two records with two
% columns omitted.
%
% Returns struct.
%
% This is slow - don't use name/value signatures functions that will called
% in tight loops.

args = structify(args);
defaults = parse_defaults(defaults);

% You could normalize case if you want to. I recommend you don't; it's a runtime cost
% and just one more potential source of inconsistency.
%[args,defaults] = normalize_case_somehow(args, defaults);

out = merge_args(args, defaults);

%%
function out = parse_defaults(x)
%PARSE_DEFAULTS Parse the default arg spec structure
%
% Returns n-by-3 cellrec in form {Name,DefaultValue,Type;...}.

if isstruct(x)
    if ~isscalar(x)
        error('struct defaults must be scalar');
    end
    x = [fieldnames(s) struct2cell(s)];
end
if ~iscell(x)
    error('invalid defaults');
end

% Allow {name,val, name,val,...} row vectors
% Does not work for the general case of >3 columns in the 2-d form!
if size(x,1) == 1 && size(x,2) > 3
    x = reshape(x, [numel(x)/2 2]);
end

% Fill in omitted columns
if size(x,2) < 2
    x(:,2) = {[]}; % Make everything default to value []
end
if size(x,2) < 3
    x(:,3) = {[]}; % No default type conversion
end

out = x;

%%
function out = structify(x)
%STRUCTIFY Convert a struct or name/value list or record list to struct

if isempty(x)
    out = struct;
elseif iscell(x)
    % Cells can be {name,val;...} or {name,val,...}
    if (size(x,1) == 1) && size(x,2) > 2
        % Reshape {name,val, name,val, ... } list to {name,val; ... }
        x = reshape(x, [2 numel(x)/2]);
    end
    if size(x,2) ~= 2
        error('Invalid args: cells must be n-by-2 {name,val;...} or vector {name,val,...} list');
    end

    % Convert {name,val, name,val, ...} list to struct
    if ~iscellstr(x(:,1))
        error('Invalid names in name/val argument list');
    end
    % Little trick for building structs from name/vals
    % This protects cellstr arguments from expanding into nonscalar structs
    x(:,2) = num2cell(x(:,2)); 
    x = x';
    x = x(:);
    out = struct(x{:});
elseif isstruct(x)
    if ~isscalar(x)
        error('struct args must be scalar');
    end
    out = x;
end

%%
function out = merge_args(args, defaults)

out = structify(defaults(:,[1 2]));
% Apply user arguments
% You could normalize case if you wanted, but I avoid it because it's a
% runtime cost and one more chance for inconsistency.
names = fieldnames(args);
for i = 1:numel(names)
    out.(names{i}) = args.(names{i});
end
% Check and convert types
for i = 1:size(defaults,1)
    [name,defaultVal,type] = defaults{i,:};
    if ~isempty(type)
        out.(name) = needa(type, out.(name), type);
    end
end

%%
function out = needa(type, value, name)
%NEEDA Check that a value is of a given type, and convert if needed
%
% out = needa(type, value)

% HACK to support common 'pseudotypes' that aren't real Matlab types
switch type
    case 'cellstr'
        isThatType = iscellstr(value);
    case 'datenum'
        isThatType = isnumeric(value);
    otherwise
        isThatType = isa(value, type);
end

if isThatType
    out = value;
else
    % Here you can auto-convert if you're feeling brave. Assumes that the
    % conversion constructor form of all type names works.
    % Unfortunately this ends up with bad results if you try converting
    % between string and number (you get Unicode encoding/decoding). Use
    % at your discretion.
    % If you don't want to try autoconverting, just throw an error instead,
    % with:
    % error('Argument %s must be a %s; got a %s', name, type, class(value));
    try
        out = feval(type, value);
    catch err
        error('Failed converting argument %s from %s to %s: %s',...
            name, class(value), type, err.message);
    end
end

К сожалению, строки и даты не являются первоклассными типами в Matlab.

6 голосов
/ 06 мая 2010

Лично я использую пользовательскую функцию, основанную на частном методе, который используется многими функциями Statistics Toolbox (например, kmeans, pca, svmtrain, ttest2, ...)

Будучи внутренней утилитой, она менялась и много раз переименовывалась в релизах. В зависимости от вашей версии MATLAB, попробуйте найти один из следующих файлов:

%# old versions
which -all statgetargs
which -all internal.stats.getargs
which -all internal.stats.parseArgs

%# current one, as of R2014a
which -all statslib.internal.parseArgs

Как и для любой недокументированной функции, никаких гарантий нет, и она может быть удалена из MATLAB в последующих выпусках без какого-либо уведомления ... В любом случае, я считаю, что кто-то опубликовал старую версию этой программы как getargs Файловый обмен ..

Функция обрабатывает параметры как пары имя / значение, используя набор допустимых имен параметров вместе со значениями по умолчанию. Он возвращает проанализированные параметры как отдельные выходные переменные. По умолчанию нераспознанные пары имя / значение вызывают ошибку, но мы также можем молча записать их в дополнительный вывод. Вот описание функции:

$MATLABROOT\toolbox\stats\stats\+internal\+stats\parseArgs.m

function varargout = parseArgs(pnames, dflts, varargin)
%
% [A,B,...] = parseArgs(PNAMES, DFLTS, 'NAME1',VAL1, 'NAME2',VAL2, ...)
%   PNAMES   : cell array of N valid parameter names.
%   DFLTS    : cell array of N default values for these parameters.
%   varargin : Remaining arguments as name/value pairs to be parsed.
%   [A,B,...]: N outputs assigned in the same order as the names in PNAMES.
%
% [A,B,...,SETFLAG] = parseArgs(...)
%   SETFLAG  : structure of N fields for each parameter, indicates whether
%              the value was parsed from input, or taken from the defaults.
%
% [A,B,...,SETFLAG,EXTRA] = parseArgs(...)
%   EXTRA    : cell array containing name/value parameters pairs not
%              specified in PNAMES.

Пример:

function my_plot(x, varargin)
    %# valid parameters, and their default values
    pnames = {'Color', 'LineWidth', 'LineStyle', 'Title'};
    dflts  = {    'r',           2,        '--',      []};

    %# parse function arguments
    [clr,lw,ls,txt] = internal.stats.parseArgs(pnames, dflts, varargin{:});

    %# use the processed values: clr, lw, ls, txt
    %# corresponding to the specified parameters
    %# ...
end

Теперь эту функцию примера можно вызвать любым из следующих способов:

>> my_plot(data)                                %# use the defaults
>> my_plot(data, 'linestyle','-', 'Color','b')  %# any order, case insensitive
>> my_plot(data, 'Col',[0.5 0.5 0.5])           %# partial name match

Вот некоторые недопустимые вызовы и выданные ошибки:

%# unrecognized parameter
>> my_plot(x, 'width',0)
Error using [...]
Invalid parameter name: width.

%# bad parameter
>> my_plot(x, 1,2)
Error using [...]
Parameter name must be text.

%# wrong number of arguments
>> my_plot(x, 'invalid')
Error using [...]
Wrong number of arguments.

%# ambiguous partial match
>> my_plot(x, 'line','-')
Error using [...]
Ambiguous parameter name: line.

inputParser:

Как уже упоминалось, официально рекомендуемый подход к синтаксическому анализу входных функций заключается в использовании inputParser класса. Он поддерживает различные схемы, такие как указание необходимых входных данных, необязательные позиционные аргументы и параметры имя / значение. Он также позволяет выполнять проверку на входах (например, проверку класса / типа и размера / формы аргументов)

5 голосов
/ 06 мая 2010

Читать Информационный пост Лорен по этому вопросу. Не забудьте прочитать раздел комментариев ... - Вы увидите, что существует довольно много разных подходов к этой теме. Все они работают, поэтому выбор предпочтительного метода действительно зависит от личного вкуса и удобства обслуживания.

3 голосов
/ 05 мая 2010

Я большой поклонник домашнего кода котельной плиты, как это:

function TestExample(req1, req2, varargin)
for i = 1:2:length(varargin)
    if strcmpi(varargin{i}, 'alphabet')
        ALPHA = varargin{i+1};

    elseif strcmpi(varargin{i}, 'cutoff')
        CUTOFF = varargin{i+1};
        %we need to remove these so seqlogo doesn't get confused
        rm_inds = [rm_inds i, i+1]; %#ok<*AGROW>

    elseif strcmpi(varargin{i}, 'colors')
        colors = varargin{i+1};
        rm_inds = [rm_inds i, i+1]; 
    elseif strcmpi(varargin{i}, 'axes_handle')
        handle = varargin{i+1};
        rm_inds = [rm_inds i, i+1]; 
    elseif strcmpi(varargin{i}, 'top-n')
        TOPN = varargin{i+1};
        rm_inds = [rm_inds i, i+1];
    elseif strcmpi(varargin{i}, 'inds')
        npos = varargin{i+1};
        rm_inds = [rm_inds i, i+1];
    elseif strcmpi(varargin{i}, 'letterfile')
        LETTERFILE = varargin{i+1};
        rm_inds = [rm_inds i, i+1];
    elseif strcmpi(varargin{i}, 'letterstruct')
        lo = varargin{i+1};
        rm_inds = [rm_inds i, i+1];
    end
end

Таким образом, я могу смоделировать 'option', пару значений, которая почти идентична тому, как большинство функций Matlab принимают свои аргументы.

Надеюсь, это поможет,

Будет

1 голос
/ 07 декабря 2016

Существует замечательная функция parsepvpairs, которая прекрасно справляется с этой задачей, если у вас есть доступ к финансовому инструментарию MATLAB. Он принимает три аргумента, ожидаемые имена полей, значения полей по умолчанию и фактические полученные аргументы.

Например, вот функция, которая создает HTML-фигуру в MATLAB и может принимать необязательные пары значений полей с именами «url», «html» и «title».

function htmldlg(varargin)
    names = {'url','html','title'};
    defaults = {[],[],'Padaco Help'};
    [url, html,titleStr] = parsepvpairs(names,defaults,varargin{:});

    %... code to create figure using the parsed input values
end
1 голос
/ 23 сентября 2014

С возрастов я использую process_options.m.Он стабилен, прост в использовании и включен в различные среды Matlab.Хотя ничего не знаю о производительности - возможно, есть более быстрые реализации.

Функция, которая мне больше всего нравится с process_options, - это возвращаемое значение unused_args, которое можно использовать для разделения входных аргументов по группам аргументов, например, для подпроцессов.

определить значения по умолчанию.

Самое главное: использование process_options.m обычно приводит к читаемым и поддерживаемым определениям параметров.

Пример кода:

function y = func(x, y, varargin)

    [u, v] = process_options(varargin,
                             'u', 0,
                             'v', 1);
1 голос
/ 13 января 2014

Вдохновленный ответом Йонаса, но более компактный:

function example(varargin)
  defaults = struct('A',1, 'B',magic(3));  %define default values

  params = struct(varargin{:});
  for f = fieldnames(defaults)',
    if ~isfield(params, f{1}),
      params.(f{1}) = defaults.(f{1});
    end
  end

  %now just access them as params.A, params.B
1 голос
/ 06 мая 2010

Вот решение, которое я пробую, основанное на идее Джонаса.

function argStruct = NameValuePairToStruct(defaults, varargin)
%NAMEVALUEPAIRTOSTRUCT Converts name/value pairs to a struct.
% 
% ARGSTRUCT = NAMEVALUEPAIRTOSTRUCT(DEFAULTS, VARARGIN) converts
% name/value pairs to a struct, with defaults.  The function expects an
% even number of arguments to VARARGIN, alternating NAME then VALUE.
% (Each NAME should be a valid variable name.)
% 
% Examples: 
% 
% No defaults
% NameValuePairToStruct(struct, ...
%    'foo', 123, ...
%    'bar', 'qwerty', ...
%    'baz', magic(3))
% 
% With defaults
% NameValuePairToStruct( ...
%    struct('bar', 'dvorak', 'quux', eye(3)), ...
%    'foo', 123, ...
%    'bar', 'qwerty', ...
%    'baz', magic(3))
% 
% See also: inputParser

nArgs = length(varargin);
if rem(nArgs, 2) ~= 0
   error('NameValuePairToStruct:NotNameValuePairs', ...
      'Inputs were not name/value pairs');
end

argStruct = defaults;
for i = 1:2:nArgs
   name = varargin{i};
   if ~isvarname(name)
      error('NameValuePairToStruct:InvalidName', ...
         'A variable name was not valid');
   end
   argStruct = setfield(argStruct, name, varargin{i + 1});  %#ok<SFLD>
end

end
...