MATLAB - 局部函数

在 MATLAB 中，所有函数都必须在文件中定义。局部函数是定义在与另一个函数（主函数）或脚本相同的代码文件中的函数。这是一个强大的特性，通过将辅助函数保留在与其使用代码相同的文件中来组织代码，从而提高代码的可读性和可维护性。

局部函数仅对同一文件中的其他函数和脚本可见。此原则称为作用域，它有助于防止命名冲突并保持主工作区整洁。

为什么要使用局部函数？

代码组织： 将复杂的算法分解为更小、更易于管理且逻辑上分组的辅助函数，而无需创建许多小的单独 .m 文件。
封装： 将不用于一般用途的辅助函数私有化到需要它们的文件中。这可以防止它们被命令行或其他脚本意外调用。
可读性： 将辅助函数直接放在调用它的代码下方可以使整体逻辑更易于理解。

定义和调用局部函数

要定义局部函数，只需将其 function ... end 块放置在与您的主函数或脚本相同的 .m 文件中，位于主函数代码之后。

函数文件中的语法

% 文件名: mainFunction.m

function output = mainFunction(input1, input2)
    % 这是主函数，在此文件之外可见。
    % 它可以调用局部函数。

    tempResult = localHelper(input1);
    output = tempResult + input2;
end

% --- 局部函数定义在主函数下方 ---

function result = localHelper(input)
    % 这是一个局部函数。它只对 mainFunction 可见。
    % 它不能直接从 MATLAB 命令行窗口调用。
    result = input * 2;
end

示例：统计计算

我们来创建一个函数，计算数据向量的均值和标准差。我们将使用局部函数来计算和以及平方和，展示如何分解任务。将其保存为 computeStats.m。

% 文件: computeStats.m

function [avg, stdev] = computeStats(dataVector)
% COMPUTESTATS 计算向量的均值和标准差。
%   [avg, stdev] = computeStats(dataVector)

    % 主函数中的输入验证
    if ~isvector(dataVector) || ~isnumeric(dataVector)
        error('Input must be a numeric vector.');
    end

    n = length(dataVector);
    if n < 2
        error('Input vector must contain at least two elements.');
    end

    % 调用局部函数执行计算
    total = calculateSum(dataVector);
    avg = total / n;

    sum_sq_diff = calculateSumOfSquares(dataVector, avg);
    stdev = sqrt(sum_sq_diff / (n - 1));
end

% --- 局部辅助函数 ---

function s = calculateSum(vec)
% 计算向量元素和的局部函数。
    s = sum(vec);
end

function ssq = calculateSumOfSquares(vec, mean_val)
% 计算与均值平方差和的局部函数。
    ssq = sum((vec - mean_val).^2);
end

现在您可以从命令行窗口调用主函数，但不能调用局部函数：

myData = [10, 12, 11.5, 13, 9.5];
[myMean, myStd] = computeStats(myData)

myMean =

   11.2000


myStd =

    1.3038

calculateSum(myData)  % 这将产生一个错误！
Undefined function 'calculateSum' for input arguments of type 'double'.

作用域和工作区

理解作用域至关重要：

独立工作区： 每个函数（主函数和局部函数）都有自己的私有工作区。默认情况下，在一个函数中创建的变量在另一个函数中不可见。
数据传递： 数据只能通过输入参数和输出参数在函数之间传递。
父工作区访问： 局部函数可以看到并读取包含它们的主函数工作区中的变量。但是，如果局部函数修改了同名变量，它将创建局部副本。这与嵌套函数不同，后者是一个更高级的主题。

何时使用局部函数

任务分解： 当函数的算法有几个独立、可重用的步骤时。
减少混乱： 避免为仅在一个地方使用的辅助函数创建大量小的 .m 文件。
脚本辅助： 您还可以将局部函数放置在脚本文件的末尾，以支持脚本的主要任务。