matlab::data::ArrayFactory

Класс C++ для создания массивов

Описание

Использование ArrayFactory для создания matlab::data::Array объекты.

Информации о классе

Пространство имен:	`matlab::data`
Включите:	`ArrayFactory.hpp`

Конструкторы

Конструктор по умолчанию

Конструктор по умолчанию

ArrayFactory()

Броски

matlab::data::FailedToLoadLibMatlabDataArrayException

Конкретная реализация не загружена.

Деструктор

~ArrayFactory()

`createArray`

template <typename T>
TypedArray<T> createArray(ArrayDimensions dims)

template <typename ItType, typename T>
TypedArray<T> createArray(ArrayDimensions dims, 
    ItType begin, 
    ItType end)

template <typename T>
TypedArray<T> createArray(ArrayDimensions dims, 
    const T* const begin, 
    const T* const end)

template <typename T> 
TypedArray<T> createArray(ArrayDimensions dims, 
    std::initializer_list<T> data)

Описание

Создает TypedArray<T> с заданными размерностями. Если задано, createArray заполняет массив данными. Данные копируются и должны быть в основном порядке.

Параметры шаблона

ItType - Типы итераторов, заданные как std::iterator.

T - Типы элементов, заданные как один из следующих типов данных C++.

`bool`	`int8_t`	`int16_t`	`int32_t`	`int64_t`	`uint8_t`
`uint16_t`	`uint32_t`	`uint64_t`	`float`	`double`	`char16_t`
`matlab::data::String`	`std::complex<double>`	`std::complex<float>`	`std::complex<int8_t>`	`std::complex<uint8_t>`	`std::complex<int16_t>`
`std::complex<uint16_t>`	`std::complex<int32_t>`	`std::complex<uint32_t>`	`std::complex<int64_t>`	`std::complex<uint64_t>`	`matlab::data::MATLABString`

Чтобы создать массив matlab::data::Object типы элементов, используйте TypedArray<T> createArray(ArrayDimensions dims, ItType begin, ItType end) синтаксис.

Параметры

`ArrayDimensions dims`	Размерности для массива.
`ItType begin` `ItType end`	Начало и конец предоставленных пользователем данных. The `value_type` итератора определяет тип данных.
`const T* const begin` `const T* const end`	Начало и конец предоставленных пользователем данных в виде указателя на C-стиль. Этот синтаксис поддерживает все примитивные типы, сложные типы и строковые типы.
`std::initializer_list<T>`	Список инициализаторов, содержащий данные.

Броски

`matlab::OutOfMemoryException`	Не удается выделить массив.
`matlab::data::NumberOfElementsExceedsMaximumException`	Количество элементов больше `size_t`.
`matlab::data::InvalidArrayTypeException`	Входной тип `matlab::data::ObjectArray` не совпадает с типом `TypedArray<T>`.

`createScalar`

template <typename T>
TypedArray<T> createScalar(const T val)

TypedArray<String> createScalar(const String val)

TypedArray<String> createScalar(const std::string val)

ObjectArray createScalar(const Object& val);

Описание

Создает скаляр TypedArray<T> с заданным значением. Этот метод поддерживает арифметические типы, сложные типы и строковые типы.

Параметры

`const T val`	Значение, которое будет вставлено в скаляр. Для `std::string` параметры, если `val` является 7-битными данными ASCII, затем метод преобразует их в UTF16.
`const String val`
`const std::string val`
`const Object& val`

Броски

`matlab::OutOfMemoryException`	Не удается выделить массив.
`matlab::data::NonAsciiCharInInputDataException`	Вход `std::string` и содержит символы, отличные от ASCII.

Примеры

#include "MatlabDataArray.hpp"

int main() {
    matlab::data::ArrayFactory factory;

    // Create a vector containing two scalar values    
    std::vector<matlab::data::Array> args({
	factory.createScalar<int16_t>(100),
	factory.createScalar<int16_t>(60)});
    return 0;
}

`createCellArray`

CellArray createCellArray(ArrayDimensions dims)

template <typename ...Targs>
CellArray createCellArray(ArrayDimensions dims, Targs... data)

Описание

Создает CellArray с заданным data. Данные указаны в основном порядке.

Параметры шаблона

...Targs

Вариадный шаблон:

арифметический тип
комплексный тип
matlab::data::String
std::string
matlab::data::Array

Параметры

`ArrayDimensions dims`	Размерности массива ячеек.
`Targs... data`	Элементы, которые будут вставлены в массив ячеек, заданные как примитивный комплексный тип, строка или `Array`.

Броски

`matlab::OutOfMemoryException`	Не удается выделить массив.
`matlab::data::NonAsciiCharInInputDataException`	Вход `std::string` и содержит символы, отличные от ASCII.
`matlab::data::NumberOfElementsExceedsMaximumException`	Количество элементов больше `size_t`.

Примеры

#include "MatlabDataArray.hpp"

int main()
{
	using namespace matlab::data;
	ArrayFactory f;
	CellArray myArray = f.createCellArray({ 1,2 },
		f.createCharArray("MATLAB Cell Array"),
		f.createArray<double>({ 2,2 }, { 1.2, 2.2, 3.2, 4.2 });

	return 0;
}

`createCharArray`

CharArray createCharArray(String str)

CharArray createCharArray(std::string str)

Описание

Создание CharArray 1xn от заданного входа, где n - длина строки.

Параметры

`matlab::data::String str`	Данные, которые будут заполнены в массив.
`std::string str`

Броски

`matlab::OutOfMemoryException`	Не удается выделить массив.
`matlab::data::NonAsciiCharInInputDataException`	Вход `std::string` и содержит символы, отличные от ASCII.

Примеры

#include "MatlabDataArray.hpp"

int main() {
    using namespace matlab::data;
    ArrayFactory factory;
    CharArray A = factory.createCharArray("This is a char array");
    return 0;
}

`createStructArray`

StructArray createStructArray(ArrayDimensions dims, 
    std::vector<std::string> fieldNames)

Описание

Создает StructArray с заданными размерностями и именами полей.

Параметры

`ArrayDimensions dims`	Размерности для массива.
`std::vector<std::string> fieldNames`	Вектор имен полей для структуры.

Броски

`matlab::OutOfMemoryException`	Не удается выделить массив.
`matlab::data::DuplicateFieldNameInStructArrayException`	Заданы повторяющиеся имена полей.
`matlab::data::NumberOfElementsExceedsMaximumException`	Количество элементов больше `size_t`.

Примеры

#include "MatlabDataArray.hpp"

int main() {
    using namespace matlab::data;
    ArrayFactory f;

    // Create StructArray equivalent to MATLAB structure s:
    // s = struct('loc', {'east', 'west'}, 'data', {[1, 2, 3], [4., 5., 6., 7., 8.]})
    StructArray S = f.createStructArray({ 1,2 }, { "loc", "data" });
    S[0]["loc"] = f.createCharArray("east");
    S[0]["data"] = f.createArray<uint8_t>({ 1, 3 }, { 1, 2, 3 });
    S[1]["loc"] = f.createCharArray("west");
    S[1]["data"] = f.createArray<double>({ 1, 5 }, { 4., 5., 6., 7., 8. });

    // Access the value defined by the MATLAB statement:
    // s(1).data
    Reference<Array> val = S[0]["data"];
	
    return 0;
}

`createEnumArray`

EnumArray createEnumArray(ArrayDimensions dims, 
    std::string className, 
    std::vector<std::string> enums)

EnumArray createEnumArray(ArrayDimensions dims, 
    std::string className)

Описание

Создание EnumArray типа className, который является определенным классом. Если задан, метод инициализирует массив со списком имен перечислений.

Параметры

`ArrayDimensions dims`	Размерности для массива.
`std::string className`	Имя класса массива перечисления.
`std::vector<std::string> enums`	Список имен перечислений.

Броски

`matlab::OutOfMemoryException`	Не удается выделить массив.
`matlab::data::MustSpecifyClassNameException`	Имя класса не задано.
`matlab::data::WrongNumberOfEnumsSuppliedException`	Неверное количество предоставленных перечислений.
`matlab::data::NumberOfElementsExceedsMaximumException`	Количество элементов больше `size_t`.

Примеры

#include "MatlabDataArray.hpp"
#include <vector>

int main()
{
	using namespace matlab::data;
	ArrayFactory f;
	auto blue = f.createEnumArray({ 1,1 }, "TextColor", { "Blue" });

	// Create an argument vector
	std::vector<Array> args({ f.createCharArray("My text"), std::move(blue) });

	return 0;
}

`createSparseArray`

template <typename T>
SparseArray<T> createSparseArray(ArrayDimensions dims, 
    size_t nnz,
    buffer_ptr_t<T> data, 
    buffer_ptr_t<size_t> rows, 
    buffer_ptr_t<size_t> cols)

Описание

Создает SparseArray<T> с rows-by- cols размерности. Вы можете иметь только две размерности для разреженных массивов. Метод не копирует буфер, и массив принимает владение памятью.

Параметры шаблона

`T`	Типы элементов, заданные как `double`, `bool`, или `std::complex<double>`.

Параметры

`ArrayDimensions dims`	Размерности для массива.
`size_t nnz`	Количество ненулевых элементов.
`buffer_ptr_t<T> data`	Буфер, содержащий ненулевые элементы.
`buffer_ptr_t<size_t> rows`	Буфер, содержащий значение строки для каждого элемента.
`buffer_ptr_t<size_t> cols`	Буфер, содержащий значение столбца для каждого элемента.

Броски

`matlab::OutOfMemoryException`	Не удается выделить массив.
`matlab::data::InvalidDimensionsInSparseArrayException`	Заданы более двух размерности.
`matlab::data::NumberOfElementsExceedsMaximumException`	Количество элементов больше `size_t`.

Примеры

#include "MatlabDataArray.hpp"

int main() {
	std::vector<double> data = { 3.5, 12.98, 21.76 };
	std::vector<size_t> rows = { 0,0,1 };
	std::vector<size_t> cols = { 0,4,8 };
	size_t nnz = 3;

	matlab::data::ArrayFactory factory;
	auto data_p = factory.createBuffer<double>(nnz);
	auto rows_p = factory.createBuffer<size_t>(nnz);
	auto cols_p = factory.createBuffer<size_t>(nnz);

	double* dataPtr = data_p.get();
	size_t* rowsPtr = rows_p.get();
	size_t* colsPtr = cols_p.get();
	std::for_each(data.begin(), data.end(), [&](const double& e) { *(dataPtr++) = e; });
	std::for_each(rows.begin(), rows.end(), [&](const size_t& e) { *(rowsPtr++) = e; });
	std::for_each(cols.begin(), cols.end(), [&](const size_t& e) { *(colsPtr++) = e; });

	matlab::data::SparseArray<double> arr =
		factory.createSparseArray<double>({ 2,9 }, nnz, std::move(data_p),
			std::move(rows_p), std::move(cols_p));
	return 0;
}

`createEmptyArray`

Array createEmptyArray()

Описания

Создает пустую Array не содержит элементов.

Возвраты

Array

Пустой массив.

Броски

matlab::OutOfMemoryException

Не удается выделить массив.

`createBuffer`

template <typename T>
buffer_ptr_t<T> createBuffer(size_t numberOfElements)

Описание

Создает неинициализированный буфер, который передается в createArrayFromBuffer способ.

Параметры шаблона

`T`	Примитивные типы.

Параметры

size_t numberOfElements

Количество элементов, а не фактический buffer size.

Возвраты

buffer_ptr_t<T>

Unique_ptr, содержащий буфер.

Броски

matlab::OutOfMemoryException

Не удается выделить массив.

`createArrayFromBuffer`

template <typename T>
TypedArray<T> createArrayFromBuffer(ArrayDimensions dims, 
    buffer_ptr_t<T> buffer,
    MemoryLayout memoryLayout = MemoryLayout::COLUMN_MAJOR)

Описание

Создает TypedArray<T> использование данного буфера.

Параметры шаблона

`T`	Примитивные типы.

Параметры

`ArrayDimensions dims`	Размерности для массива.
`buffer_ptr_t<T> buffer`	Буфер, содержащий данные. Буфер не копируется. The `TypedArray<T>` объект принимает право собственности на буфер.
`MemoryLayout memoryLayout`	Размещение памяти для входного буфера, задаётся как `MemoryLayout::COLUMN_MAJOR` или как `MemoryLayout::ROW_MAJOR`. Это раскладка по умолчанию `COLUMN_MAJOR`. Этот параметр является необязательным.

Броски

`matlab::OutOfMemoryException`	Не удается выделить массив.
`matlab::data::InvalidArrayTypeException`	Недопустимый тип буфера.
`matlab::data::InvalidMemoryLayoutException`	Недопустимое размещение памяти.
`matlab::data::InvalidDimensionsInRowMajorArrayException`	Размерности недопустимы. Это исключение происходит для массивов, созданных с помощью MATLAB^® R2019a и R2019b, не 2-D ли массив большой строки.
`matlab::data::NumberOfElementsExceedsMaximumException`	Количество элементов больше `size_t`.

Введенный в R2017b

Документация

matlab::data::ArrayFactory

Описание

Информации о классе

Конструкторы

Конструктор по умолчанию

Деструктор

Представители

`createArray`

`createScalar`

`createCellArray`

`createCharArray`

`createStructArray`

`createEnumArray`

`createSparseArray`

`createEmptyArray`

`createBuffer`

`createArrayFromBuffer`

Документация MATLAB

Поддержка