MATLAB Compiler SDK 中 mwArray 核心用法与最佳实践

3. 索引与取值

mwArray 的索引是 1-based（和 MATLAB 一样），而不是 C/C++ 的 0-based。这是最容易出错的地方。

mwArray A(3, 4, mxDOUBLE_CLASS);
// ... 填充数据

double val;
// 单个元素（最常用两种写法）
val = A(2, 3); // 第 2 行第 3 列 → A.Get(2, 3)
val = A.Get(1, 2, 3); // 同上，但显式调用

// 多维索引（支持任意维）
mwArray B(2, 3, 4, mxDOUBLE_CLASS);
double v = B(1, 2, 3); // 第 1 页、第 2 行、第 3 列

// 线性索引（少用）
double lin = A.Get(1, 7); // 第 7 个元素（列优先）

// 取整块子数组（返回新的 mwArray）
mwArray sub = A.Get(2, ":, 2:3"); // 不支持字符串下标，需用索引数组

注意：不支持 MATLAB 的 'end' 或逻辑索引，只能用数值索引或创建 mwArray 索引数组。

4. 数据读写（连续内存块）

// 写入
double input[9] = {11, 12, 13, 21, 22, 23, 31, 32, 33};
mwArray mat(3, 3, mxDOUBLE_CLASS);
mat.SetData(input, 9);

// 读出
double output[9];
mat.GetData(output, 9);

// 复数
double re[4] = {1, 2, 3, 4}, im[4] = {5, 6, 7, 8};
mwArray z(2, 2, mxDOUBLE_CLASS, mxCOMPLEX);
z.SetData(re, im, 4); // 或分开 SetRealData / SetImagData

5. 复数数组的初始化与数据读写

复数处理需要特别注意实部与虚部的分离存储：

double rdata[4] = {1.0, 2.0, 3.0, 4.0}; // 实部，列优先存储
double idata[4] = {10.0, 20.0, 30.0, 40.0}; // 虚部，同顺序
mwArray a(2, 2, mxDOUBLE_CLASS, mxCOMPLEX);

// 先创建空复数矩阵
a.Real().SetData(rdata, 4); // 填充实部
a.Imag().SetData(idata, 4); // 填充虚部

• a.Real() 和 a.Imag() 各自返回一个 新的 mwArray（视图），但它们共享底层数据结构。
• 存储顺序：列优先（MATLAB 内存布局），所以上面例子中：
  • a(1,1) = 1 + 10i
  • a(2,1) = 2 + 20i
  • a(1,2) = 3 + 30i
  • a(2,2) = 4 + 40i

读取数据（推荐先检查尺寸）：

if (a.IsComplex() && a.NumberOfElements() == 4) {
    double real_buf[4], imag_buf[4];
    a.Real().GetData(real_buf, 4);
    a.Imag().GetData(imag_buf, 4);
    // 现在 real_buf 和 imag_buf 就是你需要的连续数组
}

注意事项：

• 不要直接对 a.SetData() 用复数数据指针——必须分开实/虚部。
• 如果不填充虚部就调用 MakeComplex()，虚部会被自动设为 0。
• 内存必须是连续的，且长度必须精确匹配 NumberOfElements()。

6. Cell 数组的索引与获取

Cell 数组的处理逻辑与普通数组略有不同：

// 假设 MATLAB 中 a 是 2×3 cell 数组
// a = { [1], [2], [1 2;3 4] ; [1 3;2 4], [1], [2] };

mwArray cell_array = ...; // 从函数返回或构造得到
mwArray b = cell_array(2, 1); // 等价 MATLAB a{2,1} → [1 3;2 4] 的矩阵
mwArray c = cell_array(1, 3); // 等价 a{1,3} → [1 2;3 4]

// 或者线性索引（列优先）
mwArray d = cell_array(5); // 第 5 个元素（列优先展开）→ [1 2;3 4]

关键区别：

• cell_array(i, j) → 等价于 MATLAB 的 内容索引 a{i,j}，返回 被包装的那个 MATLAB 对象（通常是另一个 mwArray）
• 没有像 MATLAB 那样区分 {} 和 () —— mwArray 的 () 运算符在 cell 上直接做内容提取。

常见错误：

• 很多人误以为 cell_array.Get(i,j) 才是内容索引，其实 () 更自然。
• Cell 里的内容类型各异，取出来后要用 ClassID() 判断是 double、char、struct 还是别的。

遍历 Cell 数组示例：

mwArray cells(3, 2, mxCELL_CLASS); // 假设已填充
mwSize total = cells.NumberOfElements();
for (mwSize k = 1; k <= total; ++k) {
    mwArray elem = cells(k); // 线性索引取内容
    if (elem.ClassID() == mxDOUBLE_CLASS) {
        // 处理数值矩阵
    }
}

7. 常用查询方法

mat.ClassID()           → mxDOUBLE_CLASS 等
mat.NumberOfElements()  → 总元素个数
mat.NumberOfDimensions()
mat.GetDimensions()     → 返回 mwArray 包含尺寸向量
mat.IsEmpty()
mat.IsComplex()
mat.IsSparse()
mat.Real() / mat.Imag() → 返回实部/虚部

GetDimensions() 使用示例：

mwArray mat(..., 4, 5, 3, mxDOUBLE_CLASS); // 4×5×3
mwArray dims = mat.GetDimensions(); // dims 是 1×3 的 mwArray: [4,5,3]
mwSize ndim = mat.NumberOfDimensions(); // 3
double d1 = dims(1); // 4.0
double d2 = dims(2); // 5.0

建议： 在 GetData 前总是检查缓冲区大小是否足够：

mwSize len = mat.NumberOfElements();
if (len > your_buffer_size) {
    /* 错误处理 */
}
mat.GetData(buffer, len);

8. 现代建议

• MathWorks 官方已推荐迁移到 MATLAB Data API（C++11 风格，matlab::data::Array），mwArray 是老的 C++03 接口（compiler_sdk 仍支持，但逐渐边缘化）。
  • MATLAB Data API 更现代、支持 move 语义、异常安全更好。
  • 如果是新项目，优先考虑 'MATLAB Data' 接口（compiler.build 时指定 'Interface','matlab-data'）。
• 但：很多老项目、第三方代码仍然大量使用 mwArray，兼容性仍很好，短期内不会消失。
• 编译注意：
  • 必须链接 libmclmcrrt.lib / mclmcrrt.dll
  • 调用前必须 mclInitializeApplication(NULL, 0);
  • 每个线程通常需要 mclInitializeThread()（视情况）

如果你正在写调用 MATLAB 生成的 C++ shared library 的代码，强烈建议先用 mwArray 快速原型，熟悉后再考虑是否切换到更新的 MATLAB Data API。