crystal-lang / crystal

The Crystal Programming Language
https://crystal-lang.org
Apache License 2.0
19.2k stars 1.61k forks source link

Pointer equality for `Slice` #14720

Open straight-shoota opened 2 weeks ago

straight-shoota commented 2 weeks ago

Slice implements the equality operator == as structural equality, i.e. two instances are considered equal if they have equivalent content. Two instances are considered equal if they have the same values: Slice[1, 2, 3] == Slice[1, 2, 3] (or even just values expressing the same concept in different types: Slice[1.0, 2.0, 3.0] == Slice[1, 2, 3]).

There is no method for referential equality, i.e. if two instances pointing to the same memory. Slice is a struct type but it wraps a pointer, so it has semantics similar to a reference type. Referential equality would be similar to equality of the pointers, but checking size as well - Slice is a pointer plus size.

Usually this is implemented as #same? and I think this would work well for Slice.

slice = Slice[1, 2, 3]
slice.same?(slice)           # => true
slice.same? Slice[1, 2, 3]   # => false
slice.same?(slice + 1)       # => false
(slice + 1).same?(slice + 1) # => true
slice.same?(slice[0, 2])     # => false

Related to referential equality and the implementation of same? is also #object_id. For example Set is a struct type but behaves like a reference because it's a wrapper of an reference type. It implements both #same? and #object_id (which just delegate to the wrapped reference). This doesn't work for Slice because the wrapped pointer is not the only defining characteristic. Size is relevant as well. So I don't think #object_id makes sense for Slice because the pointer address is not unique. Two Slice instances can share the same pointer address, but with different sizes they would still be referentially unequal.

ysbaddaden commented 2 weeks ago

I think this example should be true instead of false?

slice == Slice[1, 2, 3]      # => false
straight-shoota commented 2 weeks ago

No, it's false. Slice[1, 2, 3] allocates new memory for its contents. So it has a different pointer than slice.

Doh šŸ¤¦ It should be same? instead of ==. Fixed.

HertzDevil commented 1 week ago

IIUC this alone won't let you use Slices in a compare-by-identity Hash yet, right?

straight-shoota commented 1 week ago

Correct. Compare by identity is based on object id and falls back to ==.