MATLAB Data API for .NET 相对于 MWArray API 的优势

MathWorks^® 建议使用更现代的 MATLAB Data API for .NET 而不是 MWArray API 来部署到 .NET 应用程序。与 MWArray API 相比，使用 .NET 的 MATLAB Data API 的优势在于：

生成工件的差异

当您将 MATLAB 函数或类输入到 compiler.build.dotNETAssembly 功能或 .NET 程序集编译器时，两种部署选项生成的主要产品不同。

假设您有一个名为 calculateDistance 的 MATLAB 函数存储在名为 calculateDistance.m 文件中，并且您打算将其部署到 .NET 应用程序中，让我们检查一下两种部署方案的结果：

function distance = calculateDistance(p1, p2)
    % This function calculates the Euclidean distance between two points
    % Inputs:
    %   p1 - a two-element vector [x, y]
    %   p2 - a two-element vector [x, y]
    % Output:
    %   distance - the Euclidean distance between p1 and p2
    
    % Use arguments block to map C# type to corresponding MATLAB type
    % Int64 [] <--> (1,2) int64 {mustBeReal}
    
    arguments (Input)
        p1 (1,2) int64 {mustBeReal}
        p2 (1,2) int64 {mustBeReal}
    end

    arguments (Output)
        distance (1,1) int64 {mustBeReal}
    end
    
    % Calculate Euclidean distance
    diff = p1 - p2;
    diffSq = diff.^2;
    sumSq = sum(diffSq);
    distance = sqrt(sumSq);
end

当您将 calculateDistance.m 文件输入到 compiler.build.dotNETAssembly 函数时，MWArray API 是默认选择。要使用 MATLAB Data API，您需要使用名称-值对 Interface="matlab-data" 明确指定接口类型。

buildResults = compiler.build.dotNETAssembly( ...
    "calculateDistance.m",...
    Verbose="on", OutputDir=".\output_mwa", ...
    AssemblyName="CalculateDistance")

buildResults = compiler.build.dotNETAssembly( ...
    "calculateDistance.m", Interface="matlab-data",...
    Verbose="on", OutputDir=".\output_mda", ...
    AssemblyName="CalculateDistance")

该函数在指定文件夹中为两个 API 生成相应的文件：

P:\MATLAB\WORK\OUTPUT_MWA
    CalculateDistance.dll
    CalculateDistance.xml
    calculateDistanceClass.cs
    calculateDistanceClassNative.cs
    CalculateDistanceNative.dll
    CalculateDistanceNative.xml
    CalculateDistanceVersion.cs
    CalculateDistance_overview.html
    GettingStarted.html
    includedSupportPackages.txt
    mccExcludedFiles.log
    readme.txt
    requiredMCRProducts.txt
    unresolvedSymbols.txt

No subfolders exist

P:\MATLAB\WORK\OUTPUT_MDA
│   CalculateDistance.csproj
│   CalculateDistance.ctf
│   CalculateDistance.deps.json
│   CalculateDistance.dll
│   GettingStarted.html
│   includedSupportPackages.txt
│   mccExcludedFiles.log
│   readme.txt
│   requiredMCRProducts.txt
│   unresolvedSymbols.txt
│
└───strongly_typed_interface
        calculateDistance.cs

在 MWArray API 案例中，生成了两组工件。第一组由一个 C# 包装器文件和一个相应的汇编文件组成，两者都使用 MWArray 类作为参量和返回值。此配置反映了内在的 MATLAB 数据结构。

同时，compiler.build.dotNETAssembly 生成第二组相应的工件，这些工件使用本机 .NET System.Object 类型作为方法参数和返回。此变体提供了 MATLAB 函数的更加以 .NET 为中心的视角，用标准 .NETMWArray 实例替换 Object。

在 MATLAB Data API 案例中，compiler.build.dotNETAssembly 函数生成三个基本组件。首先，它创建一个代码存档（.ctf 文件），其中封装了要部署的 MATLAB 函数。其次，它制作相应的 C# 包装器文件，建立 MATLAB 和 C# 输入和输出数据类型之间的映射，并允许 MATLAB 函数被调用为 .NET 方法。最后，它生成一个可代替 C# 包装器文件的 .NET 程序集。

使用 MATLAB Data API 支持强类型

当您使用 MATLAB Data API 时，您可以选项指定 MATLAB 和 C# 数据类型之间的映射。

部署 MATLAB 函数时，需要一个 arguments 模块来指定输入和输出参量的类型信息。如果部署 MATLAB 类，请使用 properties 模块详细说明类属性的类型信息，并使用 arguments 模块为类方法的参量提供类型信息。

% .m file
arguments (Input)
        p1 (1,2) int64 {mustBeReal}
        p2 (1,2) int64 {mustBeReal}
    end
arguments (Output)
        distance (1,2) int64 {mustBeReal}
    end

// .cs wrapper file
   
    public static void calculateDistance(
        MATLABProvider _matlab, 
        Int64 [] p1, Int64 [] p2,  
        out Int64 distance){

// .cs application file
  
Int64[] p1 = new Int64[2] { 0, 0 };
Int64[] p2 = new Int64[2] { 3, 4 };
...

Int64 distance;