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 задаются значениями по умолчанию в /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_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-тест в набор тестов 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

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