Go roaring 原地集合运算与返回新位图有什么区别

Go roaring 里最容易被忽略的差别，不是 And 和 Or 的集合含义，而是结果写到哪里：a.And(b)、a.Or(b) 会修改接收者 a；roaring.And(a, b)、roaring.Or(a, b) 则返回一个新的 *Bitmap，适合保留原输入。要不要“原地”，取决于这两个位图是不是还要被别的逻辑继续使用。

先锁定两个 API 的修改边界

官方文档对方法的描述很直接：(*Bitmap).And 计算交集并把结果存入当前 Bitmap，(*Bitmap).Or 计算并集并把结果存入当前 Bitmap。也就是说，点号左边的变量就是被修改的对象。

包级函数的形态不同：roaring.And(x1, x2) 和 roaring.Or(x1, x2) 返回 *Bitmap。从调用约定上，应把它们当成“用两个输入得到一个结果”，不要把结果自动理解成第一个参数的别名。需要把原对象当作只读输入时，优先使用这种表达。

用最小示例对比 And 和 Or

下面把同一组输入分别交给两种写法。示例重点不是打印格式，而是观察变量在调用之后是否仍代表原集合。

package main

import (
    "fmt"

    "github.com/RoaringBitmap/roaring"
)

func main() {
    left := roaring.BitmapOf(1, 2, 3, 8)
    right := roaring.BitmapOf(2, 3, 5)

    // 接收者方法会把交集写回 left，调用后 left 只保留共同元素。
    inPlace := roaring.BitmapOf(1, 2, 3, 8)
    inPlace.And(right)
    fmt.Println("原地交集:", inPlace.ToArray())

    // 包级函数返回新的交集，left 和 right 仍可作为后续输入。
    intersection := roaring.And(left, right)
    fmt.Println("返回交集:", intersection.ToArray())
    fmt.Println("left 仍是:", left.ToArray())

    // Or 的选择规则相同：方法改接收者，包级函数留下输入并返回并集。
    union := roaring.Or(left, right)
    fmt.Println("返回并集:", union.ToArray())
}

在这个例子里，两种交集写法的集合内容可以相同，但对象生命周期不同：inPlace 被消耗成交集，left 仍然包含原始元素。并集也是同样的选择题；如果左侧位图代表缓存中的原始标签集合，直接调用 left.Or(right) 就会改变缓存语义。

处理共享指针与迁移风险

把原地方法从局部变量移到公共函数里，最容易出现“看起来只是优化，实际上改了调用方数据”的回归。Go 的 *Bitmap 传递的是对象指针：如果两个字段、缓存项或返回值指向同一个 Bitmap，那么对其中一个引用调用 And 或 Or，另一个引用看到的也是被修改后的内容。

需要原地算法的效率、但又不能改原对象时，先复制再修改：

func intersectForQuery(base, filter *roaring.Bitmap) *roaring.Bitmap {
    // 复制输入后再原地计算，避免改变调用方持有的 base。
    result := base.Clone()
    result.And(filter)
    return result
}

func mergeSnapshot(base, extra *roaring.Bitmap) *roaring.Bitmap {
    // 快照需要保留 base，所以把并集写入副本而不是共享对象。
    result := base.Clone()
    result.Or(extra)
    return result
}

如果没有明确的所有权协议，包级 roaring.And、roaring.Or 往往更容易读懂；如果已经约定“这个函数独占结果位图”，接收者方法可以减少一次中间对象表达。两者都不是绝对更快，选择应先服从对象所有权，再用基准测试比较。

建立回归检查和选择清单

迁移一段集合运算代码时，可以按下面的顺序检查，但不要把它误解成某个固定框架的测试模板：

测试时不要只断言最终结果。至少保留一份输入快照，在原地分支之后确认允许修改的对象发生了变化、禁止修改的对象没有变化；如果代码会在多个 goroutine 间共享 Bitmap，还要遵守库文档给出的同步要求，不能把“返回新位图”误当成对同一输入对象并发读写的通用保护。

常见问题

原地 And 和 roaring.And 的集合结果一定不同吗？

不一定。对相同输入，它们都可以得到交集；关键差异是结果写入当前对象还是返回新位图。

为了避免修改输入，是否必须先 Clone？

不一定。可以直接使用包级函数；如果业务更适合接收者方法，再先对需要保留的输入调用 Clone。

Or 也遵循同一条规则吗？

是。(*Bitmap).Or 把并集写回当前 Bitmap，roaring.Or 返回并集结果；迁移时检查的是对象所有权，而不是只看运算符名字。