Skip to main content

Sasa.Weak<T> - Typed Weak References

This is the ninth post in my ongoing series covering the abstractions in Sasa. Previous posts:

System.WeakReference is a special runtime class used for collection and finalization of resources that have no other live references. The only problem is that the encapsulated value is of type "object", and so using it requires a lot more casting than it should. More often than not, a WeakReference will only encapsulate a value of one type, so this casting is often superfluous.

Enter Sasa.Weak<T>, which is a struct that wraps WeakReference and provides a typed interface to encapsulated values. As a struct, it does not incur any additional memory allocation costs, and the casting it performs are operations you would likely have to do anyway, so the overhead of the typed interface is virtually nil. Sasa.Weak<T> is available in the core Sasa.dll assembly.

Sasa.Weak<T>.HasValue

Sasa.Weak<T>.HasValue has the same purpose as Weak<T>.IsAlive, but fulfills the requirements to satisfy the IResolvable<T> interface:

string original = new string("hello world!".ToCharArray());
Weak<string> foo = original;
Console.WriteLine(foo.HasValue);

// lose all live references and run collection
original = null;
GC.Collect();
GC.WaitForPendingFinalizers();
Console.WriteLine(foo.HasValue);

// outputs:
// true
// false

Sasa.Weak<T>.IsAlive

Sasa.Weak<T>.IsAlive checks whether the target of the weak reference has yet to be collected:

string original = new string("hello world!".ToCharArray());
Weak<string> foo = original;
Console.WriteLine(foo.IsAlive);

// lose all live references and run collection
original = null;
GC.Collect();
GC.WaitForPendingFinalizers();
Console.WriteLine(foo.IsAlive);

// outputs:
// true
// false

Sasa.Weak<T>.Value

Sasa.Weak<T>.Value obtains the current value encapsulated in the weak reference, or null if the object has been collected:

string original = new string("hello world!".ToCharArray());
Weak<string> foo = original;
Console.WriteLine(foo.Value);

// lose all live references and run collection
original = null;
GC.Collect();
GC.WaitForPendingFinalizers();
Console.WriteLine(foo.Value ?? "<null>");

// outputs:
// hello world!
// <null>

The Value property also fulfills the requirements for the IValue<T> interface.

Sasa.Weak<T>.TryGetValue

Sasa.Weak<T>.TryGetValue checks whether a weak reference to a target is alive, and returns a live reference to that target in one step:

string original = new string("hello world!".ToCharArray());
Weak<string> foo = original;
Console.WriteLine(foo.TryGetValue(out original));
Console.WriteLine(original);

// lose all live references and run collection
original = null;
GC.Collect();
GC.WaitForPendingFinalizers();
Console.WriteLine(foo.TryGetValue(out original));
Console.WriteLine(original ?? "<null>");

// outputs:
// true
// hello world!
// false
// <null>

This method also satisfies the requirements for the IVolatile<T> interface.

Comments

Rodrigo Kumpera said…
Since version 4.5m there's a WeakReference variant that offers the same interface.
Sandro Magi said…
Good to hear. Sasa is written for .NET 3.5, and I've had Weak for over 5 years now.

Popular posts from this blog

Blue-eyed Islander Puzzle - an analysis

Many people find themselves stumped by the so-called Blue-Eyed Islanders puzzle . There is also much controversy over its supposed solution. I'm going to analyze the problem and the solution, and in the process, explain why the solution works. To begin, let's modify the problem slightly and say that there's only 1 blue-eyed islander. When the foreigner makes his pronouncement, the blue-eyed islander looks around and sees no other blue eyes, and being logical, correctly deduces that his own eyes must be blue in order for the foreigner's statement to make sense. The lone blue-eyed islander thus commits suicide the following day at noon. Now comes the tricky part, and the source of much confusion. Let's say there are 2 blue-eyed islanders, Mort and Bob. When the foreigner makes his pronouncement, Mort and Bob look around and see only each other. Mort and Bob thus both temporarily assume that the other will commit suicide the following day at noon. Imagine their chagrin...

Easy Reverse Mode Automatic Differentiation in C#

Continuing from my last post on implementing forward-mode automatic differentiation (AD) using C# operator overloading , this is just a quick follow-up showing how easy reverse mode is to achieve, and why it's important. Why Reverse Mode Automatic Differentiation? As explained in the last post, the vector representation of forward-mode AD can compute the derivatives of all parameter simultaneously, but it does so with considerable space cost: each operation creates a vector computing the derivative of each parameter. So N parameters with M operations would allocation O(N*M) space. It turns out, this is unnecessary! Reverse mode AD allocates only O(N+M) space to compute the derivatives of N parameters across M operations. In general, forward mode AD is best suited to differentiating functions of type: R → R N That is, functions of 1 parameter that compute multiple outputs. Reverse mode AD is suited to the dual scenario: R N → R That is, functions of many parameters t...

Extensible, Statically Typed Pratt Parser in C#

I just completed a statically typed Pratt-style single-state extensible lexer+parser, otherwise known as a top-down operator precedence parser, for the Sasa library . The implementation is available in the Sasa.Parsing dll, under Sasa.Parsing.Pratt . Two simple arithmetic calculators are available in the unit tests . This implementation is novel in two ways: Aside from an alleged implementation in Ada , this is the only statically typed Pratt parser I'm aware of. Pratt parsers typically require a pre-tokenized input before parsing semantic tokens, but I've eliminated this step by using the symbol definitions to drive a longest-match priority-based lexer. Symbols by default match themselves, but you can optionally provide a scanning function used to match arbitrary string patterns. The symbol selected for the current position of the input is the symbol that matches the longest substring. If two symbols match equally, then the symbol with higher precedence is selected. The design...