{"id":797,"date":"2019-11-27T15:43:41","date_gmt":"2019-11-27T06:43:41","guid":{"rendered":"http:\/\/blogs.mathworks.com\/japan-community\/?p=797"},"modified":"2020-10-05T16:16:35","modified_gmt":"2020-10-05T07:16:35","slug":"function-arguments-part2","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/japan-community\/2019\/11\/27\/function-arguments-part2\/","title":{"rendered":"\u5165\u529b\u5f15\u6570\u306e\u691c\u8a3c\uff5e\u96a0\u3055\u308c\u305f\u4fbf\u5229\u6a5f\u80fd"},"content":{"rendered":"
\n

こんにちは、道家です。<\/p>\n

前回<\/a> に続き、 Function Argument Validation<\/a> について書きたいと思います。<\/p>\n

ご存知の方もいるかと思いますが、コマンドウィンドウ、もしくはエディターの中でプログラムを 書いている時、入力パラメーターの 候補を表示したり補完したりする機能<\/a> があります。<\/p>\n

\n<\/img>\n<\/p>\n

実はこの機能というのは MathWorks 製品の関数にしかない機能ではなく、皆さんが作成された 関数にも使えます。それには functionSignatures.json<\/a> というファイルを作成する必要があります。例を見てみましょう。<\/p>\n

まず、以下のような関数を作ったとしましょう。<\/p>\n

% myFunc  サンプル関数<\/span>\r\n% この関数には以下のような呼び出し構文があります。<\/span>\r\n%<\/span>\r\n%   myFunc(in1, in2) 2つの入力が必須です<\/span>\r\n%   myFunc(in1, in2, in3) オプションで3つ目の入力があります<\/span>\r\n%   myFunc(___, NAME, VALUE) さらにオプションで Name-Value ペアを受け付けます<\/span>\r\n%           * 'NAME1' : 論理値（logical）<\/span>\r\n%           * 'NAME2' : 'Default', 'Choice1', または 'Choice2'<\/span>\r\nfunction<\/span> [reqA,reqB,posA,NV1,NV2] = myFunc(reqA,reqB,varargin)\r\n    % 既定値で初期化<\/span>\r\n    NV1 = true;\r\n    NV2 = \"Default\"<\/span>;\r\n    posA = [];\r\n    if<\/span> nargin > 3\r\n        if<\/span> rem(nargin,2)\r\n            posA = varargin{1};\r\n            V = varargin(2:end);\r\n        else<\/span>\r\n            V = varargin;\r\n        end<\/span>\r\n        for<\/span> n = 1:2:size(V,2)\r\n            switch<\/span> V{n}\r\n                case<\/span> 'Name1'<\/span>\r\n                    NV1 = V{n+1};\r\n                case<\/span> 'Name2'<\/span>\r\n                    NV2 = V{n+1};\r\n                otherwise<\/span>\r\n                    error('エラー'<\/span>)\r\n            end<\/span>\r\n        end<\/span>\r\n    end<\/span>\r\nend<\/span>\r\n<\/pre>\n
この関数に対して候補と補完機能を追加するには、この関数が存在するフォルダーに この関数の呼び出し構文を記述する functionSignatures.json<\/tt> を作成します。<\/p>\n
{\r\n  \"_schemaVersion\"<\/span>: \"1.0.0\"<\/span>,\r\n  \"myFunc\"<\/span>:\r\n  {\r\n     \"inputs\"<\/span>:\r\n     [\r\n        {\"name\"<\/span>:\"in1\"<\/span>, \"kind\"<\/span>:\"required\"<\/span>, \"type\"<\/span>:[\"numeric\"<\/span>], \"purpose\"<\/span>:\"ID of item\"<\/span>},\r\n        {\"name\"<\/span>:\"in2\"<\/span>, \"kind\"<\/span>:\"required\"<\/span>, \"type\"<\/span>:[\"numeric\"<\/span>], \"purpose\"<\/span>:\"# Items\"<\/span>},\r\n        {\"name\"<\/span>:\"in3\"<\/span>, \"kind\"<\/span>:\"ordered\"<\/span>, \"type\"<\/span>:[\"numeric\"<\/span>], \"purpose\"<\/span>:\"Input Value\"<\/span>},\r\n        {\"name\"<\/span>:\"Name1\"<\/span>, \"kind\"<\/span>:\"namevalue\"<\/span>, \"type\"<\/span>:[\"logical\"<\/span>,\"scalar\"<\/span>],\"purpose\"<\/span>:\"Option\"<\/span>},\r\n        {\"name\"<\/span>:\"Name2\"<\/span>, \"kind\"<\/span>:\"namevalue\"<\/span>, \"type\"<\/span>:[\"char\"<\/span>, \"choices={'Default','Choice1','Choice2'}\"<\/span>]}\r\n     ]\r\n  }\r\n}\r\n<\/pre>\n
すると myFunc<\/tt> を記述する際に以下のような候補が表示されるようになります。<\/p>\n
\n<\/img>\n<\/p>\n
R2019b の Function Argument Validation を活用すると、なんとこの機能がついてくるのです。 まったく同じ用途の myFunc2<\/tt> を Function Argument Validation を使って書くと<\/p>\n
function<\/span> [reqA,reqB,posA,NV1,NV2] = myFunc2(reqA,reqB,posA,opts)
\r\narguments<\/span>\r\n    reqA (1,1) double<\/span>\r\n    reqB (1,1) double<\/span>\r\n    posA double<\/span> = []\r\n    opts.Name1 (1,1) logical<\/span> = true\r\n    opts.Name2 char {mustBeMember(opts.Name2,[\"Default\",\"Choice1\",\"Choice2\"])}<\/span> = \"Default\"<\/span>\r\nend<\/span>\r\nNV1 = opts.Name1;\r\nNV2 = opts.Name2;
\r\nend<\/span> <\/pre>\n<\/p>\n
すると functionSignatures.json<\/tt> ファイルを作成する必要なく候補と補完機能が 備えついてきます。<\/p>\n
\n<\/img>\n<\/p>\n
改めて Function Argument Validation 機能についてまとめてみますと<\/p>\n
\n