MATLAB - 运算符重载

MATLAB - 运算符重载

运算符重载（Operator overloading）允许您为自己的自定义类对象定义标准 MATLAB 运算符（如 +、-、* 和 ==）的行为。这一强大功能让您能够创建直观且可读性强的代码，使您的自定义对象能够像数字和矩阵等内置类型一样自然地进行交互。

为何重载运算符？

假设您有一个表示复数或多项式的类。如果没有运算符重载，添加两个这样的对象将需要冗长的方法调用，例如 p3 = p1.add(p2)。通过重载 + 运算符，您可以简单地写成 p3 = p1 + p2;，这样更简洁，也更符合数学直觉。

• 直观的语法：直接对您的对象执行算术运算（v1 + v2）、关系运算（obj1 == obj2）和逻辑运算。
• 无缝集成：允许您的自定义对象与期望这些运算符工作的标准 MATLAB 函数和语法一起使用。
• 代码可读性：通过镜像标准数学和逻辑符号，使您的代码更清晰，更易于理解。

如何定义重载运算符

要重载一个运算符，您需要在 classdef 文件中实现一个特定的方法。MATLAB 将每个运算符映射到相应的方法名。当一个运算符与您的类对象一起使用时，MATLAB 会调用关联的方法。

以下是一些常用运算符及其对应的方法名：

运算符	方法名	描述
+	plus	二元加法（例如，a + b）
-	minus	二元减法（例如，a - b）
*	mtimes	矩阵乘法（例如，a * b）
.*	times	元素级乘法（例如，a .* b）
==	eq	相等比较（例如，a == b）
<	lt	小于比较（例如，a < b）
-a	uminus	一元减法（例如，-a）

运算符优先级

MATLAB 根据固定的运算符优先级顺序评估表达式。例如，乘法 (*) 在加法 (+) 之前执行。您可以使用括号 () 来显式控制评估顺序并提高代码清晰度。最佳实践是，当表达式的评估顺序可能不明确时，始终使用括号。

% Default precedence: exponentiation (^) before division (/)
% 默认优先级：指数 (^) 在除法 (/) 之前
A = [3 9 5];
B = [2 1 5];
C1 = A ./ B.^2
% C1 = [0.7500    9.0000    0.2000]

% Using parentheses to override precedence: division before exponentiation
% 使用括号覆盖优先级：除法在指数之前
C2 = (A ./ B).^2
% C2 = [2.2500   81.0000    1.0000]

示例：一个 Vector2D 类

让我们创建一个表示二维向量的 Vector2D 类，并重载多个运算符，使向量算术运算变得简单自然。

classdef Vector2D
    properties
        X {mustBeNumeric, mustBeFinite} = 0
        Y {mustBeNumeric, mustBeFinite} = 0
    end

    methods
        function obj = Vector2D(x, y)
            % Constructor
            % 构造函数
            if nargin == 2
                obj.X = x;
                obj.Y = y;
            end
        end

        % Overload the plus operator (+)
        % 重载加法运算符 (+)
        function result = plus(v1, v2)
            % Ensure both operands are Vector2D objects
            % 确保两个操作数都是 Vector2D 对象
            if ~isa(v1, 'Vector2D') || ~isa(v2, 'Vector2D')
                error('Both operands must be Vector2D objects for addition.');
                % 错误：加法运算的两个操作数都必须是 Vector2D 对象。
            end
            result = Vector2D(v1.X + v2.X, v1.Y + v2.Y);
        end

        % Overload the minus operator (-)
        % 重载减法运算符 (-)
        function result = minus(v1, v2)
            result = Vector2D(v1.X - v2.X, v1.Y - v2.Y);
        end

        % Overload the mtimes operator (*) for scalar multiplication
        % 重载 mtimes 运算符 (*) 用于标量乘法
        function result = mtimes(v, scalar)
            if isa(v, 'Vector2D') && isscalar(scalar)
                result = Vector2D(v.X * scalar, v.Y * scalar);
            elseif isscalar(v) && isa(scalar, 'Vector2D')
                % Handle the case `scalar * vector`
                % 处理 `标量 * 向量` 的情况
                result = Vector2D(scalar.X * v, scalar.Y * v);
            else
                error('Unsupported multiplication. Use a Vector2D and a scalar.');
                % 错误：不支持的乘法运算。请使用 Vector2D 对象和标量。
            end
        end

        % Overload the equality operator (==)
        % 重载相等运算符 (==)
        function areEqual = eq(v1, v2)
            areEqual = (v1.X == v2.X) && (v1.Y == v2.Y);
        end

        % Custom display method for clarity
        % 自定义显示方法以提高清晰度
        function disp(obj)
            fprintf('  Vector2D | X: %.2f, Y: %.2f\n', obj.X, obj.Y);
        end
    end
end

将上述代码保存为 Vector2D.m。现在，您可以在脚本中使用这些直观的操作：

% Create two Vector2D objects
% 创建两个 Vector2D 对象
v1 = Vector2D(3, 4);
v2 = Vector2D(1, 2);

disp('Vector v1:'); disp(v1);
disp('Vector v2:'); disp(v2);

% --- Test the overloaded operators ---
% --- 测试重载运算符 ---

% Test addition (+)
% 测试加法 (+)
v_sum = v1 + v2;
disp('v1 + v2 ='); disp(v_sum);

% Test subtraction (-)
% 测试减法 (-)
v_diff = v1 - v2;
disp('v1 - v2 ='); disp(v_diff);

% Test scalar multiplication (*)
% 测试标量乘法 (*)
v_scaled = v1 * 3;
disp('v1 * 3 ='); disp(v_scaled);

% Test equality (==)
% 测试相等性 (==)
is_equal = (v1 == Vector2D(3, 4));
disp(['Are v1 and Vector2D(3, 4) equal? ', mat2str(is_equal)]);

is_notequal = (v1 == v2);
disp(['Are v1 and v2 equal? ', mat2str(is_notequal)]);

最佳实践与测试

重载运算符时，确保它们的行为符合预期至关重要。一个好的实践是创建一个独立的测试脚本来验证逻辑。

• 处理不同操作数类型：您的方法应优雅地处理操作数可能属于不同类型的情况（例如，您的对象和标量 double），如 mtimes 示例所示。
• 验证输入：使用 isa 等函数检查对象类型，并使用 isscalar、isnumeric 等函数验证输入并提供有意义的错误信息。
• 编写测试：创建断言预期结果的脚本。例如，assert(isequal(v1 + v2, Vector2D(4, 6))) 可以自动验证您的加法逻辑。随着您的类变得越来越复杂，这一点将变得非常宝贵。