Sentinel-11: linearizability comment thru #11
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| func bitsetIndex(pos uint) (uint, uint) { | ||
| return pos / 64, pos % 64 | ||
| } | ||
|
|
||
| // set sets the bit at the specified position to 1. | ||
| func (b bitset) set(pos uint) bitset { |
There was a problem hiding this comment.
Consider returning an error if the pos is out of range instead of silently failing.
| func (b bitset) set(pos uint) bitset { | ||
| major, minor := bitsetIndex(pos) | ||
| b[major] |= (1 << minor) | ||
| return b | ||
| } | ||
|
|
||
| // clear sets the bit at the specified position to 0. | ||
| func (b bitset) clear(pos uint) bitset { |
There was a problem hiding this comment.
Consider returning an error if the pos is out of range instead of silently failing.
| func (b bitset) clear(pos uint) bitset { | ||
| major, minor := bitsetIndex(pos) | ||
| b[major] &^= (1 << minor) | ||
| return b | ||
| } | ||
|
|
||
| // get returns true if the bit at the specified position is 1. | ||
| func (b bitset) get(pos uint) bool { |
There was a problem hiding this comment.
Consider returning an error if the pos is out of range instead of silently failing.
| // data layout: | ||
| // bits 0-63 are in data[0], the next are in data[1], etc. | ||
|
|
||
| // newBitset creates a new bitset with a specified number of bits. | ||
| func newBitset(bits uint) bitset { |
There was a problem hiding this comment.
Consider renaming the bits parameter to numBits or bitCount for clarity.
| if bits%64 != 0 { | ||
| extra = 1 | ||
| } | ||
| // Calculate total number of 64-bit chunks needed. | ||
| chunks := bits/64 + extra |
There was a problem hiding this comment.
Consider using math.Ceil function to calculate the number of chunks. This would make the code more readable and eliminate the need for the extra variable.
| Step func(state interface{}, input interface{}, output interface{}) (bool, interface{}) | ||
| // Equality on states. | ||
|
|
||
| // Equal function defines equality for states. |
There was a problem hiding this comment.
Consider renaming the Equal function to AreStatesEqual for better readability and understanding.
| Equal func(state1, state2 interface{}) bool | ||
| } | ||
|
|
||
| // NoPartition is a default partitioning function that treats the entire history as a single partition. |
There was a problem hiding this comment.
Consider renaming the NoPartition function to SinglePartition for better readability and understanding.
| func NoPartition(history []Operation) [][]Operation { | ||
| return [][]Operation{history} | ||
| } | ||
|
|
||
| // NoPartitionEvent is a default partitioning function for event histories, treating the entire history as a single partition. | ||
| func NoPartitionEvent(history []Event) [][]Event { |
There was a problem hiding this comment.
Consider renaming the NoPartitionEvent function to SinglePartitionEvent for better readability and understanding.
| func NoPartitionEvent(history []Event) [][]Event { | ||
| return [][]Event{history} | ||
| } | ||
|
|
||
| // ShallowEqual is a default equality function that checks for basic equality between two states. | ||
| func ShallowEqual(state1, state2 interface{}) bool { |
There was a problem hiding this comment.
Consider renaming the ShallowEqual function to AreStatesShallowEqual for better readability and understanding.
| return true, st + inp.Value | ||
| } | ||
| // Default case: should not happen in correct usage | ||
| return false, state |
There was a problem hiding this comment.
It's good to have a default case in the switch statement, but it would be better to handle it properly. Instead of just returning false, state, consider throwing an error or panic to indicate that an invalid operation type was provided.
None