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
• 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

Новое в версии 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.

числовая версия (например, 9.13) найденного Matlab. Не следует путать с именем релиза Matlab (например, R2022b), которое можно получить с помощью 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_get_release_name_from_version()

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

Предоставленные функции

matlab_add_mex()

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

matlab_add_unit_test()

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

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_get_version_from_release_name(release version)

• Вход: release — имя релиза (R2022b)
• Выход: version — версия Matlab (9.13)

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

matlab_get_release_name_from_version

matlab_get_release_name_from_version(version release_name)

• Вход: version — версия Matlab (9.13)
• Выход: release_name — имя релиза (R2022b)

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

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 или пустой список в случае ошибки (или ничего не найдено).

Примечание

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

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 unit test в набор тестов cmake/ctest. Эта команда требует компонента MAIN_PROGRAM и поэтому недоступна для установки MCR.

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

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

UNITTEST_FILE

файл Matlab unittest. Его путь будет автоматически добавлен в путь 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 перед запуском unit test.

MATLAB_ADDITIONAL_STARTUP_OPTIONS

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

TEST_ARGS

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

NO_UNITTEST_FRAMEWORK

если установлено, указывает, что тест не должен использовать фреймворк unit test 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)