入力引数の検証

入力引数の検証では、メソッドの入力引数のサイズ、クラス、およびその他の特性を制限できます。入力引数の検証の構文は以下のとおりです。

arguments
   argName1 (dimensions) class {validators} = defaultValue
   ...
end

入力引数の検証構文の要素の詳細な説明は、arguments を参照してください。

入力引数の検証は、パブリック アクセスを使用するメソッドで役立ちます。メソッドの呼び出し元から許可される引数値の型を制限すると、メソッドの本体が実行される前にエラーを防ぐことができます。たとえば、Rectangle クラスは座標面の四角形を表し、その位置 (X と Y) およびその幅と高さを指定するプロパティをもちます。

classdef Rectangle
    properties
        X (1,1) double {mustBeReal} = 0
        Y (1,1) double {mustBeReal} = 0
        Width (1,1) double {mustBeReal} = 0
        Height (1,1) double {mustBeReal} = 0
    end
    
    methods
        function R = enlarge(R,x,y)
            arguments (Input)
                R (1,1) Rectangle
                x (1,1) {mustBeNonnegative}
                y (1,1) {mustBeNonnegative}
            end
            arguments (Output)
                R (1,1) Rectangle
            end
            R.Width = R.Width + x;
            R.Height = R.Height + y;
        end
    end
end

enlarge メソッドは、ユーザー入力 x と y をそれぞれ Width と Height に追加することで、四角形の高さと幅を増やします。メソッドの目的は 1 つの四角形を拡大することなので、検証では入力引数を、(1,1) のサイズ制限を持つスカラー値と、mustBeNonnegative を使用する非負の数値に制限します。

クラスをインスタンス化し、enlarge に対する入力を 5 および -1 に指定して enlarge を呼び出します。引数の検証では、エラーが返されます。

rect1 = Rectangle;
rect1.enlarge(5,-1))

Error using Rectangle/enlarge
 rect1.enlarge(5,-1)
                 ↑
Invalid argument at position 2. Value must be nonnegative.

出力引数の検証

出力引数の検証の構文は入力検証と同じですが、arguments ブロックの属性として (Output) を指定しなければなりません。また、既定値は設定できません。

arguments (Output)
   argName1 (dimensions) class {validators}
   ...
end

出力引数の検証構文の詳細な説明は、arguments を参照してください。

出力引数の検証では、クラスの作成者は、メソッドが返す出力の型を記録できるのに加え、出力型が変更され得る将来のコード変更に対してフェールセーフを実現できます。たとえば、Rectangle の enlarge メソッドは、オブジェクト メソッドが Rectangle のスカラー インスタンスを返しているかを確認するために、出力引数の検証を使用します。

arguments (Output)
   R (1,1) Rectangle
end

たとえば、enlarge が、オブジェクトそのものではなく Rectangle の次元のみ返すように後で修正された場合、出力の検証は、この潜在的な誤りを見つけるのに役立ちます。