FindMatlab

Ищет Matlab или Matlab Compiler Runtime (MCR) и предоставляет инструменты, библиотеки и компиляторы Matlab для CMake.

Основная цель этого пакета — найти библиотеки, связанные с Matlab или MCR, чтобы иметь возможность создавать расширения Matlab (файлы mex). Также его можно использовать:

• для выполнения определённых команд в Matlab, если Matlab доступен
• для объявления тестов Matlab
• для получения различной информации из Matlab (расширения mex, версии и запросы выпусков и т. д.)

Модуль поддерживает следующие компоненты:

• ENG_LIBRARY и MAT_LIBRARY: соответственно библиотеки ENG и MAT Matlab
• MAIN_PROGRAM — исполняемая программа Matlab. Обратите внимание, что этот компонент недоступен в версии MCR и вызовет ошибку, если вместо обычной установки Matlab будет найден MCR.
• MEX_COMPILER — компилятор MEX.
• MCC_COMPILER — компилятор MCC, включённый в дополнение Matlab Compiler.
• SIMULINK — среда Simulink.

Переменная Matlab_ROOT_DIR может быть задана для указания пути к требуемой версии Matlab. В противном случае поведение зависит от платформы:

• Windows: Установленные версии Matlab/MCR извлекаются из реестра Windows
• macOS: Установленные версии Matlab/MCR задаются по умолчанию в /Application. Если такое приложение не найдено, оно переходит к тому, которое может быть доступно из PATH.
• Unix: Требуемый Matlab должен быть доступен из PATH. Это не работает для установки MCR, и Matlab_ROOT_DIR должен быть указан на этой платформе.

Дополнительная информация предоставляется при установке MATLAB_FIND_DEBUG. Когда установка Matlab/MCR обнаруживается автоматически, и MATLAB_VERSION не задан, версия запрашивается непосредственно у Matlab (в Windows это может открыть окно Matlab) или из установки MCR.

Сопоставление имён релизов и версии Matlab выполняется путём определения пар (имя, версия). Переменная MATLAB_ADDITIONAL_VERSIONS может быть предоставлена перед вызовом find_package() для обработки дополнительных версий.

Сценарии Matlab могут быть добавлены в набор тестов с помощью matlab_add_unit_test(). По умолчанию для выполнения этого скрипта будет использоваться фреймворк тестов Matlab (>= 2013a), но также могут быть использованы обычные файлы .m, возвращающие код завершения (0 указывает на успех).

Переменные входных данных модуля

Пользователи или проекты могут установить следующие переменные для настройки поведения модуля:

Matlab_ROOT

Новое в версии 3.25.

Значение по умолчанию для Matlab_ROOT_DIR, корня установки Matlab.

Matlab_ROOT_DIR

Корень установки Matlab.

MATLAB_FIND_DEBUG

выводит отладочную информацию

MATLAB_ADDITIONAL_VERSIONS

дополнительные версии Matlab для автоматического получения установленных версий.

Импортированные цели

Этот модуль определяет следующие IMPORTED цели:

Matlab::mex

Библиотека mex, всегда доступна.

Matlab::mx

Библиотека mx Matlab (массивы), всегда доступна.

Matlab::eng

Библиотека движка Matlab. Доступна только если запрошен компонент ENG_LIBRARY.

Matlab::mat

Библиотека матриц Matlab. Доступна только если запрошен компонент MAT_LIBRARY.

Matlab::MatlabEngine

Библиотека движка Matlab C++, всегда доступна для R2018a и более новых версий.

Matlab::MatlabDataArray

Библиотека данных массивов Matlab C++, всегда доступна для R2018a и более новых версий.

Переменные, определённые модулем

Результатные переменные

Matlab_FOUND

TRUE если установка Matlab найдена, FALSE в противном случае. Все переменные ниже определены, если Matlab найден.

Matlab_VERSION

Новое в версии 3.27.

числовая версия (например, 23.2.0) найденной версии Matlab. Не путать с именем релиза Matlab (например, R2023b), которое можно получить с помощью matlab_get_release_name_from_version().

Matlab_ROOT_DIR

конечный корень установки Matlab, определённый модулем FindMatlab.

Matlab_MAIN_PROGRAM

исполняемая программа Matlab. Доступна только если компонент MAIN_PROGRAM указан в директиве find_package().

Matlab_INCLUDE_DIRS

путь к заголовкам библиотек Matlab

Matlab_MEX_LIBRARY

библиотека для mex, всегда доступна.

Matlab_MX_LIBRARY

библиотека mx Matlab (массивы), всегда доступна.

Matlab_ENG_LIBRARY

Библиотека движка Matlab. Доступна только если запрошен компонент ENG_LIBRARY.

Matlab_MAT_LIBRARY

Библиотека матриц Matlab. Доступна только если запрошен компонент MAT_LIBRARY.

Matlab_ENGINE_LIBRARY

Новое в версии 3.13.

Библиотека движка Matlab C++, всегда доступна для R2018a и более новых версий.

Matlab_DATAARRAY_LIBRARY

Новое в версии 3.13.

Библиотека данных массивов Matlab C++, всегда доступна для R2018a и более новых версий.

Matlab_LIBRARIES

весь набор библиотек Matlab

Matlab_MEX_COMPILER

компилятор mex Matlab. В настоящее время не используется. Доступна только если запрошен компонент MEX_COMPILER.

Matlab_MCC_COMPILER

Новое в версии 3.13.

компилятор mcc Matlab. Включается с дополнением Matlab Compiler. Доступна только если запрошен компонент MCC_COMPILER.

Кешированные переменные

Matlab_MEX_EXTENSION

расширение файлов mex для текущей платформы (задано Matlab).

Matlab_ROOT_DIR

местоположение корня установки Matlab, найденной. Если это значение изменяется пользователем, переменные результата пересчитываются.

Предоставляемые команды

matlab_get_version_from_release_name()

возвращает версию из имени релиза Matlab

matlab_get_release_name_from_version()

возвращает имя релиза из версии Matlab

matlab_add_mex()

добавляет цель для компиляции файла MEX.

matlab_add_unit_test()

добавляет файл теста Matlab как тест в проект.

matlab_extract_all_installed_versions_from_registry()

парсит реестр для всех версий Matlab. Доступно только в Windows. Часть реестра, которая анализируется, зависит от процессора хоста

matlab_get_all_valid_matlab_roots_from_registry()

возвращает все возможные пути к Matlab или MCR, согласно ранее заданному списку. Сохраняются только существующие/доступные пути. Это в основном полезно для поиска всех возможных установок Matlab.

matlab_get_mex_suffix()

возвращает суффикс, который должен использоваться для файлов mex (зависит от платформы/архитектуры)

matlab_get_version_from_matlab_run()

возвращает версию Matlab/MCR, зная полный путь к каталогу установки Matlab/MCR.

Известные проблемы

Столкновение символов в целевом MEX-файле

По умолчанию все символы внутри файла MEX, определенного с помощью команды matlab_add_mex(), имеют скрытую видимость, за исключением точки входа. Это стандартное поведение компилятора MEX, которое снижает риск столкновения символов между библиотеками, поставляемыми с Matlab, и библиотеками, к которым ссылается файл MEX. Это также стандартное поведение в Windows.

Однако этого может быть недостаточно в некоторых случаях, когда, например, ваш MEX-файл ссылается на библиотеки, которые уже загружены в Matlab, даже если эти библиотеки имеют разные SONAMES. Возможным решением является скрытие символов библиотек, к которым ссылается целевой MEX-файл. Это можно сделать в компиляторах GNU GCC с помощью опции линковщика -Wl,--exclude-libs,ALL.

Тесты с использованием ресурсов GPU

Если ваш MEX-файл использует GPU, и для возможности запуска тестов на этом MEX-файле, ресурсы GPU должны быть правильно освобождены Matlab. Возможным решением является уведомление Matlab о использовании ресурсов GPU в сессии, что можно сделать, например, с помощью команды D = gpuDevice() в начале скрипта теста (или через фикстуру).

Справочник

Matlab_ROOT_DIR

Корневая папка установки Matlab. Если она установлена перед вызовом find_package(), модуль будет искать компоненты в этом пути. Если она не установлена, будет выполнен автоматический поиск Matlab. Если установлена, она должна указывать на корректную версию Matlab.

MATLAB_FIND_DEBUG

Если установлено, поиск Matlab и промежуточные этапы конфигурации выводятся в консоль.

MATLAB_ADDITIONAL_VERSIONS

Если установлено, указывает дополнительные версии Matlab, которые могут быть найдены. Переменная должна быть списком строк, организованных по парам имена релиза и версии, например:

set(MATLAB_ADDITIONAL_VERSIONS
    "release_name1=corresponding_version1"
    "release_name2=corresponding_version2"
    ...
    )

Пример:

set(MATLAB_ADDITIONAL_VERSIONS
    "R2013b=8.2"
    "R2013a=8.1"
    "R2012b=8.0")

Порядок элементов в этом списке важен, когда установлено несколько версий Matlab. Приоритет задается в соответствии с порядком в этом списке.

matlab_get_version_from_release_name

matlab_get_version_from_release_name(release version)

• Вход: release — имя релиза (например, R2023b)
• Выход: version — версия Matlab (например, 23.2.0)

Возвращает версию Matlab из имени релиза

Примечание

Эта команда предоставляет правильные сопоставления версий для Matlab, но не для MCR.

matlab_get_release_name_from_version

matlab_get_release_name_from_version(version release_name)

• Вход: version — версия Matlab (например, 23.2.0)
• Выход: release_name — имя релиза (R2023b)

Возвращает имя релиза из версии Matlab

Примечание

Эта команда предоставляет правильные сопоставления версий для Matlab, но не для MCR.

matlab_extract_all_installed_versions_from_registry

matlab_extract_all_installed_versions_from_registry(win64 matlab_versions)

• Вход: win64 — булево значение для поиска 64-разрядной версии Matlab
• Выход: matlab_versions — список всех найденных версий Matlab

Эта функция парсит реестр Windows и находит установленные версии Matlab. Найденные версии возвращаются в matlab_versions. Установите win64 в TRUE, если необходимо искать 64-разрядную версию Matlab. Возвращаемый список содержит все версии в HKLM\\SOFTWARE\\Mathworks\\MATLAB, HKLM\\SOFTWARE\\Mathworks\\MATLAB Runtime и HKLM\\SOFTWARE\\Mathworks\\MATLAB Compiler Runtime, или пустой список в случае ошибки (или ничего не найдено).

Примечание

Предоставляются только версии. Проверка существования установки, указанной в реестре, не выполняется.

matlab_get_all_valid_matlab_roots_from_registry

Заполняет корневой каталог Matlab допустимыми версиями Matlab или Matlab Runtime (MCR). Возвращаемый matlab_roots организован в тройки (type,version_number,matlab_root_path), где type указывает на MATLAB или MCR.

matlab_get_all_valid_matlab_roots_from_registry(matlab_versions matlab_roots)

• Вход: matlab_versions каждой из установок Matlab или MCR
• Выход: matlab_roots расположение каждой из установок Matlab или MCR

matlab_get_mex_suffix

Возвращает расширение файлов mex (суффиксы). Эту функцию не следует вызывать до нахождения соответствующего корневого каталога Matlab.

matlab_get_mex_suffix(matlab_root mex_suffix)

• Вход: matlab_root корневой каталог установки Matlab/MCR, например, Matlab_ROOT_DIR
• Выход: mex_suffix имя переменной, в которую будет возвращён суффикс.

matlab_get_version_from_matlab_run

Эта функция запускает программу Matlab, указанную в аргументах, и извлекает её версию. Если путь к установке Matlab указывает на установку MCR, версия извлекается из установленных файлов.

matlab_get_version_from_matlab_run(matlab_binary_path matlab_list_versions)

• Вход: matlab_binary_path путь к исполняемому файлу matlab
• Выход: matlab_list_versions извлечённая версия Matlab

matlab_add_unit_test

Добавляет тест Matlab в набор тестов cmake/ctest. Эта команда требует компонента MAIN_PROGRAM и поэтому недоступна для установки MCR.

Тест использует фреймворк Matlab unittest (по умолчанию, доступен начиная с Matlab 2013b+), если не задан параметр NO_UNITTEST_FRAMEWORK.

Функция ожидает один файл скрипта Matlab с тестом. В случае, если NO_UNITTEST_FRAMEWORK задан, файл скрипта unittest должен содержать скрипт для выполнения и команду завершения с возвращаемым значением. Это значение будет передано фреймворку ctest (0 — успех, отличное от 0 — ошибка). Дополнительные аргументы, принимаемые командой add_test(), могут быть переданы через TEST_ARGS (например, CONFIGURATION <config> ...).

matlab_add_unit_test(
    NAME <name>
    UNITTEST_FILE matlab_file_containing_unittest.m
    [CUSTOM_TEST_COMMAND matlab_command_to_run_as_test]
    [UNITTEST_PRECOMMAND matlab_command_to_run]
    [TIMEOUT timeout]
    [ADDITIONAL_PATH path1 [path2 ...]]
    [MATLAB_ADDITIONAL_STARTUP_OPTIONS option1 [option2 ...]]
    [TEST_ARGS arg1 [arg2 ...]]
    [NO_UNITTEST_FRAMEWORK]
    )

Параметры функции:

NAME

имя теста в ctest.

UNITTEST_FILE

файл скрипта Matlab с тестом. Его путь будет автоматически добавлен в путь Matlab.

CUSTOM_TEST_COMMAND

команда скрипта Matlab для запуска теста. Если не задана, то выполняется следующее: runtests('matlab_file_name'), exit(max([ans(1,:).Failed])), где matlab_file_name — UNITTEST_FILE без расширения.

UNITTEST_PRECOMMAND

команда скрипта Matlab для выполнения перед файлом с тестом (например, инициализация устройства GPU на основе переменных CMake).

TIMEOUT

таймаут теста в секундах. По умолчанию 180 секунд, так как тест Matlab может зависнуть.

ADDITIONAL_PATH

список путей для добавления в путь Matlab перед запуском теста.

MATLAB_ADDITIONAL_STARTUP_OPTIONS

список дополнительных параметров для запуска Matlab из командной строки. -nosplash -nodesktop -nodisplay всегда добавляются.

TEST_ARGS

Дополнительные параметры, предоставляемые команде add_test. Эти параметры добавляются к параметрам по умолчанию (например, "CONFIGURATIONS Release").

NO_UNITTEST_FRAMEWORK

если задано, указывает, что тест не должен использовать фреймворк unittest Matlab (доступно для версий >= R2013a).

WORKING_DIRECTORY

Это будет рабочая директория для теста. Если указана, она также будет директорией вывода, используемой для файла журнала выполнения теста. Если не указана, временная директория ${CMAKE_BINARY_DIR}/Matlab будет использоваться в качестве рабочей директории и расположения журнала.

matlab_add_mex

Добавляет цель Matlab MEX. Эта команда компилирует заданные исходные файлы с текущей цепочкой инструментов для создания файла MEX. Можно указать конечное имя выходного файла, а также дополнительные библиотеки линковки и запись документации для файла MEX. Остальные аргументы вызова передаются команде add_library() или add_executable().

matlab_add_mex(
    NAME <name>
    [EXECUTABLE | MODULE | SHARED]
    SRC src1 [src2 ...]
    [OUTPUT_NAME output_name]
    [DOCUMENTATION file.txt]
    [LINK_TO target1 target2 ...]
    [R2017b | R2018a]
    [EXCLUDE_FROM_ALL]
    [NO_IMPLICIT_LINK_TO_MATLAB_LIBRARIES]
    [...]
)

Параметры функции:

NAME

имя цели.

SRC

список файлов исходного кода.

LINK_TO

список дополнительных зависимостей линковки. Цель связывается с libmex и libmx по умолчанию, если не задан параметр NO_IMPLICIT_LINK_TO_MATLAB_LIBRARIES.

OUTPUT_NAME

если задано, переопределяет имя по умолчанию. Имя по умолчанию — имя цели без префикса и с суффиксом Matlab_MEX_EXTENSION.

DOCUMENTATION

если задано, файл file.txt рассматривается как файл документации для файла MEX. Этот файл копируется в ту же папку без обработки, с тем же именем, что и конечный файл mex, и с расширением .m. В этом случае написание help <name> в Matlab выводит документацию, содержащуюся в этом файле.

R2017b or R2018a

Новое в версии 3.14.

Можно указать версию C API для использования: R2017b указывает традиционный (раздельный комплексный) C API и соответствует флаговому параметру -R2017b для команды mex. R2018a указывает новый интегрированный комплексный C API и соответствует флаговому параметру -R2018a для команды mex. Игнорируется, если версия MATLAB до R2018a. По умолчанию R2017b.

MODULE or SHARED

Новое в версии 3.7.

Можно указать тип создаваемой библиотеки.

EXECUTABLE

Новое в версии 3.7.

Можно указать на создание исполняемого файла вместо библиотеки. Если тип не указан явно, используется тип SHARED.

EXCLUDE_FROM_ALL

Этот параметр имеет такое же значение, как для EXCLUDE_FROM_ALL и передается командам add_library() или add_executable().

NO_IMPLICIT_LINK_TO_MATLAB_LIBRARIES

Новое в версии 3.24.

Этот параметр позволяет отключить автоматическую линковку библиотек MATLAB, чтобы линковались только необходимые библиотеки с помощью параметра LINK_TO.

Файл документации не обрабатывается и должен иметь следующий формат:

% This is the documentation
function ret = mex_target_output_name(input1)