¿Qué son los Subscripts?

Tutorial Swift – ¿Qué son los Subscripts?

En el Tutorial Swift de hoy aprenderemos acerca de los Subscripts o subíndices, algo que venimos usando desde el inicio pero que lo hacíamos sin apenas prestarle atención, en plan mecánico, sin preguntarnos que habría tras esta funcionalidad.

Las clases, estructuras y enumeraciones pueden definir subscripts, los cuales no son más que una manera rápida o un enlace más directo a esos elementos (valores) que conforman una colección, lista o secuencia. Los subscripts nos permiten establecer u obtener valores haciendo uso de un índice sin necesidad de métodos para esta función. Por ejemplo, para acceder a los elementos de un Array podemos hacer algo como:

someArray[index]

…mientras en el caso de los diccionarios:

someDictionary[key]

Este modo de acceso a los datos es a lo que llamamos un subíndice o un subscript.

Subscripts Personalizados

Resumiendo y simplificando lo ante dicho: un subscript nos permiten hacer consultas a una instancias de cierto tipo al escribir uno o más valores dentro de corchetes ([]) luego del nombre de la instancia. Un comportamiento que también podemos aplicar en nuestros propios tipos mediante una implementación personalizada.

Sintaxis

La sintaxis de un subscript personalizado es similar a la de los métodos de instancia o a la de las propiedades computadas. La definición la comenzamos con la palabra clave subscript, acto seguido especificamos uno o más parámetros y finalizamos con un tipo de retorno tal y como hacemos con los métodos de instancia. A diferencia de estos últimos los subscripts pueden ser de lectura y escritura o de solo lectura, un comportamiento que se logra a través de getters y setters de la misma forma que con las propiedades computadas:

Sobre newValue debemos decir que su tipo es el mismo que el del valor de retorno y, nuevamente, al igual que con las propiedades computadas podemos omitir en set la declaración del parámetro (newValue), caso en el que podremos seguir haciendo referencia a este nombre ya que Swift lo provee automáticamente.

Cuando deseamos lograr un comportamiento de solo lectura solamente tendremos que eliminar el bloque get:

Implementación

Aquí el ejemplo de un subscript implementado como solo lectura dentro de una estructura:

…la salida en pantalla sería:

De la línea 9 a la 13 definimos nuestro subscript y en la 17 creamos una instancia de la estructura y establecemos el multiplicador haciendo uso de inicializador por defecto de la estructura. En la siguiente línea efectuamos una llamada al subscript en pos de proceder a la multiplicación y obtener el valor de retorno.

¿Qué funcionalidades nos brinda un Subscript?

Hablemos ahora sobre las capacidades que nos ofrece un subscript, que podemos hacer con él, con cuanta flexibilidad contamos al definir un subscript personalizado. Podemos decir que:

  • Pueden tomar cualquier cantidad de parámetros de entrada los cuales pueden ser de cualquier tipo y dicho esto es “evidente” que también pueden retornar cualquier tipo de dato.
  • Pueden usar parámetros variádicos pero no pueden usar parámetros in-out o establecer valores por defecto.
  • Una clase o estructura puede proveer tantas implementaciones de subscripts como estas necesiten. El subscript a ser usado será inferido por los tipos de datos que sean pasados y en general por el uso que se haga de este, tal y como en una sobrecarga de métodos, de hecho la definición de varios subscripts se conoce como sobrecarga de subscripts.

Subscripts de múltiples parámetros

Lo más común es que un subscript tome solamente un parámetro pero como acabamos de comentar puede tomar múltiples. En el siguiente ejemplo definimos una estructura de nombre Matrix la cual representa una matriz de dos dimensiones de valores Double:

Comenzamos el código de la estructura definiendo las constantes rows (fila) y columns (columnas), acto seguido la cuadrícula de tipo Double que dará soporte a nuestra matriz. Aún cuando las estructuras nos brindan un inicializador por defecto hemos definido uno ya que necesitamos un proceso de inicialización un poco más personalizado, haciendo referencia a la línea 16 donde igualamos nuestra variable grid con un arreglo que inicializamos con el valor 0.0 el cual repartimos por todas las celdas de nuestra matriz multiplicando las filas por las columnas como también se puede observar en esta línea.

A nuestra estructura de ejemplo le hemos añadido un método de nombre indexIsValid que se encarga, tal y como su nombre indica, de verificar si cierto índice conformado por fila y columna es válido. Por si alguien se lo pregunta los paréntesis añadidos a esta expresión no tienen la intención de lograr ningún comportamiento determinado, el único objetivo es la claridad a la hora de leer la línea.

Proseguimos con el subscript que declaramos de la línea 26 a la 44 el cual recibe dos parámetros de tipo Int, la fila y la columna, retornando un valor de tipo Double. Este subscript es de lectura-escritura y por eso tiene sus bloques get y set. En ambos bloques comenzamos por verificar si las coordenadas son correctas, apoyándonos en indexIsValid al mismo tiempo que en la instrucción assert. Esta última en caso de recibir false como parámetro detendrá la ejecución de nuestro programa. Creo importante aclarar que la función assert solamente es evaluada en modo Debug, si deseamos lograr lo mismo en modo Release y evitar que las llamadas a assert sean eliminadas por el compilador pues tendremos que hacer uso de la función precondition. Para más información los invito a leer el artículo sobre el manejo de errores en el lenguaje de programación Swift.

La función assert solamente es evaluada en modo Debug, si deseamos lograr lo mismo en modo Release tenemos que usar la función precondition.

Luego de estas líneas en común, en el bloque get se devuelve el valor almacenado en las coordenadas especificadas y de manera similar en el bloque set almacenamos en la matriz el valor que el usuario pasa al subscript. En este punto solamente tendríamos que crear una instancia de la estructura, algo bien simple:

…hemos creado una tabla de dos filas y dos columnas y gracias a nuestro inicializador ahora sus celdas contienen el valor inicial que establecimos, tal y como se muestra en la siguiente imagen:

Matriz

La siguiente acción sería sobre el subscript, el cual nos ayudaría a establecer algunos valores:

Acabamos de almacenar en la celda(0,1) el valor 1.5 y en la celda(1, 0) el valor 3.2, actualmente la matriz luce como:

Matriz con Datos

Creo que ya ha quedado claro que son los subscript y las posibilidades que nos brindan. Evidentemente se pueden hacer muchas cosas más con estos, todo depende de nuestra necesidad.

El código de ejemplo lo pueden encontrar en un proyecto Playground alojado en la cuenta personal de Josué V. Herrera en GitHub, específicamente en el repositorio asociado a este artículo.

Espero que todo cuanto se ha dicho aquí, de una forma u otra le haya servido de aprendizaje, de referencia, que haya valido su preciado tiempo.

Este artículo, al igual que el resto, será revisado con cierta frecuencia en pos de mantener un contenido de calidad y actualizado.

Cualquier sugerencia, ya sea errores a corregir, información o ejemplos a añadir será, más que bienvenida, necesaria!