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`

Параметры

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

Броски

`matlab::OutOfMemoryException`	Не мог выделить массив.
`matlab::data::NumberOfElementsExceedsMaximumException`	Число элементов больше `size_t`.

`createScalar`

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

TypedArray<String> createScalar(const String val)

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

Описание

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

Параметры

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

Броски

`matlab::OutOfMemoryException`	Не мог выделить массив.
`matlab::data::NonAsciiCharInInputDataException`	Входом является `std::string` и содержит символы non-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

Шаблон Variadic:

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

Параметры

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

Броски

`matlab::OutOfMemoryException`	Не мог выделить массив.
`matlab::data::NonAsciiCharInInputDataException`	Входом является `std::string` и содержит символы non-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)

Описание

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

Параметры

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

Броски

`matlab::OutOfMemoryException`	Не мог выделить массив.
`matlab::data::NonAsciiCharInInputDataException`	Входом является `std::string` и содержит символы non-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- cols размерности. У вас может только быть две размерности для разреженных массивов. Метод не копирует буфер, и массив берет владение памяти.

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

`T`	Элемент вводит в виде `doublebool`, или `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`	Буфер, содержащий данные. Буфер не копируется. `TypedArray<T>` возразите берет владение буфера.
`MemoryLayout memoryLayout`	Размещение памяти для входного буфера в виде `MemoryLayout::COLUMN_MAJOR` или как `MemoryLayout::ROW_MAJOR`. Раскладкой по умолчанию является `COLUMN_MAJOR`. Этот параметр является дополнительным.

Броски

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

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

matlab::data::ArrayFactory

Описание

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

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

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

Броски

Деструктор

Функции членства

createArray

Описание

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

Параметры

Броски

createScalar

Описание

Параметры

Броски

Примеры

Похожие темы

createCellArray

Описание

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

Параметры

Броски

Примеры

createCharArray

Описание

Параметры

Броски

Примеры

createStructArray

Описание

Параметры

Броски

Примеры

createEnumArray

Описание

Параметры

Броски

Примеры

createSparseArray

Описание

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

Параметры

Броски

Примеры

createEmptyArray

Описания

Возвращается

Броски

createBuffer

Описание

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

Параметры

Возвращается

Броски

createArrayFromBuffer

Описание

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

Параметры

Броски

Введенный в R2017b

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

Поддержка

`createArray`

`createScalar`

`createCellArray`

`createCharArray`

`createStructArray`

`createEnumArray`

`createSparseArray`

`createEmptyArray`

`createBuffer`

`createArrayFromBuffer`