FindMatlab

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

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

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

Новое в версии 3.12: Добавлена поддержка Matlab Compiler Runtime (MCR).

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

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

Новое в версии 3.7: Добавлен компонент MAT_LIBRARY.

Новое в версии 3.13: Добавлены компоненты ENGINE_LIBRARY, DATAARRAY_LIBRARY и MCC_COMPILER.

Изменено в версии 3.14: Удалены компоненты MX_LIBRARY, ENGINE_LIBRARY и DATAARRAY_LIBRARY. Эти библиотеки находятся безусловно.

Примечание

Версия, предоставляемая директиве find_package(), является версией Matlab, которая не должна путаться с именем релиза Matlab (например, R2014). matlab_get_version_from_release_name() и matlab_get_release_name_from_version() обеспечивают отображение соответствия между именем релиза и версией.

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

Windows: Установленные версии Matlab/MCR извлекаются из реестра Windows
OS X: Установленные версии Matlab/MCR задаются стандартными путями установки MATLAB в /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_DIR: корень установки Matlab.
MATLAB_FIND_DEBUG: вывод отладочной информации
MATLAB_ADDITIONAL_VERSIONS: дополнительные версии Matlab для автоматического получения установленных версий.

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

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

Этот модуль определяет следующие 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_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_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, и для того, чтобы можно было запустить unit-тесты на этом 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 (17.58) из имени выпуска (R2017k)

matlab_get_release_name_from_version: Возвращает имя выпуска (R2017k) из версии Matlab (17.58)

matlab_extract_all_installed_versions_from_registry: Эта функция парсит реестр и находит установленные версии Matlab. Найденные версии возвращаются в matlab_versions. Установите win64 в TRUE, если нужно искать 64-битную версию Matlab. Возвращаемый список содержит все версии в HKLM\\SOFTWARE\\Mathworks\\MATLAB и HKLM\\SOFTWARE\\Mathworks\\MATLAB 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
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 unit-тест в набор тестов cmake/ctest. Эта команда требует компонента MAIN_PROGRAM, и поэтому она недоступна для установки MCR.

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

Функция ожидает один Matlab-скрипт теста. В случае, если NO_UNITTEST_FRAMEWORK задан, файл скрипта unit-теста должен содержать скрипт для выполнения, плюс команду выхода с выходным значением. Это выходное значение будет передано фреймворку 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: имя unit-теста в ctest.
UNITTEST_FILE: файл Matlab unit-теста. Его путь будет автоматически добавлен в путь 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 unit-тест может зависнуть.
ADDITIONAL_PATH: список путей, которые нужно добавить в путь Matlab перед запуском unit-теста.
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

Добавляет целевой MEX-файл MATLAB. Эта команда компилирует указанные исходные файлы с текущей цепочкой инструментов для создания 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]
    [...]
)

NAME: имя целевого объекта.
SRC: список исходных файлов.
LINK_TO: список дополнительных зависимостей для линковки. Целевой объект по умолчанию связывается с libmex и libmx.
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().

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

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

© 2000–2021 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.22/module/FindMatlab.html