Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Random value from Flags enum

Say I have a function that accepts an enum decorated with the Flags attribute. If the value of the enum is a combination of more than one of the enum elements how can I extract one of those elements at random? I have the following but it seems there must be a better way.

[Flags]
enum Colours
{
    Blue = 1,
    Red = 2,
    Green = 4
}

public static void Main()
{
    var options = Colours.Blue | Colours.Red | Colours.Green;
    var opts = options.ToString().Split(',');
    var rand = new Random();
    var selected = opts[rand.Next(opts.Length)].Trim();
    var myEnum = Enum.Parse(typeof(Colours), selected);
    Console.WriteLine(myEnum);
    Console.ReadLine();
}
like image 689
Chris Porter Avatar asked Jun 08 '10 21:06

Chris Porter


4 Answers

You can call Enum.GetValues to get an array of the enum's defined values, like this:

var rand = new Random();

Colors[] allValues = (Colors[])Enum.GetValues(typeof(Colors));
Colors value = allValues[rand.Next(allValues.Length)];
like image 196
SLaks Avatar answered Oct 06 '22 00:10

SLaks


var options = Colours.Blue | Colours.Green;

var matching = Enum.GetValues(typeof(Colours))
                   .Cast<Colours>()
                   .Where(c => (options & c) == c)    // or use HasFlag in .NET4
                   .ToArray();

var myEnum = matching[new Random().Next(matching.Length)];
like image 38
LukeH Avatar answered Oct 06 '22 00:10

LukeH


If you don't mind a little casting, and your enum is of underlying int type, the following will work and is fast.

var rand = new Random();
const int mask = (int)(Colours.Blue | Colours.Red | Colours.Green);
return (Colours)(mask & (rand.Next(mask) + 1));

If you only want a single flag to be set, you could do the following:

var rand = new Random();
return (Colours)(0x1 << (rand.Next(3)));
like image 20
bbudge Avatar answered Oct 06 '22 00:10

bbudge


If I understand correctly, the question is about returning a random enum value from a flags enum value, not returning a random member from a flags enum.

    [Flags]
    private enum Shot
    {
        Whisky = 1,
        Absynthe = 2,
        Pochin = 4,
        BrainEraser = Whisky | Absynthe | Pochin
    }

    [Test]
    public void Test()
    {
        Shot myCocktail = Shot.Absynthe | Shot.Whisky;

        Shot randomShotInCocktail = GetRandomShotFromCocktail(myCocktail);
    }

    private static Shot GetRandomShotFromCocktail(Shot cocktail)
    {
        Random random = new Random();

        Shot[] cocktailShots = Enum.GetValues(typeof(Shot)).
           Cast<Shot>().
           Where(x => cocktail.HasFlag(x)).ToArray();

        Shot randomShot = cocktailShots[random.Next(0, cocktailShots.Length)];

        return randomShot;
    }

Edit

And obviously you should check that the enum is a valid value, e.g.:

 Shot myCocktail = (Shot)666;

Edit

Simplified

like image 28
Tim Lloyd Avatar answered Oct 06 '22 01:10

Tim Lloyd