Как добавить “справку” - текст к mex-функции?

Я пишу файл MEX Matlab. Однако файлы MEX, кажется, имеют серьезное ограничение: help mexfilename не заставит текст справки появляться.

Я мог обойти это путем записи m-файла, который в конечном счете называет файл MEX, но включает справку, но должен быть лучший путь.

С другой стороны, тот способ, которым я мог сделать всю проверку ошибок в m-файле, где намного более удобно сделать так...

8
задан Amro 21 August 2012 в 16:39
поделиться

2 ответа

Я полагаю, что PierreBdR является правильным; Вы создали бы m-версию-файла своей функции только с блокированием вызова заголовка и блоком комментария, но никаким телом.

Это не могло бы быть плохой идеей поместить проверку ошибок на исходные данные в m-файле, затем иметь m-файл, вызывают файл MEX (Вам, вероятно, придется дать им различные имена, хотя). Это может быть более просто, чтобы проверить переменные в MATLAB (использование, например, созданный-ins как nargchk) и поместить их в стандартный формат, который можно всегда хотеть, чтобы исходные данные к функции mex имели. Многие функции Панели инструментов Обработки изображений, на которые я посмотрел, кажется, делают это (форматирующие и проверяющие данные в m-файле, затем делающем дорогие вычисления в файле MEX).

11
ответ дан 5 December 2019 в 10:44
поделиться

Необходимо создать m-файл (name.m) с тем же именем как файл MEX (name.c). Затем Вы помещаете объявление функции и текст справки, но никакое тело функции. Пример:

function [o1,o2] = MyFct(i1,i2,i3)
% MyFct takes 3 arguments and returns 2 ...      
5
ответ дан 5 December 2019 в 10:44
поделиться
Другие вопросы по тегам:

Похожие вопросы: