【Redi设计与实现】第六章：整数集合

整数集合时集合键的底层实现之一，当一个集合只包含整数值元素，并且这个集合的元素数量不多时，Redis就会使用整数集合作为集合键的底层实现。

6.1 整数集合的实现

整数集合（intset）是Redis用于保存整数值的集合抽象数据结构，它可以保存类型为int16_t、int32_t或者int64_t的整数值，并且保证集合中不会出现重复元素。

每一个intset表示一个整数集合：

typedef struct intset {
	// 编码方式
	uint32_t encoding;
	// 集合包含的元素数量
	uint32_t length;
	// 保存元素的数组
	int8_t contents[];
} intset;

contents 数组是整数集合的底层实现：整数集合的每个元素都是conters数组的一个数组项（item），各个项在数组中按值的大小从小到大有序的排列，并且数组中不包含任何重复项。

length 属性记录 contents 数组里面整数的个数。

虽然 intset 结构将 contents 属性声明为int8_t类型的数组，但实际上contents数组并不保存任何int8_t类型的值，contnets数组的真正类型取决于encoding属性的值：

1. 如果encoding属性的值为INTSET_ENC_INT16，那么cintents就是一个 int16_t 类型的数组，数组里的每一个项都是一个 int16_t 类型的整数值（-32768 ~ 32767）
2. 如果encoding属性的值为INTSET_ENC_INT32，那么cintents就是一个 int32_t 类型的数组，数组里的每一个项都是一个 int32_t 类型的整数值（-2147483648 ~ 2147483647）
3. 如果encoding属性的值为INTSET_ENC_INT64，那么cintents就是一个 int64_t 类型的数组，数组里的每一个项都是一个 int64_t 类型的整数值（-9223372036854775808 ~ 9223372036854775807）

简单来说，就是 encoding 是什么类型的，数组就会保存什么类型的。

图6-1展示了一个实例：

• encoding 属性的值为 INTSET_ENC_INT16，表示整数集合 contents 的底层实现为 int16_t 类型的数组，而集合保存的都是 int16_t 类型的整数值。
• length 属性的值为5，表示整数集合包含五个元素。
• contents 数组按从小到大的顺序保存这集合中的五个元素。
• 因为每个集合元素都是int16_t 类型的整数值，所以 contents 数组的大小等于 size(int16_t) * 5 = 80位。

我们来看看另一个整数集合： intset 每个属性代表的意思和上述一样，这里讲一点区别：

• 我们发现，对于 1、3、5而言，我们只需使用int16位来进行存储就可以了，对于-2675256175807981027 而言，我们只需要使用 int64来存储。
• 为什么最后都使用的是 int64 为存储呢？原因在于，contents 整数集合在进行添加的时候，会自动进行升级操作。
• 比如一开始是 int16 位的，当我们添加一个 int32 位的时候，就会升级到32位，再添加一个64位的，就会再次升级至 int64 位。

6.2 升级

每次我们要将一个新元素添加到整数集合里买呢，并且新元素的类型比整数集合现有所有元素的类型都要长时，整数集合需要进行升级，然后才能进行添加到集合里面。

升级集合并添加分三步进行：

• 根据新元素的类型，扩展整数集合底层数组的空间大小，并为新元素分配空间。
• 将底层数组现有的所有元素都转换成与新元素相同的类型，并将类型转换后的元素放置在正确的位上，在放置元素的过程中，需要维持底层数组的有序性质不变。
• 将新元素添加到底层数组

举个例子：假设现在有一个 INTSET_ENC_INT16 编码的整数集合，集合中包含着三个 int16_t 类型的元素，如图 6-3 所示： 因为每个元素都占用16位空间，所以整数集合底层数组的大小为 3*16 = 48位，图6-4展示了整数集合在三个元素在这48位的位置。 假设，我们要把类型为 int32_t 的整数值65535添加到整数集合里面，因为65535的类型int32_t比整数集合当前所有的元素的类型都要长，所以在将65535添加到整数集合之前，程序需要先对整数集合进行升级。

升级首先要做的事情，就是根据我们新类型的长度，对我们的数组的空间重新进行分配。

整数集合目前有三个元素，在加上新元素65535，整数集合需要分配四个元素的空间，因为每个 int32_t 需要占用32位空间，所以在空间进行重新分配后，底层数组的大小是：32*4 = 128位。

虽然，我们对底层数组重新进行了空间重分配，但数组原有的三个元素1、2、3仍然是 int16_t 类型，这些元素还保存在数组的前48位里面，所以程序接下来的操作就是将这三个元素转换成 int32_t 类型，并将转换后的元素放置在正确的位上面，在放置元素的过程中，要保持数组的有序性。 首先，因为元素3在1、2、3、65535四个元素中排名第三，所以它被移动到 contents 数组的索引2位置上，也即是数组64位至95位的空间内，如图6-6所示：

其他的数值也是如此，进行填充即可。

因为每次向集合中添加新元素都可能会引起升级，而每次升级都要对数组底层已有的元素进行类型转换，所以向集合中添加新元素的时间复杂度为O (N)。

其他的升级编码的操作也和上述操作类似。

6.3 升级的好处

整数集合的升级策略有两个好处，一个是提高整数集合的灵活性，另一个尽可能的节约内存。

6.3.1 提升灵活性

因为C语言是静态类型语言，为了避免类型错误，我们通常不会将两种不同类型的值放在同一个数据结构里面。

例如：我们一般只 int16_t 类型的数组来保存 int16_t 的值，类似如此。

因为整数集合可以自动的升级，所以我们不用担心类型出现错误的问题，这种做法非常的灵活。

6.3.2 节约内存

我们可能会说，直接用 int64_t 的类型保存三个值不就可以了，这样就不用进行整数的升级操作了。

如果当前添加的整数全部都是 int16_t 的类型，就会导致大量的内存被浪费，为了避免这种浪费，我们进行升级的操作。

6.4 降级

整数集合不支持降级的操作，一旦对数组进行了升级，编码就会保持升级后的状态。

6.5 整数集合API

6.6 重点回顾

• 整数集合是集合键的底层实现之一
• 整数集合的底层实现为数组，这个数组以有序、无重复的方式保存集合元素，再有需要时，程序会根据新添加元素的类型，改变这个数组的类型。
• 升级操作为整数集合带来了操作上的灵活性，并且尽可能的节约了内存。
• 整数集合只支持升级操作，不支持降级操作。