El modificador in para parámetros de entrada

“… Someone’s knocking at the door
Somebody’s ringing the bell
Do me a favor, open the door, and let ‘em in…”
Paul McCartney and Wings, “Let ‘Em In” (1976)

Aunque ya todos estamos esperando la presentación oficial de Visual Studio 2019 y C# 8.0 el próximo martes, yo aún sigo descubriendo algunas de las novedades del lenguaje que fueron incluidas en las tres releases puntuales que se liberaron bajo la etiqueta 7.x. En particular, hoy quiero referirme al modificador in, que ahora se puede asociar a los parámetros de un método de manera similar a como se utilizan ref y out en C# desde el principio de los tiempos.

Básicamente, cuando un parámetro se declara in, el compilador impedirá que dicho parámetro pueda modificarse dentro del cuerpo del método. Se trata de un paso pequeño, pero importante, en la dirección de la especificación declarativa de las propiedades de los métodos, principalmente útil en el caso de los parámetros que son clases (y por tanto se pasan por referencia) y podrían modificarse de manera inadvertida. Por otra parte, el hecho de que el parámetro no va a ser modificado hace en principio irrelevante si éste es pasado por valor o por referencia; esto, a su vez, hace posible la generación del código más eficiente posible en el lugar de las llamadas. Éste es el escenario de mayor relevancia en relación con el rendimiento, específicamente en el caso de los parámetros de tipo struct (que son tipos-valor) cuyo tamaño en memoria exceda el tamaño de la palabra del ordenador. En tales casos, el compilador generará código para pasar el parámetro por referencia y no por valor, con el consiguiente ahorro en la copia de datos en la pila. Un ejemplo podría ser el siguiente:

        // Computes the distance from a to b.
        public static double GetDistance(
            in System.Drawing.Point a, 
            in System.Drawing.Point b) 
        { 
            int dx = a.X - b.X; 
            int dy = a.Y - b.Y; 
            return System.Math.Sqrt(dx*dx + dy*dy); 
        }

Este ejemplo me trae a la mente una demo gráfica que solía hacer Microsoft por allá por el año 2000 cuando .NET estaba naciendo. La idea subyacente era que en .NET System.Drawing.Point es una estructura, mientras que en Java (el rival a batir por aquella época) el tipo correspondiente es (o era, no sé si la cosa habrá cambiado con el tiempo) una clase; un algoritmo que tenga que generar dinámicamente muchos puntos será bastante más lento en el segundo caso, debido a la necesidad de gestionar la creación en el heap de numerosos objetos. El uso del nuevo modificador in de C# 7.2 habría contribuido en aquel momento a hacer aún mayor la ventaja.

Personalmente, la inclusión del modificador in en el lenguaje me agrada mucho porque de alguna manera completa la transición de C# de un lenguaje más primitivo en el que los parámetros se denotan pensando en cómo los argumentos correspondientes serán pasados en tiempo de ejecución (por valor o por referencia), como ocurría en lenguajes históricos como C o Pascal, en un lenguaje más moderno y declarativo en el que los parámetros se denotan pensando en su propósito (de entrada, salida o entrada/salida), dejando al compilador los detalles de cómo implementar las llamadas de la manera más eficiente. Ada fue probablemente el lenguaje en el que esta idea se presentó claramente por primera vez.

El uso del modificador in se me antoja imprescindible cuando se esté creando una nueva aplicación o librería; como ocurre con casi todas las características que han sido incluidas después de la concepción original del lenguaje (lo que en inglés se diría un afterthought), debe utilizarse con cierta precaución al incorporarla en proyectos existentes; consulte los documentos de Microsoft al respecto (como éste) para más información.


Referencia musical: “Let ‘Em In” fue el segundo single del quinto disco de Paul McCartney con la banda Wings (“Wings at the Speed of Sound“, 1976). Sonó bastante por la radio, aunque no tanto como “Silly Love Songs“, que fue el número 1 de la lista Billboard de ese año.

De Span a Memory

“…Memoria, memoria
(no, I don’t have a gun)…”
Nirvana, “Come as You Are” (1992)

En nuestra entrada anterior presentamos la clase genérica Span<T>, que fue introducida oficialmente con C# 7.2, seguramente por el hecho de aprovecha algunas novedades relativamente menores incorporadas por primera vez al lenguaje en las distintas actualizaciones de la versión 7 (en particular, los valores de retorno por referencia – ref returns, de los que hemos hablado aquí, y las nuevas posibilidades que ofrece stackalloc, que pueden consultarse en esta página de JetBrains). Span<T> y su homólogo de solo lectura ReadOnlySpan<T> nos permiten hacer referencia de una manera uniforme a cualquier zona de memoria contigua de datos homogéneos, independientemente de dónde esa memoria está situada y de cómo ha sido obtenida.

La vez anterior no mencionamos que Span<T> tiene un pequeño inconveniente: a causa de su implementación (el lector interesado encontrará información detallada en los documentos a los que ya hemos hecho referencia), las instancias de Span<T>, si bien pueden apuntar a cualquier zona arbitraria de memoria, ellas mismas sólo pueden residir en la pila (stack) en forma de variables locales o parámetros de entrada de funciones (siempre que éstas no sean asíncronas, como veremos más adelante). Por ejemplo, si se trata de compilar la siguiente clase:

using System;
public class ThisWontCompile
{
    private Span<int> _span;
}

se obtendrá el error “Field or auto-implemented property cannot be of type ‘Span<int>’ unless it is an instance member of a ref struct (CS 8345)“.

Aquí es donde entra a jugar su papel la clase Memory<T>, cuyas instancias sí pueden residir en el heap. Memory<T> no implementa una API tan amplia como Span<T>, pero sí ofrece una propiedad Span que devuelve un Span<T> asociado a la misma zona de memoria.

Un caso que podría presentársele con cierta frecuencia y en el que deberá cambiar Span<T> por Memory<T> es al crear métodos asíncronos que reciban un span. Recuerde que al “desenrollar” un método asíncrono el compilador genera una clase para capturar el estado local y los parámetros de entrada (el mecanismo se describe muy bien aquí). En el caso que nos ocupa, la clase generada tendría que tener un campo de tipo Span<T>, que como hemos visto antes es imposible.

Suponga que quisiéramos hacer asíncrono el método QuickSort de nuestra entrada anterior. Con tan solo añadir al método el modificador async obtendríamos el error “Parameters or locals of type ‘Span<int>’ cannot be declared in async methods or lambda expressions (CS 4012)“:

  public static async void QuickSort<T>(Span<T> span) where T: IComparable

Podríamos resolver el problema así:

  public static async void QuickSort<T>(Memory<T> memory) where T: IComparable 
  {
      int i = 0, j = memory.Length - 1;
      T pivot = memory.Span[(memory.Length - 1) / 2];

      while (i <= j)
      {
          while (memory.Span[i].CompareTo(pivot) < 0) i++;
          while (memory.Span[j].CompareTo(pivot) > 0) j--;
          if (i <= j)
          {
              T tmp = memory.Span[i];
              memory.Span[i] = memory.Span[j];
              memory.Span[j] = tmp; 

              i++; j--;
          }
      }

      // Llamadas recursivas
      if (j > 0)
          await QuickSort<T>(memory.Slice(0, j + 1));
      if (i < memory.Length - 1)
          await QuickSort<T>(memory.Slice(i, memory.Length - i));
  }

Este es un caso relativamente bastante sencillo, pero en general (como hemos dicho ya alguna vez aquí) siempre que se trabaja directamente con la memoria se debe ser sumamente cuidadoso. Si piensa utilizar estas clases en contextos más avanzados, asegúrese de leer antes las recomendaciones oficiales de Microsoft sobre el uso de Memory<T> y Span<T>.


Referencia musical: A principios de los ’90 dejé de oír rock (tuve que concentrarme seriamente en buscarme la vida ), así que no me enteré de quién era Nirvana hasta más de una década después, cuando hice mi primer viaje a Seattle y Microsoft nos llevó a visitar el excelente Museum of Pop Culture, que exhibe numerosos objetos memorables relacionados con el grupo. “Come as You Are” fue el segundo single del disco “Nevermind“, que los lanzó a la fama. Puedo dar fe de que el tema se sigue escuchando aún con cierta frecuencia en las emisoras de radio de rock clásico.

Generalización del acceso a memoria con Span

“…as the links span our endless caresses
For the freedom of life everlasting…”
Yes, “The Revealing Science of God” (1973)

¡Feliz 2019! Deseo de corazón a todos mis lectores que hayan tenido una buena despedida del año que recién terminó. “Año nuevo, vida nueva”, decía mi abuela Guillermina, y uno de mis propósitos para este año es recuperar la sistematicidad en la escritura, que perdí completamente a finales del año pasado.

Esta primera entrada del año, que llevaba en el tintero unos cuantos meses sin que yo hubiera logrado terminarla, trata sobre el tipo de datos Span<T> (espacio de nombres System.Memory), de relativamente reciente aparición: fue incorporado a .NET Core 2.1. Para utilizarlo en proyectos de .NET Framework, sin embargo, tendrá que importar de Nuget el paquete System.Memory, como puede verse en la captura de pantalla a continuación. Como es muy pronto para empezar a quejarse ya, dejaré las quejas al respecto para el final.

Span<T> es un nuevo tipo por valor (value type) que nos permitirá hacer referencia de una manera uniforme a cualquier zona de memoria contigua de datos homogéneos, independientemente de si esta zona de memoria pertenece a un objeto de código manejado tradicional residente en el heap (T[]), a un buffer nativo (T*) o array creado en la pila mediante stackalloc, o incluso una estructura de datos a la que hayamos obtenido una referencia IntPtr mediante la interacción con código no manejado. A partir de cualquiera de esas fuentes se puede crear una variable de tipo Span<T> (o su pariente de solo lectura ReadOnlySpan<T>). Aparte del hecho de que Span<T> garantiza un acceso con validación de rango a cualquiera de los elementos de la estructura a través de un índice, como si de un array se tratara (s[i]), este tipo de datos ofrece otra ventaja que es muy importante de cara al rendimiento: no reserva buffers intermedios y evita las copias de datos innecesarias. Deja vu! Empezamos el nuevo año como mismo terminamos el viejo: hablando de un tipo de datos por valor (estructura) que ofrece mejoras de rendimiento.

El siguiente ejemplo muestra cómo crear un Span<T> a partir de un array, cómo hacer referencia a un elemento cualquiera, y (lo mejor de todo), cómo utilizar el método Slice para denotar a un subconjunto (“rebanada”) de los elementos del span. Para finalizar, ordeno la rebanada mediante una implementación “espantosa”1 de QuickSort. Tengo la impresión de que este algoritmo se logra expresar mucho más elegantemente cuando se utiliza Span<T>.

using System;

namespace SpanDemo
{
    public static class SortingRoutines
    {
        static void Main(string[] args)
        {
            var random = new Random();

            int[] values = new int[100]; 
            for (int i = 0; i < 100; i++)
                values[i] = random.Next(0, 1000);

            var span = new Span<int>(values);
            // Referencias a elemento
            Console.WriteLine("First element: {0}", span[0]);
            span[1]++;
            // "Rebanada" del span original
            var span2 = span.Slice(start: 3, length: 10);

            QuickSort(span2);
            foreach (int i in span2)
                Console.WriteLine(i);
        }

        public static void QuickSort<T>(Span<T> span) where T: IComparable 
        {
            int i = 0, j = span.Length - 1;
            T pivot = span[(span.Length - 1) / 2];

            while (i <= j)
            {
                while (span[i].CompareTo(pivot) < 0) i++;
                while (span[j].CompareTo(pivot) > 0) j--;
                if (i <= j)
                {
                    T tmp = span[i];
                    span[i] = span[j];
                    span[j] = tmp; 

                    i++; j--;
                }
            }

            // Llamadas recursivas
            if (j > 0)
                QuickSort<T>(span.Slice(0, j + 1));
            if (i < span.Length - 1)
                QuickSort<T>(span.Slice(i, span.Length - i));
        }
    }
}

Dejo al lector la investigación de cómo se implementa internamente la estructura Span<T>, algo que describen perfectamente tanto Ahson Khan en Code Magazine como Stephen Toub en MSDN Magazine.

Para finalizar, la diatriba prometida contra la exclusión de Span<T> de .NET Framework. No es la necesidad de añadir un paquete, ni mucho menos; es la fractura que empieza a producirse en el lenguaje por culpa de ello. Por ejemplo, Microsoft señala en este artículo que los futuros índices y rangos de C# 8.0 dependen de Span<T> y otras nuevas características, y no estarán disponibles al desarrollar aplicaciones para .NET Framework. Oficialmente, nos dicen que estos nuevos tipos no se añaden a .NET Framework para no comprometer la estabilidad de la plataforma; en el fondo, lo que pienso es que lo que Microsoft quiere es obligarnos a ir hacia .NET Core. Tal vez algún lector logre aclararme esta confusión.


1 “Espantoso” no viene de espanto, sino de Span<T> .

Referencia musical: El grupo británico Yes (elegido al Salón de la Fama del Rock’n’Roll en 2017) es uno de los máximos exponentes de la corriente que, por razones obvias, se ha dado en llamar rock sinfónico o progresivo, y “Tales from Topographic Oceans” (1973), al que pertenece la referencia musical de hoy, uno de los primeros exponentes de álbum conceptual, en este caso inspirado en la “Autobiografía de un Yogi”, de Paramahansa Yogananda.

La estructura ValueTask

“… ‘Cause I’ve been here, and I’ve been there,
Seems like I’ve been everywhere before.
I’ve seen it all a hundred times
Still I think there surely must be more…”
Kansas, “Paradox” (1977)

Repasando la enorme cantidad de características añadidas a  C# en las versiones 6 y 7.x, realmente puede dar la impresión de que (como dice la referencia musical de hoy) no queda nada más que inventar. Sin embargo, ya tenemos casi a la vuelta de la esquina a C# 8.0, con una buena cantidad de novedades relevantes.

Buscando entre las características incorporadas a partir de la versión 7.0 de las que no he hablado aún aquí (y que no sean totalmente triviales, como por ejemplo las mejoras en la representación de constantes numéricas), encontré la generalización de los tipos de retorno de los métodos asíncronos (generalized async return types), una característica que ha cobrado importancia principalmente debido a la aparición de un nuevo tipo que se ha hecho posible gracias a ella, ValueTask<T>,  que hace posible mejorar el rendimiento en ciertos escenarios de utilización de llamadas asíncronas.

Como seguramente sabrá, antes de C# 7.0 los métodos asíncronos solo podían devolver los tipos Task<TResult> (si se retorna un valor), Task (si el método realiza una acción y no retorna ningún valor) o void (en el caso de los gestores de eventos asíncronos1). A partir de  C# 7.0, se permite también que un método asíncrono devuelva un objeto de cualquier tipo que ofrezca un método GetAwaiter que a su vez retorne un objeto que implemente la interfaz ICriticalNotifyCompletion (espacio System.Runtime.CompilerServices). Lo más apropiado para esta entrada sería crear precisamente un tipo así, pero tengo la impresión de que eso tendría un interés puramente académico: no he encontrado en la web ninguna referencia a un tipo similar creado por terceros. Da la impresión de que esta generalización se ha hecho con el objetivo específico de abrir las puertas a la definición de ValueTask<T>, que precisamente cumple con ese requisito y que además tiene otra característica esencial: no es un tipo por referencia (class) sino un tipo por valor (struct). Es este hecho el que hace posible una mejora del rendimiento en ciertos escenarios de uso de los métodos asíncronos, como describiremos a continuación.

Para el ejemplo de hoy utilizaré la peor manera posible (o la más ingenua, si queremos ser más políticamente correctos) de implementar el cálculo del n-simo elemento de la serie de Fibonacci, en la que cada elemento subsiguiente de la serie se obtiene sumando los dos anteriores a él. Y como siempre es posible empeorar aún más algo que ya está mal, he añadido una “guinda al pastel” haciendo la que las llamadas recursivas se realicen de manera asíncrona. Esta variante asíncrona es la que me servirá como base para mostrar cómo el uso de ValueTask mejora el rendimiento (¿le parece a usted, querido lector, que el fin siempre justifique los medios? ;-)). Eche un vistazo al siguiente código:

using System;
using System.Threading.Tasks;

namespace Fibo
{
    class MainClass
    {
        static void Main(string[] args)
        {
            TimeMethod(() => { Console.WriteLine(Fibo(40)); } );
            TimeMethod(() => { Console.WriteLine(FiboAsync(40).Result ); } );
        }

        static long Fibo(int n)
        {
            if (n <= 1)
                return 1;

            return Fibo(n - 2) + Fibo(n - 1);
        }

        static async Task<long> FiboAsync(int n)
        {
            if (n <= 1)
                return 1;

            return await FiboAsync(n - 2) + await FiboAsync(n - 1);
        }

        static void TimeMethod(Action action)
        {
            DateTime t1 = DateTime.Now;
            action();
            DateTime t2 = DateTime.Now;
            Console.WriteLine("Ellapsed " +
                (t2 - t1).TotalMilliseconds + " ms.");
        }
    }
}

La salida que produce el programa anterior es la siguiente:

165580141
Ellapsed 1612.459 ms.
165580141
Ellapsed 44734.77 ms.

Así que introduciendo la asincronía sin que hubiera necesidad alguna hemos hecho el código unas 27 veces más lento :-). Pero esta entrada no intenta predicar sobre en qué situaciones se deben utilizar los métodos asíncronos; este enlace podría ser un buen comienzo para ello. Aquí yo solo intentaba buscar un ejemplo en el que el uso de ValueTask<T> ofreciera una mejora en rendimiento sobre Task<T>, y me pareció que éste podría ser un buen caso, porque en él se realiza una gran cantidad de cálculos repetidos, y cada invocación recursiva termina provocando llamadas a los casos base, en los que el resultado (1) está predeterminado.

Para poder hacer uso de la estructura ValueTask<T>, hace falta importar de Nuget el paquete System.Threading.Tasks.Extensions:

Ahora, sustituyendo la única referencia a Task en el código fuente por ValueTask y ejecutando, se obtiene como promedio lo siguiente:

165580141
Ellapsed 1617.608 ms.
165580141
Ellapsed 39123.887 ms.

La ganancia no es tanta como yo esperaba, pero en cualquier caso un 13% de mejora en el rendimiento no es nada despreciable.

La razón por la que el rendimiento es superior al utilizar ValueTask estriba en que cuando se utiliza el tipo Task, que es una clase, es necesario cumplir con el protocolo de instanciación de un objeto incluso en los casos base, para los que el resultado está predeterminado de antemano y en principio no haría falta ninguna tarea (retornando la llamada de forma síncrona). Al ser ValueTask un tipo por valor, la tarea a devolver se aloja en la pila, evitando así la costosa instanciación en todos esos casos base.

Note que también el uso de ValueTask hace posible una menor presión sobre la memoria (memory pressure), y una disminución en la frecuencia entre ejecuciones del recolector de basura (garbage collector). Este vídeo de Andrea Angella ilustra fenomenalmente este beneficio.


1 Frecuentemente encontrará recomendaciones sobre no crear métodos async void, como ésta de Bill Wagner.

Referencia musical: “Paradox” pertenece al “Point of Know Return” (1977), que es mi disco favorito de mi banda favorita, Kansas, a pesar de que la critica generalmente considera superior al proyecto anterior, “Leftoverture” (1976) – vea por ejemplo este reportaje de Rolling Stone que lo coloca en el lugar 32 de los mejores álbumes de rock progresivo de todos los tiempos.

Variables locales y valores de retorno por referencia (y 2)

En la entrada anterior presentamos otra de las novedades introducidas en C# 7.0: las referencias locales, o variables locales que contienen referencias (el término más común con el que se intenta comúnmente disfrazar a los punteros). Hoy toca hablar de cómo a partir de C# 7.0 es posible también definir métodos que devuelvan referencias; esta posibilidad normalmente sirve como contrapartida a la anterior (y por eso casi siempre se describen juntas), porque frecuentemente encontrará que el valor que se asigna a una referencia local es precisamente el resultado devuelto por una función que hace uso del retorno de una referencia.

En aquella ocasión mencionamos cómo el objetivo central de esta introducción camuflada de punteros es el de ayudar a incrementar el rendimiento en escenarios en los que no sea posible o conveniente recurrir al código no seguro (unsafe code). Pues bien, tal vez la situación más típica en la que es bueno utilizar punteros desde el punto de vista de una mayor velocidad de ejecución es cuando se necesita manipular los elementos de un array. Por esta razón, para el ejemplo de hoy utilizaremos una versión del reciente programa que cuenta las apariciones de las diferentes palabras reservadas de C#, en la que sustituiremos el diccionario que allí se utilizaba un por sencillo array:

    private static KeywordInfo[] dict;

    private static void InitializeDict()
    {
        dict = new KeywordInfo[keywords.Length + contextualKeywords.Length];

        int i = 0;
        foreach (var s in keywords) 
            dict[i++] = new KeywordInfo(s, false);
        foreach (var s in contextualKeywords) 
            dict[i++] = new KeywordInfo(s, true);
        Array.Sort(dict);
    }

Cada vez que el algoritmo que recorre los ficheros de código fuente encuentra una palabra reservada, debe buscarla en este array de estructuras e incrementar el contador correspondiente. La versión anterior del programa se apoyaba en un método llamado GetKeywordIndex que devolvía el índice de la palabra reservada en el array; en su lugar, aquí utilizaremos el método GetKeywordReference, que devuelve una referencia al elemento encontrado:

    private static ref KeywordInfo GetKeywordReference(string keyword)
    {
        for (int i = 0; i < dict.Length; i++)
        {
            int result = string.Compare(dict[i].Keyword, keyword);
            if (result == 0)
                return ref dict[i];
            else if (result > 0)
                break;
        }
        throw new InvalidOperationException($"Keyword missing: {keyword}");
    }

Dado el método anterior, el código que hace la llamada tendrá la siguiente apariencia:

        var text = childToken.Text;
        ref KeywordInfo keywordInfo = ref GetKeywordReference(text);
        keywordInfo.Count++;

Observe nuevamente la presencia del prefijo ref a ambos lados de la asignación.

Es de destacar también que el compilador de C# 7.0 lleva a cabo un sofisticado análisis de flujo para impedir que un método pueda devolver una referencia a algo que no estará disponible en el contexto en el que éste pueda ser llamado; por ejemplo, una referencia a una variable local del propio método, que dejará de existir tan pronto el método retorne.

La utilización del retorno de referencias en situaciones adecuadas (y éste se me antoja un buen ejemplo) podría resultar en un incremento perceptible del rendimiento.

Variables locales y valores de retorno por referencia

“… Turn around/Turn around
It’s on the other side
Feel the sound/Feel the sound
It’s coming from deep inside…”
Kansas, “On the Other Side” (1979)

La entrada anterior tenía al principio como objetivo mostrar el uso de las variables locales y valores de retorno por referencia (ref locals and returns), pero a lo largo del camino me fui desviando de ese objetivo inicial, para terminar hablando de otra cosa totalmente diferente. Con esta entrada intento retomar la senda perdida aquella vez y mostrar la utilización de estas novedosas posibilidades que ofrece C#, aparecidas por primera vez en la versión 7.0.

Estas características tienen como objetivo principal el de introducir una semántica de punteros sin que sea necesario recurrir al código no seguro (unsafe code), con la finalidad última de promover ventajas de rendimiento, de manera similar a los parámetros ref de toda la vida. Por ejemplo, suponiendo que dispusiéramos de una estructura de gran tamaño y necesitáramos pasarla a un método como parámetro, la posibilidad de pasar una referencia a la estructura en lugar de la estructura en sí nos permitiría ahorrar tanto en espacio de pila como en el tiempo necesario para la copia. Aquí me he montado un ejemplo rápido, aunque probablemente haría falta una estructura bastante más grande para que la ganancia fuera perceptible:

namespace RefReturnsAndLocals
{
    public struct Point
    {
        public int X, Y, Z;
        public override string ToString() => $"({X}, {Y}, {Z})";
    }

    static class MainClass
    {
        static void Main()
        {
            Point p = new Point { X = 0, Y = 0, Z = 0 };
            Drift(ref p, 100);
            Console.WriteLine(p);
        }

        static void Drift(ref Point point, int steps)
        {
            var rnd = new Random();
            for (int i = 0; i < steps; i++)
            {
                point.X += rnd.Next(-5, 6);
                point.Y += rnd.Next(-5, 6);
                point.Z += rnd.Next(-5, 6);
            }
        }
    }
}

Las referencias locales operan de manera bastante similar a los parámetros ref; por ejemplo, en el método Drift podríamos haber introducido una variable-referencia local, inicializarla para apuntar al mismo sitio al que apunta el parámetro de entrada y utilizarla en los cálculos:

        static void Drift(ref Point point, int steps)
        {
            ref Point p = ref point;
            var rnd = new Random();
            for (int i = 0; i < steps; i++)
            {
                p.X += rnd.Next(-5, 6);
                p.Y += rnd.Next(-5, 6);
                p.Z += rnd.Next(-5, 6);
            }
        }
    }
}

Observe cómo hay que utilizar ref tanto en la declaración de la variable como en la expresión de inicialización. Al declarar una referencia local como ésta, siempre se la debe inicializar; a partir de C# 7.3 (¿se había Ud. dado cuenta de que ya está disponible?), es posible poner una referencia local a “apuntar” a otro objeto del tipo adecuado en cualquier momento posterior a la inicialización.

Dejaré la presentación de los valores de retorno por referencia, que tienen sus propios detalles interesantes, para la próxima entrega. Pero antes de finalizar aquí, vale la pena recordar una vez más que siempre que se trabaja con punteros, los peligros acechan en todo momento. Por ejemplo, quite el prefijo ref en la declaración de esta última versión del método Drift y en la correspondiente llamada; obtendrá un programa que compila, pero no funciona (¿por qué, amigo lector?).


Referencia musical: “On the Other Side” es el primer tema del “Monolith” (1979), el primer disco que mi banda favorita, Kansas, produjo de manera independiente, un derecho que se ganó a pulso después del enorme éxito de sus proyectos anteriores, “Leftoverture” (1976), “Point of Know Return” (1977) y “Two for the Show” (directo, 1978). Si bien ese disco no alcanzó el nivel de los anteriores, todavía tuvo un relativo éxito; algunos de sus temas aún se dejan oír después de casi 40 años, especialmente “On the Other Side” y “People of the South Wind“, dedicada a la tribu aborigen de la que se derivó originalmente el nombre Kansas.

Contando palabras reservadas

Intentando continuar la serie dedicada a las novedades aparecidas en C# 7.0 y versiones posteriores, se me ocurrió escribir un programa que contara las apariciones de las diferentes palabras reservadas (keywords) y palabras reservadas contextuales (contextual keywords) de C# en un fichero de código fuente individual o un conjunto de ficheros de código fuente alojados en una estructura de carpetas anidadas. Como lejana fuente de inspiración me sirvió el recuerdo de un programa para contar las palabras de un fichero incluido en un libro que ha dejado huella, “The C Programming Language“, de Kernighan y Ritchie.

Originalmente pensé que podría utilizar el programa para mostrar las ventajas que puede aportar al rendimiento la utilización de las variables locales y valores de retorno por referencia (ref locals and returns) incorporadas a C# 7.0. Lo cierto es que a lo largo del camino perdí el norte (tal vez me reencuentre con él en una próxima entrega), pero pienso que el viaje ha valido la pena; en particular, por fin he hecho uso (aunque de una manera trivial, lo reconozco) de las posibilidades que ofrece .NET Compiler Platform, la tecnología anteriormente conocida como Roslyn. Espero que el lector también saque algo positivo de la lectura de esta entrada, y para contribuir más a ello pongo a su disposición el código del proyecto, en el que también se utilizan otras novedades de C# 7.0 como las tuplas-valor o las funciones anidadas.

No me extenderé mucho aquí en una introducción al uso de .NET Compiler Platform, porque el lector encontrará múltiples tutoriales de calidad en la web, en particular para el análisis sintáctico; un buen ejemplo es éste. Baste decir que solo es necesario añadir a su proyecto el paquete de NuGet Microsoft.CodeAnalysis.CSharp, y ello le dará acceso a toda la gama de herramientas para la compilación que ofrece Roslyn. Gracias a esa potencia, el método central de nuestro ejemplo, que procesa un fichero de código fuente C#, consiste en unas pocas líneas:

private static void ProcessFile(string fileName)
{
    var tree = CSharpSyntaxTree.ParseText(File.ReadAllText(fileName));
    Traverse(tree.GetRoot());

    void Traverse(SyntaxNode node)
    {
        foreach (var childToken in node.ChildTokens())
        {
            if (childToken.IsKeyword() || childToken.IsContextualKeyword())
            {
                var text = childToken.Text;
                dict[text] = (dict[text].IsContextual, dict[text].Count + 1);
            }
        }

        foreach (var childNode in node.ChildNodes())
            Traverse(childNode);
    }
}

Las listas completas de palabras reservadas y palabras reservadas contextuales de C# las tomé directamente del código fuente de Roslyn en Github; las que intenté tomar de otras fuentes estaban siempre incompletas, como pude comprobar al ejecutar el programa sobre un conjunto de ficheros de la vida real. Las cinco palabras reservadas más utilizadas en ese conjunto son, en orden descendente: using, public, new, return y private.

El futuro atributo CallerArgumentExpression: un deseo que se cumplirá

“… It’s too bad that all these things
Can only happen in my dreams
Only in dreams, in beautiful dreams …”
Roy Orbison, “In Dreams” (1963)

“… We all know / That people are the same wherever you go …”
Paul McCartney & Stevie Wonder, “Ebony and Ivory” (1982)

Hace unos cuantos meses, mi buen amigo Eduard Tomàs publicó en este mismo sitio una entrada con título auto-descriptivo llamada “Hoy he echado en falta poder definir macros en C#“. En la discusión subsiguiente, especulamos sobre un hipotético atributo de .NET que hiciera posible satisfacer su deseo incumplido. Pues bien, ayer revisando las propuestas de características a añadir en las próximas versiones del lenguaje (en el sitio de Github en el que el equipo de C# publica las minutas de sus reuniones, entre otros documentos muy interesantes) me encontré con la descripción del futuro atributo CallerArgumentExpression, que (en el supuesto de que sea implementado, claro), permitirá lograr fácilmente el efecto que Eduard quería obtener aquella vez.

La propuesta de esta nueva característica está siendo considerada por el equipo de C# desde mayo de 2017, unos cuantos meses antes de que nosotros conversáramos sobre el tema; ello me reafirma una vez más en que, como dijeran magistralmente Paul y Stevie, la gente (y en particular, los programadores) tiene las mismas necesidades en todos los lugares. 🙂

using System.Runtime.CompilerServices;

public static class Check
{
    public static void NotNull<TParameter>(TParameter param, 
        [CallerArgumentExpression("param")] string expr = "")
        where TParameter : class
    {
        if (param == null)
        {
            throw new ArgumentNullException(paramName: expr);
        }
    }
}

Referencia musical: Intenté infructuosamente encontrar alguna canción de mi época que dijera que algunos sueños a veces se cumplen; no encontré ninguna, así que he puesto otra que dice más o menos lo contrario. Su autor fue el genial Roy Orbison, a quien mayormente se le recuerda por haber escrito la canción que sirvió de tema a la película “Pretty Woman“. De Paul McCartney y Stevie Wonder no diré nada más aquí – son dos de mis músicos favoritos y seguramente los he mencionado ya en alguna entrada anterior.

La sentencia switch en C# 7.0 (y 2)

“It never rains in California,
But girl, don’t they warn ya,
It pours, man, it pours…”
Albert Hammond, It Never Rains in Southern California (1972)

Parte 1

En nuestra entrega anterior hablamos sobre las nuevas posibilidades de la sentencia switch, y en particular las relacionadas con la utilización de los tres tipos de patrones soportados por C# 7.0 en las cláusulas case, que mencionamos por primera vez aquí. En dicha última entrega nos quedó pendiente hablar sobre la utilización en el marco de las sentencias switch del tercer tipo de patrones disponible: los patrones var.

De manera similar a lo que ocurre cuando se les usa en una sentencia if, estos patrones casan incondicionalmente, y simplemente asignan el valor de la expresión de switch a la variable asociada, que será del mismo tipo de la expresión:

    switch (obj)
    {
        case var x:
            Console.WriteLine($”Type is {x.GetType().FullName});
            break;
    }

Como mismo dijimos entonces, no parece fácil encontrar una situación práctica donde la utilidad del uso de esta construcción sea evidente. Al menos, no he visto ninguno todavía en ninguno de los artículos que he leído al respecto (incluyendo los de MSDN donde se describe la característica). Pero ya sabemos que la vida es más rica que cualquier referente en el que la queramos enmarcar.

Algunas de las fuentes que he consultado sugieren que el uso de este patrón gana en posibilidades si se le combina con la otra novedad incorporada a la sentencia switch en C# 7.0: la cláusula when, que hace posible adosar una condición a una cláusula case, como se hace desde hace mucho tiempo en Visual Basic:

    switch (p.Age)
    {
        case var n when n < 16:
            Console.WriteLine(“Can’t vote yet!”);
            break;
        default:
            Console.WriteLine(“Potential voter!”);
            break;
    }

La cláusula when se puede asociar también a los patrones de tipo. El código que sigue es una modificación del utilizado en el ejemplo de la entrega anterior, en el que ahora se contabilizan las mascotas según su tipo y las personas según su edad. Reconozco que el ejemplo no es el mejor; observe la cantidad de código que se duplica debido al hecho de que únicamente una de las ramas de una sentencia switch se ejecuta.

class MainClass
{
    static void Main(string[] args)
    {
        Process(
            new Employee("Octavio"55"Software Eng."),
            new Person("Diana"21),
            new Pet("Shelly"PetType.DOG11)
        );
    }

    static void Process(params object[] data)
    {
        int people = 0, oldPeople = 0;
        int pets =  0, dogs = 0, cats = 0;
        foreach (var obj in data)
        {
            switch (obj)
            {
                case null:
                    break;

                case Pet pet when pet.Type == PetType.DOG:
                    Console.WriteLine($"{pet.Name} [{pet.Type}]");
                    pets++;
                    dogs++;
                    break;
                case Pet pet when pet.Type == PetType.CAT:
                    Console.WriteLine($"{pet.Name} [{pet.Type}]");
                    pets++;
                    cats++;
                    break;
                case Pet pet:
                    pets++;
                    break;

                case Employee e:
                    Console.WriteLine($"{e.Name} ({e.Position})");
                    people++;
                    if (e.Age > 50)
                        oldPeople++;
                    break;
                case Person p when p.Age > 50:
                    Console.WriteLine(p.Name);
                    people++;
                    oldPeople++;
                    break;
                case Person p:
                    Console.WriteLine(p.Name);
                    people++;
                    break;

                default:
                    Console.WriteLine("** Invalid input!");
                    break;
            }
        }
        Console.WriteLine($"Total {people} people, {oldPeople} of them old.");
        Console.WriteLine($"Total {pets} pets, of them {dogs} dogs and {cats} cats.");
    }
}

La adición de la cláusula when a la sentencia switch es en buena medida ortogonal con la presencia de esta cláusula en los bloques catch de manejo de excepciones (desde C# 6.0) para implementar lo que se conoce como filtrado de excepciones. Para esto sí que he encontrado algunos casos de uso práctico en la vida real; por ejemplo, cuando se necesita discriminar ciertos tipos de errores durante el acceso a una base de datos de SQL Server según su código (vea, por ejemplo, este enlace).


Referencia musical: Llueve mucho en estos días (suceso bastante muy poco común) aquí en el sur de California, así que echo mano de este viejo clásico de Albert Hammond. Que en realidad no trata tanto del clima local ni la lluvia como de lo mal que lo puedes pasar por estos lares si te toca una racha de mala suerte.

La sentencia switch en C# 7.0

“Si te quiero es porque sos
Mi amor, mi cómplice y todo,
Y en la calle, codo a codo,
Somos mucho más que dos…”
(Poema de Mario Benedetti)

En una entrada anterior reciente presentamos una de las novedades importantes que introdujo C# 7.0, los llamados patrones (patterns), que ahora pueden utilizarse en el contexto de dos construcciones del lenguaje:

  • El operador is de comprobación de tipos, que ahora acepta también en su parte derecha un patrón, además de un tipo.
  • Las cláusulas case de la sentencia switch, que ahora pueden especificar un patrón de emparejamiento, y no únicamente una constante.

En aquella ocasión mostramos cómo hacer uso de los tres tipos de patrones que incorpora C# 7.0 conjuntamente con el operador is; hoy veremos cómo utilizarlos en el marco de una sentencia switch, algo que en la práctica será mucho más común. Para ello, utilizaremos un sencillo ejemplo que contabiliza e imprime los invitados a una fiesta de empresa a la que se admiten también mascotas:

class MainClass
{
    static void Main(string[] args)
    {
        Process(
            new Employee("Octavio"55"Software Eng."),
            new Person("Diana"21),
            new Pet("Shelly"PetType.DOG11)
        );
    }

    static void Process(params object[] data)
    {
        int people = 0pets = 0;
        foreach (var obj in data)
        {
            switch (obj)
            {
                case null:
                    break;
                case Pet pet:
                    Console.WriteLine($"{pet.Name} [{pet.Type}]");
                    pets++;
                    break;
                case Employee e:
                    Console.WriteLine($"{e.Name} ({e.Position})");
                    people++;
                    break;
                case Person p:
                    Console.WriteLine(p.Name);
                    people++;
                    break;
                default:
                    Console.WriteLine("** Invalid input!");
                    break;
            }
        }
        Console.WriteLine($"Total: {people} people, {pets} pets.");
    }
}

Nótese en primer lugar que la expresión de control de la sentencia switch ya no está limitada a los tipos básicos y las cadenas: la expresión puede ser ahora de cualquier tipo, valor o referencia. La primera cláusula case ejemplifica el primer tipo de patrones que estudiamos la vez anterior, los patrones constantes, que es de hecho lo que estábamos acostumbrados a utilizar en cláusulas case en versiones anteriores de C#; solo que ahora null es una constante tan válida como otra cualquiera.

Las tres cláusulas case a continuación ejemplifican el segundo tipo de patrones, los patrones de tipo, que tienen la forma T x, donde T es un tipo y x un identificador de variable; mediante ellos se comprueba si el valor de la expresión es de tipo T, y en caso afirmativo, se asigna dicho valor a la variable x de tipo T. Téngase en cuenta aquí que el valor null nunca “casa” en estos patrones, por lo que es generalmente necesario codificar explícitamente ese caso, tal y como hemos hecho en el ejemplo.

Dejaremos el uso del tercer tipo de patrones (los patrones var) en la sentencia switch para una próxima entrega, para verla en combinación con otra interesante novedad añadida a esta sentencia en C# 7.0: la cláusula when.

Hay que destacar que con la llegada de C# 7.0 y estas nuevas posibilidades, la sentencia switch se convierte en una bestia MUY DIFERENTE de lo que era hasta la versión anterior de C#:

a) En primer lugar, la sentencia se hace mucho más dinámica de lo que fue nunca antes. Ahora los patrones de las cláusulas case se emparejan en tiempo de ejecución. Anteriormente, las cláusulas case solo especificaban constantes (diferentes, añadiría yo), y todo estaba claro ya en tiempo de compilación.

b) En segundo lugar, y estrechamente relacionado con lo anterior, ahora el ORDEN de las cláusulas case en el código fuente es importante; antes era irrelevante.

La semántica de switch ahora consiste, en el caso general, en evaluar secuencialmente (en cascada) cada una de las cláusulas case y ejecutar el bloque de código asociado a la primera cláusula que se satisfaga; cediendo el control al bloque default solamente en caso de que ninguna cláusula case tenga éxito. Dado que en una sentencia switch de versiones anteriores de C# solo había constantes mutuamente excluyentes en las cláusulas case, el compilador tenía múltiples opciones a la hora de traducirla a código de máquina, y la única implementación posible no era una cascada de condicionales, sino varios otros métodos tales como tabla de saltos, búsqueda binaria y otros. Por supuesto, el compilador podría continuar utilizando todas esas técnicas cuando encuentre sentencias switch que no utilicen ninguna de las novedades de C# 7.0.

Por último, y ya para concluir por hoy, señalaremos que en C# 7.0 el compilador sigue haciendo, no obstante lo dicho anteriormente, todo lo que puede por nosotros. Por ejemplo, asumiendo como es de suponer que la clase Employee hereda de Person, nuestro programa de ejemplo no compilará si se intercambian de orden los casos correspondientes en la sentencia switch. Esto es similar a lo que hace el compilador toda la vida en relación con los tipos de excepciones que se especifican en cláusulas catch de un mismo try.


Referencia cultural: Como esta entrada se escribe durante el Día de San Valentín, aprovecho para insertar un fragmento de uno de los muchos lindos poemas de amor de ese gigante de la poesía iberoamericana que es el uruguayo Mario Benedetti.