web-dev-qa-db-ja.com

MATLABで列挙型を作成するにはどうすればよいですか?

MATLABに列挙型はありますか?そうでない場合、選択肢は何ですか?

44
iddober

新しいスタイルのMATLABクラスでいくつかの機能を取得できます。

classdef (Sealed) Colors
    properties (Constant)
        RED = 1;
        GREEN = 2;
        BLUE = 3;
    end

    methods (Access = private)    % private so that you cant instantiate
        function out = Colors
        end
    end
end

これは実際には型ではありませんが、MATLABは緩やかに型付けされているため、整数を使用すると、近似することができます。

line1 = Colors.RED;
...
if Colors.BLUE == line1
end

この場合、MATLABの「enums」はCスタイルの列挙型に近く、整数の代わりに構文を使用します。

静的メソッドを慎重に使用すると、MATLAB列挙型を洗練された方法でAdaに近づけることができますが、残念ながら不器用な構文を使用します。

26
Marc

R2010b以降、MATLABは列挙をサポートしています。

ドキュメント の例:

classdef Colors
   properties
      R = 0;
      G = 0;
      B = 0;
   end

   methods
      function c = Colors(r, g, b)
         c.R = r; c.G = g; c.B = b;
      end
   end

   enumeration
      Red   (1, 0, 0)
      Green (0, 1, 0)
      Blue  (0, 0, 1)
   end
end
41
Jonas

何か類似した何かをしたい場合 Marc は、単に structure まったく新しいクラスの代わりに列挙型を表す:

colors = struct('RED', 1, 'GREEN', 2, 'BLUE', 3);

1つの利点は、2つの異なる方法で構造に簡単にアクセスできることです。フィールド名を使用してフィールドを直接指定できます。

a = colors.RED;

または、文字列にフィールド名がある場合は、 動的フィールド名 を使用できます。

a = colors.('RED');

実際、マークが提案したことを実行し、「enum」オブジェクトを表すまったく新しいクラスを作成することには、いくつかの利点があります。

  • オブジェクトの変更方法を制御できます。
  • 定義を1つの場所に保持し、複数の場所で簡単に使用できます。
  • エラーをスローして、存在しないフィールドにアクセスしようとすると空のマトリックスを返すように(エラーをスローするのではなく)、エラーをより「優雅に」することができます。

ただし、そのような複雑さを必要とせず、ただ何かをすばやく行う必要がある場合は、構造がおそらく最も簡単で最も簡単な実装です。また、最新のOOPフレームワークを使用しない古いバージョンのMATLABでも動作します。

18
gnovice

実際には、MATLAB R2009bには'enumeration'というキーワードがあります。それは文書化されていないようであり、私はそれを使用する方法を知っていると言うことはできませんが、機能はおそらくそこにあります。

matlabroot\toolbox\distcomp\examples\+examplesで見つけることができます

classdef(Enumeration) DmatFileMode < int32

    enumeration
        ReadMode(0)
        ReadCompatibilityMode(1)
        WriteMode(2)
    end
<snip>
end
8
kv.

MatlabコードのJava enumクラスを使用することもできます。Javaで定義し、Matlabのjavaclasspathに配置します。

// Java class definition
package test;
public enum ColorEnum {
    RED, GREEN, BLUE
}

Mコードで名前で参照できます。

mycolor = test.ColorEnum.RED
if mycolor == test.ColorEnum.RED
    disp('got red');
else
    disp('got other color');
end

% Use ordinal() to get a primitive you can use in a switch statement
switch mycolor.ordinal
    case test.ColorEnum.BLUE.ordinal
        disp('blue');
    otherwise
        disp(sprintf('other color: %s', char(mycolor.toString())))
end

ただし、他のタイプとの比較はキャッチしません。また、文字列との比較の戻りサイズは奇数です。

>> test.ColorEnum.RED == 'GREEN'
ans =
     0
>> test.ColorEnum.RED == 'RED'
ans =
     1     1     1
7
Andrew Janke

Javaの古いタイプセーフな列挙型パターン のように動作するMatlabクラスを作成できます。 Marcのソリューション を変更すると、CスタイルのtypedefからJavaスタイルのタイプセーフな列挙型に近づけることができます。このバージョンでは、定数の値はColorオブジェクトと入力されます。

利点:

  • タイプは、==およびその他の操作によって(実行時に)チェックして、生の数値または他のタイプの列挙型と誤って比較されないようにすることができます。
  • 変数のタイプを明示的に確認できます(実行時)。
  • 値は、不透明なコードではなく読みやすい名前で表示されます。
  • Mean()やstd()などの列挙型で意味をなさない操作は許可されません。

欠点:

  • より長いクラス定義。ただし、これはすべて定型であり、クラス名とConstantプロパティだけを変更して、他の列挙クラスに再利用できます。
  • これらの列挙型をswitchブロックで直接使用することはできません。コードをポップアウトする必要があります。これにより、タイプセーフが失われます。
  • オブジェクトはプリミティブよりも遅くなります。ループ内で定数を使用している場合に関連します。

全体として、どちらのアプローチが優れているかはわかりません。実際には使用していません。

classdef (Sealed) Color
%COLOR Example of Java-style typesafe enum for Matlab

properties (Constant)
    RED = Color(1, 'RED');
    GREEN = Color(2, 'GREEN');
    BLUE = Color(3, 'BLUE');
end
properties (SetAccess=private)
    % All these properties are immutable.
    Code;
    Name;
end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
methods (Access = private)
%private so that you can't instatiate directly
    function out = Color(InCode, InName)
        out.Code = InCode;
        out.Name = InName;
    end       
end
methods (Static = true)
    function needa(obj)
    %NEEDA Asserts that obj must be a Color
        if ~isa(obj, mfilename)
            error('Input must be a %s; got a %s', mfilename, class(obj));
        end
    end
end
methods (Access = public)
    function display(obj)
      disp([inputname(1) ' =']);
      disp(obj);
    end
    function disp(obj)
        if isscalar(obj)
            disp(sprintf('%s: %s (%d)', class(obj), obj.Name, obj.Code));
        else
            disp(sprintf('%s array: size %s', class(obj), mat2str(size(obj))));
        end
    end    
    function out = eq(a, b)
        %EQ Basic "type-safe" eq
        check_type_safety(a, b);
        out = [a.Code] == [b.Code];
    end
    function [tf,loc] = ismember(a, b)
        check_type_safety(a, b);
        [tf,loc] = ismember([a.Code], [b.Code]);
    end
    function check_type_safety(varargin)
        %CHECK_TYPE_SAFETY Check that all inputs are of this enum type
        for i = 1:nargin
            if ~isa(varargin{i}, mfilename)
                error('Non-typesafe comparison of %s vs. %s', mfilename, class(varargin{i}));
            end
        end
    end
end
end

これを実行する関数を次に示します。

function do_stuff_with_color(c)
%DO_STUFF_WITH_COLOR Demo use of the Color typesafe enum

Color.needa(c); % Make sure input was a color
if (c == Color.BLUE)
    disp('color was blue');
else
    disp('color was not blue');
end

% To work with switch statements, you have to explicitly pop the code out 
switch c.Code
    case Color.BLUE.Code
        disp('blue');
    otherwise
        disp(sprintf('some other color: %s', c.Name));
end

使用例:

>> Color.RED == Color.RED
ans =
     1
>> Color.RED == 1
??? Error using ==> Color>Color.check_type_safety at 55
Non-typesafe comparison of Color vs. double

Error in ==> Color>Color.eq at 44
        check_type_safety(a, b);

>> do_stuff_with_color(Color.BLUE)
color was blue
blue
>> do_stuff_with_color(Color.GREEN)
color was not blue
some other color: GREEN
>> do_stuff_with_color(1+1) % oops - passing the wrong type, should error
??? Error using ==> Color>Color.needa at 26
Input must be a Color; got a double

Error in ==> do_stuff_with_color at 4
Color.needa(c); % Make sure input was a color

>> 

両方のアプローチの小さな癖:悪い代入を防ぐために「==」の左側に定数を置くというCの規則は、ここではあまり役に立ちません。 Matlabでは、エラーの代わりにLHSでこの定数を誤って "="を使用すると、Colorsという名前の新しいローカルstruct変数を作成し、enumクラスをマスクします。

>> Colors.BLUE = 42
Colors = 
    BLUE: 42
>> Color.BLUE = 42
Color = 
    BLUE: 42
>> Color.RED
??? Reference to non-existent field 'RED'.
5
Andrew Janke

Statistics Toolboxにアクセスできる場合、 categorical object の使用を検討できます。

4
Loren

このページで他の提案を試した後、Andrewの完全にオブジェクト指向のアプローチに行き着きました。とても素敵です-アンドリューに感謝します。

ただし、誰かが興味を持っている場合のために、いくつかの改善(と思う)を行いました。特に、列挙オブジェクトの名前を二重指定する必要がなくなりました。現在、名前はリフレクションとメタクラスシステムを使用して導出されています。さらに、eq()およびismember()関数は書き直され、enumオブジェクトのマトリックスに対して適切な形状の戻り値を返します。最後に、check_type_safety()関数は、パッケージディレクトリ(名前空間など)と互換性を持つように変更されました。

うまくいくようですが、あなたの考えを教えてください:

classdef (Sealed) Color
%COLOR Example of Java-style typesafe enum for Matlab

properties (Constant)
    RED = Color(1);
    GREEN = Color(2);
    BLUE = Color(3);
end
methods (Access = private) % private so that you can''t instatiate directly
    function out = Color(InCode)
        out.Code = InCode;
    end       
end


% ============================================================================
% Everything from here down is completely boilerplate - no need to change anything.
% ============================================================================
properties (SetAccess=private) % All these properties are immutable.
    Code;
end
properties (Dependent, SetAccess=private)
    Name;
end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
methods
    function out = eq(a, b) %EQ Basic "type-safe" eq
        check_type_safety(a, b);
        out = reshape([a.Code],size(a)) == reshape([b.Code],size(b));
    end
    function [tf,loc] = ismember(a, b)
        check_type_safety(a, b);
        [tf,loc] = ismember(reshape([a.Code],size(a)), [b.Code]);
    end
    function check_type_safety(varargin) %CHECK_TYPE_SAFETY Check that all inputs are of this enum type
        theClass = class(varargin{1});
        for ii = 2:nargin
            if ~isa(varargin{ii}, theClass)
                error('Non-typesafe comparison of %s vs. %s', theClass, class(varargin{ii}));
            end
        end
    end

    % Display stuff:
    function display(obj)
        disp([inputname(1) ' =']);
        disp(obj);
    end
    function disp(obj)
        if isscalar(obj)
            fprintf('%s: %s (%d)\n', class(obj), obj.Name, obj.Code);
        else
            fprintf('%s array: size %s\n', class(obj), mat2str(size(obj)));
        end
    end    
    function name=get.Name(obj)
        mc=metaclass(obj);
        mp=mc.Properties;
        for ii=1:length(mp)
            if (mp{ii}.Constant && isequal(obj.(mp{ii}.Name).Code,obj.Code))
                name = mp{ii}.Name;
                return;
            end;
        end;
        error('Unable to find a %s value of %d',class(obj),obj.Code);
    end;
end
end

ありがとう、メイソン

3
Mason Freed
Toys = {'Buzz', 'Woody', 'Rex', 'Hamm'};

Toys{3}
  ans = 'Rex'
2
Felix Bors

C#または.NETアセンブリに渡すためだけに列挙型が必要な場合は、MATLAB 2010で列挙型を作成して渡すことができます。

A = NET.addAssembly(MyName.dll)
% suppose you have enum called "MyAlerts" in your Assembly
myvar = MyName.MyAlerts.('value_1');

mathWorksの公式の回答も確認できます。

MATLAB 7.8(R2009a)で.NET列挙値を使用するにはどうすればよいですか?

// the enum "MyAlerts" in c# will look something like this
public enum MyAlerts
{
    value_1 = 0,
    value_2 = 1,
    MyAlerts_Count = 2,
}
1
shahar_m