Skip to main content

Sasa.Enums - Typed Enum API

I recently realized that I had missed one important class in the core Sasa.dll assembly, so my blog series isn't technically complete. So here's my twenty-fourth post in the series:

Sasa.Enums

Sasa.Enums provides a statically typed API for working with enums, analogous to the dynamically typed System.Enum. Every method call in System.Enum that accepts a System.Type representing the enum type, here accepts a type parameter that is constrained to be of type enum.

Sasa.Enums.HasFlag

The Sasa.Enums.HasFlag extension method checks for the presence of flag bits set in an enum that has the FlagsAttribute applied:

[Flags]
enum Foo
{
  Bar = 1,
  Other = 2,
}
var value = Foo.Bar | Foo.Other;
Console.WriteLine(value.HasFlag(Foo.Bar))
Console.WriteLine(Foo.Other.HasFlag(Foo.Bar))
// output:
// true
// false

Sasa.Enums.IsDefined

The Sasa.Enums.IsDefined extension method checks whether the given enum value is valid:

enum Foo
{
  Bar,
}
var defined = Foo.Bar;
Console.WriteLine(defined.IsDefined());

var undefined = (Foo)10;
Console.WriteLine(undefined.IsDefined());

// output:
// true
// false

Sasa.Enums.Names

The Sasa.Enums.Names static method provides a enumerable sequence of strings corresponding to the enum's descriptive names. Essentially, this is the equivalent of System.Enum.GetNames, except it's statically typed with an enum constraint, and it returns a cached immutable sequence so it avoids the overhead of allocating an array for every call:

enum Foo
{
  Bar,
  Other,
}
foreach (var x in Enums.Names<Foo>())
{
  Console.WriteLine(x);
}
// output:
// Bar
// Other

Sasa.Enums.ToEnum

The Sasa.Enums.ToEnum set of extension methods provides simple enum parsing:

enum Foo
{
  Bar,
  Other,
}
Foo bar = "Bar".ToEnum<Foo>();
if (bar == Foo.Bar)
  Console.WriteLine(bar);
// output:
// Bar

An exception is thrown if the provided string is not a valid enum name.

Sasa.Enums.TryParse

The Sasa.Enums.TryParse set of extension methods implements non exception-throwing pattern of parsing enums:

enum Foo
{
  Bar,
  Other,
}
Foo bar;
if ("Bar".TryParse<Foo>(out bar);)
  Console.WriteLine(bar);
// output:
// Bar

Sasa.Enums.Values

The Sasa.Enums.Values method provides all the underlying values of the given enum type. Like the Enums.Names method, it returns a cached immutable sequence so it avoids the overhead of allocating arrays for every call:

enum Foo
{
  Bar,
  Other,
}
foreach (var x in Enums.Values<Foo>())
{
  Console.WriteLine(x);
}
// output:
// Bar
// Other

Comments

Popular posts from this blog

async.h - asynchronous, stackless subroutines in C

The async/await idiom is becoming increasingly popular. The first widely used language to include it was C#, and it has now spread into JavaScript and Rust. Now C/C++ programmers don't have to feel left out, because async.h is a header-only library that brings async/await to C! Features: It's 100% portable C. It requires very little state (2 bytes). It's not dependent on an OS. It's a bit simpler to understand than protothreads because the async state is caller-saved rather than callee-saved. #include "async.h" struct async pt; struct timer timer; async example(struct async *pt) { async_begin(pt); while(1) { if(initiate_io()) { timer_start(&timer); await(io_completed() || timer_expired(&timer)); read_data(); } } async_end; } This library is basically a modified version of the idioms found in the Protothreads library by Adam Dunkels, so it's not truly ground bre

Building a Query DSL in C#

I recently built a REST API prototype where one of the endpoints accepted a string representing a filter to apply to a set of results. For instance, for entities with named properties "Foo" and "Bar", a string like "(Foo = 'some string') or (Bar > 99)" would filter out the results where either Bar is less than or equal to 99, or Foo is not "some string". This would translate pretty straightforwardly into a SQL query, but as a masochist I was set on using Google Datastore as the backend, which unfortunately has a limited filtering API : It does not support disjunctions, ie. "OR" clauses. It does not support filtering using inequalities on more than one property. It does not support a not-equal operation. So in this post, I will describe the design which achieves the following goals: A backend-agnostic querying API supporting arbitrary clauses, conjunctions ("AND"), and disjunctions ("OR"). Implemen

Easy Automatic Differentiation in C#

I've recently been researching optimization and automatic differentiation (AD) , and decided to take a crack at distilling its essence in C#. Note that automatic differentiation (AD) is different than numerical differentiation . Math.NET already provides excellent support for numerical differentiation . C# doesn't seem to have many options for automatic differentiation, consisting mainly of an F# library with an interop layer, or paid libraries . Neither of these are suitable for learning how AD works. So here's a simple C# implementation of AD that relies on only two things: C#'s operator overloading, and arrays to represent the derivatives, which I think makes it pretty easy to understand. It's not particularly efficient, but it's simple! See the "Optimizations" section at the end if you want a very efficient specialization of this technique. What is Automatic Differentiation? Simply put, automatic differentiation is a technique for calcu