Redis学习（五）——整数集合

一、整数集合

1.介绍

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

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

typedef struct intset {
    
    // 编码方式
    uint32_t encoding;

    // 集合包含的元素数量
    uint32_t length;

    // 保存元素的数组
    int8_t contents[];

} intset;

虽然contents数组是int8_t类型的，content数组的真正类型取决于encoding属性的值：比如，如果encoding是INTSET_ENC_INT16，那么contents就是一个int16_t类型的数组。

2.升级

每当我们添加一个新的元素到整数集合里，并且新的元素的类型比整数集合现有所有类型的类型都要长时，整数集合需要升级，然后才能将元素添加到整数集合里。
升级整数集合并添加新元素共分为三步进行：
（1）根据新元素的类型，扩展整数集合底层数组的空间大小，并为新元素分配空间。
（2）将底层数组现有的所有元素都转换成新元素相同的类型，并将类型转换后的元素继续维持有序性。
（3）将新元素添加到底层数组里

整数集合升级的策略有两个好处，一个是提升整数集合的灵活性，另一个是节约内存。
整数集合不支持降级，一旦对数组进行了升级就不能降级。

三、API

intset *intsetNew(void);  //创建一个新的整数集合
intset *intsetAdd(intset *is, int64_t value, uint8_t *success);  //添加元素	
intset *intsetRemove(intset *is, int64_t value, int *success);	//删除元素		
uint8_t intsetFind(intset *is, int64_t value); //查找给定值是否存在于集合
int64_t intsetRandom(intset *is);  //随机返回一个元素
uint8_t intsetGet(intset *is, uint32_t pos, int64_t *value); //取出底层数组在索引上的值
uint32_t intsetLen(intset *is); //返回整数集合包含的元素个数
size_t intsetBlobLen(intset *is); //返回整数集合会占用的内存字节数

四、源码

1.intsetNew

//创建一个新的整数集合
intset *intsetNew(void) { 

    // 为整数集合结构分配空间
    intset *is = zmalloc(sizeof(intset));

    // 设置初始编码
    is->encoding = intrev32ifbe(INTSET_ENC_INT16);

    // 初始化元素数量
    is->length = 0;

    return is;
}

2.intsetAdd

//添加元素
intset *intsetAdd(intset *is, int64_t value, uint8_t *success) {

    // 计算编码 value 所需的长度
    uint8_t valenc = _intsetValueEncoding(value);
    uint32_t pos;

    // 默认设置插入为成功
    if (success) *success = 1;
    
    // 那么表示 value 必然可以添加到整数集合中
    // 并且整数集合需要对自身进行升级，才能满足 value 所需的编码
    if (valenc > intrev32ifbe(is->encoding)) {
        return intsetUpgradeAndAdd(is,value);
    } else 
        // 查找位置
        if (intsetSearch(is,value,&pos)) {
            if (success) *success = 0;
            return is;
        }
    
    
        // 为 value 在集合中分配空间
        is = intsetResize(is,intrev32ifbe(is->length)+1);
        //移动位置
        if (pos < intrev32ifbe(is->length)) intsetMoveTail(is,pos,pos+1);
    }

    // 将新值设置到底层数组的指定位置中
    _intsetSet(is,pos,value);

    // 增一集合元素数量的计数器
    is->length = intrev32ifbe(intrev32ifbe(is->length)+1);

    // 返回添加新元素后的整数集合
    return is;

 
}


//将原来的数组类型改变的同时，插入给定的元素
static intset *intsetUpgradeAndAdd(intset *is, int64_t value) {
    
    // 当前的编码方式
    uint8_t curenc = intrev32ifbe(is->encoding);

    // 新值所需的编码方式
    uint8_t newenc = _intsetValueEncoding(value);

    // 当前集合的元素数量
    int length = intrev32ifbe(is->length);

 	//由于进入了这个函数，说明value的类型相对于原数组来说是升级了
 	//所以，value的值一定大于或是原数组里的所有值
 	//所以当prepend = 1时说明在首部，prepend = 0在尾部
    int prepend = value < 0 ? 1 : 0;

   
    // 更新集合的编码方式
    is->encoding = intrev32ifbe(newenc);
    // T = O(N)
    is = intsetResize(is,intrev32ifbe(is->length)+1);

    while(length--)
        _intsetSet(is,length+prepend,_intsetGetEncoded(is,length,curenc));

    /* Set the value at the beginning or the end. */
    // 设置新值，根据 prepend 的值来决定是添加到数组头还是数组尾
    if (prepend)
        _intsetSet(is,0,value);
    else
        _intsetSet(is,intrev32ifbe(is->length),value);

    // 更新整数集合的元素数量
    is->length = intrev32ifbe(intrev32ifbe(is->length)+1);

    return is;
}

static void _intsetSet(intset *is, int pos, int64_t value) {

    // 取出集合的编码方式
    uint32_t encoding = intrev32ifbe(is->encoding);

    // 根据编码 ((Enc_t*)is->contents) 将数组转换回正确的类型
    // 然后 ((Enc_t*)is->contents)[pos] 定位到数组索引上
    // 接着 ((Enc_t*)is->contents)[pos] = value 将值赋给数组
    // 最后， ((Enc_t*)is->contents)+pos 定位到刚刚设置的新值上 
    // 如果有需要的话， memrevEncifbe 将对值进行大小端转换
    if (encoding == INTSET_ENC_INT64) {
        ((int64_t*)is->contents)[pos] = value;
        memrev64ifbe(((int64_t*)is->contents)+pos);
    } else if (encoding == INTSET_ENC_INT32) {
        ((int32_t*)is->contents)[pos] = value;
        memrev32ifbe(((int32_t*)is->contents)+pos);
    } else {
        ((int16_t*)is->contents)[pos] = value;
        memrev16ifbe(((int16_t*)is->contents)+pos);
    }
}

3.intsetRemove

intset *intsetRemove(intset *is, int64_t value, int *success) {

    // 计算 value 的编码方式
    uint8_t valenc = _intsetValueEncoding(value);
    uint32_t pos;

    // 默认设置标识值为删除失败
    if (success) *success = 0;

    // 当 value 的编码大小小于或等于集合的当前编码方式（说明 value 有可能存在于集合）
    // 并且 intsetSearch 的结果为真，那么执行删除
    if (valenc <= intrev32ifbe(is->encoding) && intsetSearch(is,value,&pos)) {

        // 取出集合当前的元素数量
        uint32_t len = intrev32ifbe(is->length);

        // 设置标识值为删除成功
        if (success) *success = 1;

        // 如果 value 不是位于数组的末尾
        // 那么需要对原本位于 value 之后的元素进行移动

        if (pos < (len-1)) intsetMoveTail(is,pos+1,pos);
        // 缩小数组的大小，移除被删除元素占用的空间
        // T = O(N)
        is = intsetResize(is,len-1);
        // 更新集合的元素数量
        is->length = intrev32ifbe(len-1);
    }

    return is;
}

4.intsetFind

uint8_t intsetFind(intset *is, int64_t value) {

    // 计算 value 的编码
    uint8_t valenc = _intsetValueEncoding(value);

    // 如果 value 的编码大于集合的当前编码，那么 value 一定不存在于集合
    // 当 value 的编码小于等于集合的当前编码时，
    // 才再使用 intsetSearch 进行查找
    return valenc <= intrev32ifbe(is->encoding) && intsetSearch(is,value,NULL);
}

5.intsetRandom

int64_t intsetRandom(intset *is) {  //获得一个随机值

    return _intsetGet(is,rand()%intrev32ifbe(is->length));
}

6.intsetGet

//获得pos位置的值并且保存到value中
uint8_t intsetGet(intset *is, uint32_t pos, int64_t *value) {

    // pos < intrev32ifbe(is->length) 
    // 检查 pos 是否符合数组的范围
    if (pos < intrev32ifbe(is->length)) {

        // 保存值到指针
        *value = _intsetGet(is,pos);

        // 返回成功指示值
        return 1;
    }

    // 超出索引范围
    return 0;
}

参考《Redis设计与实习》