commonMain.implementations.immutableSet.TrieNode.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlinx-collections-immutable-jvm Show documentation
Show all versions of kotlinx-collections-immutable-jvm Show documentation
Kotlin Immutable Collections multiplatform library
/*
* Copyright 2016-2019 JetBrains s.r.o.
* Use of this source code is governed by the Apache 2.0 License that can be found in the LICENSE.txt file.
*/
package kotlinx.collections.immutable.implementations.immutableSet
import kotlinx.collections.immutable.internal.DeltaCounter
import kotlinx.collections.immutable.internal.MutabilityOwnership
import kotlinx.collections.immutable.internal.assert
import kotlinx.collections.immutable.internal.forEachOneBit
internal const val MAX_BRANCHING_FACTOR = 32
internal const val LOG_MAX_BRANCHING_FACTOR = 5
internal const val MAX_BRANCHING_FACTOR_MINUS_ONE = MAX_BRANCHING_FACTOR - 1
internal const val MAX_SHIFT = 30
/**
* Gets trie index segment of the specified [index] at the level specified by [shift].
*
* `shift` equal to zero corresponds to the root level.
* For each lower level `shift` increments by [LOG_MAX_BRANCHING_FACTOR].
*/
internal fun indexSegment(index: Int, shift: Int): Int =
(index shr shift) and MAX_BRANCHING_FACTOR_MINUS_ONE
private fun Array.addElementAtIndex(index: Int, element: E): Array {
val newBuffer = arrayOfNulls(this.size + 1)
this.copyInto(newBuffer, endIndex = index)
this.copyInto(newBuffer, index + 1, index, this.size)
newBuffer[index] = element
return newBuffer
}
private fun Array.removeCellAtIndex(cellIndex: Int): Array {
val newBuffer = arrayOfNulls(this.size - 1)
this.copyInto(newBuffer, endIndex = cellIndex)
this.copyInto(newBuffer, cellIndex, cellIndex + 1, this.size)
return newBuffer
}
/**
* Writes all elements from [this] to [newArray], starting with [newArrayOffset], filtering
* on the fly using [predicate]. By default filters out [TrieNode.EMPTY] instances
*
* return number of elements written to [newArray]
**/
private inline fun Array.filterTo(
newArray: Array,
newArrayOffset: Int = 0,
predicate: (Any?) -> Boolean = { it !== TrieNode.EMPTY }): Int {
var i = 0
var j = 0
while (i < size) {
assert(j <= i) // this is extremely important if newArray === this
val e = this[i]
if (predicate(e)) {
newArray[newArrayOffset + j] = this[i]
++j
assert(newArrayOffset + j <= newArray.size)
}
++i
}
return j
}
internal class TrieNode(
var bitmap: Int,
var buffer: Array,
var ownedBy: MutabilityOwnership?
) {
constructor(bitmap: Int, buffer: Array) : this(bitmap, buffer, null)
// here and later:
// positionMask — an int in form 2^n, i.e. having the single bit set, whose ordinal is a logical position in buffer
private fun hasNoCellAt(positionMask: Int): Boolean {
return bitmap and positionMask == 0
}
internal fun indexOfCellAt(positionMask: Int): Int {
return (bitmap and (positionMask - 1)).countOneBits()
}
private fun elementAtIndex(index: Int): E {
@Suppress("UNCHECKED_CAST")
return buffer[index] as E
}
private fun nodeAtIndex(index: Int): TrieNode {
@Suppress("UNCHECKED_CAST")
return buffer[index] as TrieNode
}
private fun addElementAt(positionMask: Int, element: E): TrieNode {
// assert(hasNoCellAt(positionMask))
val index = indexOfCellAt(positionMask)
val newBuffer = buffer.addElementAtIndex(index, element)
return TrieNode(bitmap or positionMask, newBuffer)
}
private fun mutableAddElementAt(positionMask: Int, element: E, owner: MutabilityOwnership): TrieNode {
// assert(hasNoCellAt(positionMask))
val index = indexOfCellAt(positionMask)
if (ownedBy === owner) {
buffer = buffer.addElementAtIndex(index, element)
bitmap = bitmap or positionMask
return this
}
val newBuffer = buffer.addElementAtIndex(index, element)
return TrieNode(bitmap or positionMask, newBuffer, owner)
}
/** The given [newNode] must not be a part of any persistent set instance. */
private fun updateNodeAtIndex(nodeIndex: Int, newNode: TrieNode): TrieNode {
// assert(buffer[nodeIndex] !== newNode)
val cell: Any?
val newNodeBuffer = newNode.buffer
if (newNodeBuffer.size == 1 && newNodeBuffer[0] !is TrieNode<*>) {
if (buffer.size == 1) {
newNode.bitmap = bitmap
return newNode
}
cell = newNodeBuffer[0]
} else {
cell = newNode
}
val newBuffer = buffer.copyOf()
newBuffer[nodeIndex] = cell
return TrieNode(bitmap, newBuffer)
}
/** The given [newNode] must not be a part of any persistent set instance. */
private fun mutableUpdateNodeAtIndex(nodeIndex: Int, newNode: TrieNode, owner: MutabilityOwnership): TrieNode {
// assert(buffer[nodeIndex] !== newNode)
val cell: Any?
val newNodeBuffer = newNode.buffer
if (newNodeBuffer.size == 1 && newNodeBuffer[0] !is TrieNode<*>) {
if (buffer.size == 1) {
newNode.bitmap = bitmap
return newNode
}
cell = newNodeBuffer[0]
} else {
cell = newNode
}
if (ownedBy === owner) {
buffer[nodeIndex] = cell
return this
}
val newBuffer = buffer.copyOf()
newBuffer[nodeIndex] = cell
return TrieNode(bitmap, newBuffer, owner)
}
private fun makeNodeAtIndex(elementIndex: Int, newElementHash: Int, newElement: E,
shift: Int, owner: MutabilityOwnership?): TrieNode {
val storedElement = elementAtIndex(elementIndex)
return makeNode(storedElement.hashCode(), storedElement,
newElementHash, newElement, shift + LOG_MAX_BRANCHING_FACTOR, owner)
}
private fun moveElementToNode(elementIndex: Int, newElementHash: Int, newElement: E,
shift: Int): TrieNode {
val newBuffer = buffer.copyOf()
newBuffer[elementIndex] = makeNodeAtIndex(elementIndex, newElementHash, newElement, shift, null)
return TrieNode(bitmap, newBuffer)
}
private fun mutableMoveElementToNode(elementIndex: Int, newElementHash: Int, newElement: E,
shift: Int, owner: MutabilityOwnership): TrieNode {
if (ownedBy === owner) {
buffer[elementIndex] = makeNodeAtIndex(elementIndex, newElementHash, newElement, shift, owner)
return this
}
val newBuffer = buffer.copyOf()
newBuffer[elementIndex] = makeNodeAtIndex(elementIndex, newElementHash, newElement, shift, owner)
return TrieNode(bitmap, newBuffer, owner)
}
private fun makeNode(elementHash1: Int, element1: E, elementHash2: Int, element2: E,
shift: Int, owner: MutabilityOwnership?): TrieNode {
if (shift > MAX_SHIFT) {
// assert(element1 != element2)
// when two element hashes are entirely equal: the last level subtrie node stores them just as unordered list
return TrieNode(0, arrayOf(element1, element2), owner)
}
val setBit1 = indexSegment(elementHash1, shift)
val setBit2 = indexSegment(elementHash2, shift)
if (setBit1 != setBit2) {
val nodeBuffer = if (setBit1 < setBit2) {
arrayOf(element1, element2)
} else {
arrayOf(element2, element1)
}
return TrieNode((1 shl setBit1) or (1 shl setBit2), nodeBuffer, owner)
}
// hash segments at the given shift are equal: move these elements into the subtrie
val node = makeNode(elementHash1, element1, elementHash2, element2, shift + LOG_MAX_BRANCHING_FACTOR, owner)
return TrieNode(1 shl setBit1, arrayOf(node), owner)
}
private fun removeCellAtIndex(cellIndex: Int, positionMask: Int): TrieNode {
// assert(!hasNoCellAt(positionMask))
// assert(buffer.size > 1) can be false only for the root node
val newBuffer = buffer.removeCellAtIndex(cellIndex)
return TrieNode(bitmap xor positionMask, newBuffer)
}
private fun mutableRemoveCellAtIndex(cellIndex: Int, positionMask: Int, owner: MutabilityOwnership): TrieNode {
// assert(!hasNoCellAt(positionMask))
// assert(buffer.size > 1)
if (ownedBy === owner) {
buffer = buffer.removeCellAtIndex(cellIndex)
bitmap = bitmap xor positionMask
return this
}
val newBuffer = buffer.removeCellAtIndex(cellIndex)
return TrieNode(bitmap xor positionMask, newBuffer, owner)
}
private fun collisionRemoveElementAtIndex(i: Int): TrieNode {
val newBuffer = buffer.removeCellAtIndex(i)
return TrieNode(0, newBuffer)
}
private fun mutableCollisionRemoveElementAtIndex(i: Int, owner: MutabilityOwnership): TrieNode {
if (ownedBy === owner) {
buffer = buffer.removeCellAtIndex(i)
return this
}
val newBuffer = buffer.removeCellAtIndex(i)
return TrieNode(0, newBuffer, owner)
}
private fun collisionContainsElement(element: E): Boolean {
return buffer.contains(element)
}
private fun collisionAdd(element: E): TrieNode {
if (collisionContainsElement(element)) return this
val newBuffer = buffer.addElementAtIndex(0, element)
return TrieNode(0, newBuffer)
}
private fun mutableCollisionAdd(element: E, mutator: PersistentHashSetBuilder<*>): TrieNode {
if (collisionContainsElement(element)) return this
mutator.size++
if (ownedBy === mutator.ownership) {
buffer = buffer.addElementAtIndex(0, element)
return this
}
val newBuffer = buffer.addElementAtIndex(0, element)
return TrieNode(0, newBuffer, mutator.ownership)
}
private fun collisionRemove(element: E): TrieNode {
val index = buffer.indexOf(element)
if (index != -1) {
return collisionRemoveElementAtIndex(index)
}
return this
}
private fun mutableCollisionRemove(element: E, mutator: PersistentHashSetBuilder<*>): TrieNode {
val index = buffer.indexOf(element)
if (index != -1) {
mutator.size--
return mutableCollisionRemoveElementAtIndex(index, mutator.ownership)
}
return this
}
private fun mutableCollisionAddAll(otherNode: TrieNode,
intersectionSizeRef: DeltaCounter,
owner: MutabilityOwnership): TrieNode {
if (this === otherNode) {
intersectionSizeRef += buffer.size
return this
}
val tempBuffer = this.buffer.copyOf(newSize = this.buffer.size + otherNode.buffer.size)
val totalWritten = otherNode.buffer.filterTo(tempBuffer, newArrayOffset = this.buffer.size) {
@Suppress("UNCHECKED_CAST")
!this.collisionContainsElement(it as E)
}
val totalSize = totalWritten + this.buffer.size
intersectionSizeRef += (tempBuffer.size - totalSize)
if (totalSize == this.buffer.size) return this
if (totalSize == otherNode.buffer.size) return otherNode
val newBuffer = if (totalSize == tempBuffer.size) tempBuffer else tempBuffer.copyOf(newSize = totalSize)
return if (ownedBy == owner) {
this.buffer = newBuffer
this
} else {
TrieNode(0, newBuffer, owner)
}
}
private fun mutableCollisionRetainAll(otherNode: TrieNode, intersectionSizeRef: DeltaCounter,
owner: MutabilityOwnership): Any? {
if (this === otherNode) {
intersectionSizeRef += buffer.size
return this
}
val tempBuffer =
if (owner == ownedBy) buffer
else arrayOfNulls(minOf(buffer.size, otherNode.buffer.size))
val totalWritten = buffer.filterTo(tempBuffer) {
@Suppress("UNCHECKED_CAST")
otherNode.collisionContainsElement(it as E)
}
intersectionSizeRef += totalWritten
return when (totalWritten) {
0 -> EMPTY
1 -> tempBuffer[0]
this.buffer.size -> this
otherNode.buffer.size -> otherNode
tempBuffer.size -> TrieNode(0, tempBuffer, owner)
else -> TrieNode(0, tempBuffer.copyOf(newSize = totalWritten), owner)
}
}
private fun mutableCollisionRemoveAll(otherNode: TrieNode,
intersectionSizeRef: DeltaCounter,
owner: MutabilityOwnership): Any? {
if (this === otherNode) {
intersectionSizeRef += buffer.size
return EMPTY
}
val tempBuffer = if (owner == ownedBy) buffer else arrayOfNulls(buffer.size)
val totalWritten = buffer.filterTo(tempBuffer) {
@Suppress("UNCHECKED_CAST")
!otherNode.collisionContainsElement(it as E)
}
intersectionSizeRef += (buffer.size - totalWritten)
return when (totalWritten) {
0 -> EMPTY
1 -> tempBuffer[0]
this.buffer.size -> this
tempBuffer.size -> TrieNode(0, tempBuffer, owner)
else -> TrieNode(0, tempBuffer.copyOf(newSize = totalWritten), owner)
}
}
private fun calculateSize(): Int {
if (bitmap == 0) return buffer.size
var result = 0
for (e in buffer) {
result += when (e) {
is TrieNode<*> -> e.calculateSize()
else -> 1
}
}
return result
}
private fun elementsIdentityEquals(otherNode: TrieNode): Boolean {
if (this === otherNode) return true
if (bitmap != otherNode.bitmap) return false
for (i in 0 until buffer.size) {
if (buffer[i] !== otherNode.buffer[i]) return false
}
return true
}
fun contains(elementHash: Int, element: E, shift: Int): Boolean {
val cellPositionMask = 1 shl indexSegment(elementHash, shift)
if (hasNoCellAt(cellPositionMask)) { // element is absent
return false
}
val cellIndex = indexOfCellAt(cellPositionMask)
if (buffer[cellIndex] is TrieNode<*>) { // element may be in node
val targetNode = nodeAtIndex(cellIndex)
if (shift == MAX_SHIFT) {
return targetNode.collisionContainsElement(element)
}
return targetNode.contains(elementHash, element, shift + LOG_MAX_BRANCHING_FACTOR)
}
// element is directly in buffer
return element == buffer[cellIndex]
}
fun mutableAddAll(otherNode: TrieNode,
shift: Int,
intersectionSizeRef: DeltaCounter,
mutator: PersistentHashSetBuilder<*>): TrieNode {
if (this === otherNode) {
intersectionSizeRef.count += this.calculateSize()
return this
}
if (shift > MAX_SHIFT) {
return mutableCollisionAddAll(otherNode, intersectionSizeRef, mutator.ownership)
}
// union mask contains all the bits from input masks
val newBitMap = bitmap or otherNode.bitmap
// first allocate the node and then fill it in
// we are doing a union, so all the array elements are guaranteed to exist
val mutableNode = when {
newBitMap == bitmap && ownedBy == mutator.ownership -> this
else -> TrieNode(newBitMap, arrayOfNulls(newBitMap.countOneBits()), mutator.ownership)
}
// for each bit set in the resulting mask,
// either left, right or both masks contain the same bit
// Note: we shouldn't overrun MAX_SHIFT because both sides are correct TrieNodes, right?
newBitMap.forEachOneBit { positionMask, newNodeIndex ->
val thisIndex = indexOfCellAt(positionMask)
val otherNodeIndex = otherNode.indexOfCellAt(positionMask)
mutableNode.buffer[newNodeIndex] = when {
// no element on left -> pick right
hasNoCellAt(positionMask) -> otherNode.buffer[otherNodeIndex]
// no element on right -> pick left
otherNode.hasNoCellAt(positionMask) -> buffer[thisIndex]
// both nodes contain something at the masked bit
else -> {
val thisCell = buffer[thisIndex]
val otherNodeCell = otherNode.buffer[otherNodeIndex]
val thisIsNode = thisCell is TrieNode<*>
val otherIsNode = otherNodeCell is TrieNode<*>
when {
// both are nodes -> merge them recursively
thisIsNode && otherIsNode -> @Suppress("UNCHECKED_CAST") {
thisCell as TrieNode
otherNodeCell as TrieNode
thisCell.mutableAddAll(
otherNodeCell,
shift + LOG_MAX_BRANCHING_FACTOR,
intersectionSizeRef,
mutator
)
}
// one of them is a node -> add the other one to it
thisIsNode -> @Suppress("UNCHECKED_CAST") {
thisCell as TrieNode
otherNodeCell as E
val oldSize = mutator.size
thisCell.mutableAdd(
otherNodeCell.hashCode(),
otherNodeCell,
shift + LOG_MAX_BRANCHING_FACTOR,
mutator
).also {
if (mutator.size == oldSize) intersectionSizeRef.count++
}
}
// same as last case, but reversed
otherIsNode -> @Suppress("UNCHECKED_CAST") {
otherNodeCell as TrieNode
thisCell as E
val oldSize = mutator.size
otherNodeCell.mutableAdd(
thisCell.hashCode(),
thisCell,
shift + LOG_MAX_BRANCHING_FACTOR,
mutator
).also {
if (mutator.size == oldSize) intersectionSizeRef.count++
}
}
// both are just E => compare them
thisCell == otherNodeCell -> thisCell.also { intersectionSizeRef.count++ }
// both are just E, but different => make a collision-ish node
else -> @Suppress("UNCHECKED_CAST") {
thisCell as E
otherNodeCell as E
makeNode(
thisCell.hashCode(),
thisCell,
otherNodeCell.hashCode(),
otherNodeCell,
shift + LOG_MAX_BRANCHING_FACTOR,
mutator.ownership
)
}
}
}
}
}
return when {
this.elementsIdentityEquals(mutableNode) -> this
otherNode.elementsIdentityEquals(mutableNode) -> otherNode
else -> mutableNode
}
}
fun mutableRetainAll(otherNode: TrieNode,
shift: Int,
intersectionSizeRef: DeltaCounter,
mutator: PersistentHashSetBuilder<*>): Any? {
if (this === otherNode) {
intersectionSizeRef += calculateSize();
return this
}
if (shift > MAX_SHIFT) {
return mutableCollisionRetainAll(otherNode, intersectionSizeRef, mutator.ownership)
}
// intersection mask contains bits that are set in both inputs
// this mask is not final 'cos some children may have no intersection
val newBitMap = bitmap and otherNode.bitmap
// zero means no nodes intersect
if (newBitMap == 0) return EMPTY
val mutableNode =
if (ownedBy == mutator.ownership && newBitMap == bitmap) this
else TrieNode(newBitMap, arrayOfNulls(newBitMap.countOneBits()), mutator.ownership)
// we need to keep track of the real mask 'cos some of the children may intersect to nothing
var realBitMap = 0
// for each bit in intersection mask, try to intersect children
newBitMap.forEachOneBit { positionMask, newNodeIndex ->
val thisIndex = indexOfCellAt(positionMask)
val otherNodeIndex = otherNode.indexOfCellAt(positionMask)
val newValue = run {
val thisCell = buffer[thisIndex]
val otherNodeCell = otherNode.buffer[otherNodeIndex]
val thisIsNode = thisCell is TrieNode<*>
val otherIsNode = otherNodeCell is TrieNode<*>
when {
// both are nodes -> merge them recursively
thisIsNode && otherIsNode -> @Suppress("UNCHECKED_CAST") {
thisCell as TrieNode
otherNodeCell as TrieNode
thisCell.mutableRetainAll(
otherNodeCell,
shift + LOG_MAX_BRANCHING_FACTOR,
intersectionSizeRef,
mutator
)
}
// one of them is a node -> check containment
thisIsNode -> @Suppress("UNCHECKED_CAST") {
thisCell as TrieNode
otherNodeCell as E
if (thisCell.contains(otherNodeCell.hashCode(), otherNodeCell, shift + LOG_MAX_BRANCHING_FACTOR)) {
intersectionSizeRef += 1
otherNodeCell
} else EMPTY
}
// same as last case, but reversed
otherIsNode -> @Suppress("UNCHECKED_CAST") {
otherNodeCell as TrieNode
thisCell as E
if (otherNodeCell.contains(thisCell.hashCode(), thisCell, shift + LOG_MAX_BRANCHING_FACTOR)) {
intersectionSizeRef += 1
thisCell
} else EMPTY
}
// both are just E => compare them
thisCell == otherNodeCell -> thisCell.also { intersectionSizeRef += 1 }
// both are just E, but different => return nothing
else -> EMPTY
}
}
if (newValue !== EMPTY) {
// elements that are not in realBitMap will be removed later
realBitMap = realBitMap or positionMask
}
mutableNode.buffer[newNodeIndex] = newValue
}
// resulting array's size is the popcount of resulting mask
val realSize = realBitMap.countOneBits()
return when {
realBitMap == 0 -> EMPTY
realBitMap == newBitMap -> {
when {
mutableNode.elementsIdentityEquals(this) -> this
mutableNode.elementsIdentityEquals(otherNode) -> otherNode
else -> mutableNode
}
}
// single values are kept only on root level
realSize == 1 && shift != 0 -> when (val single = mutableNode.buffer[mutableNode.indexOfCellAt(realBitMap)]) {
is TrieNode<*> -> TrieNode(realBitMap, arrayOf(single), mutator.ownership)
else -> single
}
else -> {
// clean up all the EMPTYs in the resulting buffer
val realBuffer = arrayOfNulls(realSize)
mutableNode.buffer.filterTo(realBuffer)
TrieNode(realBitMap, realBuffer, mutator.ownership)
}
}
}
fun mutableRemoveAll(otherNode: TrieNode, shift: Int,
intersectionSizeRef: DeltaCounter,
mutator: PersistentHashSetBuilder<*>): Any? {
if (this === otherNode) {
intersectionSizeRef += calculateSize();
return EMPTY
}
if (shift > MAX_SHIFT) {
return mutableCollisionRemoveAll(otherNode, intersectionSizeRef, mutator.ownership)
}
// same as with intersection, only children of both nodes are considered
// this mask is not final 'cos some children may have no intersection
val removalBitmap = bitmap and otherNode.bitmap
// zero means no intersection => nothing to remove
if (removalBitmap == 0) return this
// node here is either us (if we are mutable) or a mutable copy
val mutableNode =
if (ownedBy == mutator.ownership) this
else TrieNode(bitmap, buffer.copyOf(), mutator.ownership)
// keep track of the real mask
var realBitMap = bitmap
removalBitmap.forEachOneBit { positionMask, _ ->
val thisIndex = indexOfCellAt(positionMask)
val otherNodeIndex = otherNode.indexOfCellAt(positionMask)
val newValue = run {
val thisCell = buffer[thisIndex]
val otherNodeCell = otherNode.buffer[otherNodeIndex]
val thisIsNode = thisCell is TrieNode<*>
val otherIsNode = otherNodeCell is TrieNode<*>
when {
// both are nodes -> merge them recursively
thisIsNode && otherIsNode -> @Suppress("UNCHECKED_CAST") {
thisCell as TrieNode
otherNodeCell as TrieNode
thisCell.mutableRemoveAll(
otherNodeCell,
shift + LOG_MAX_BRANCHING_FACTOR,
intersectionSizeRef,
mutator
)
}
// one of them is a node -> remove single element
thisIsNode -> @Suppress("UNCHECKED_CAST") {
thisCell as TrieNode
otherNodeCell as E
val oldSize = mutator.size
val removed = thisCell.mutableRemove(
otherNodeCell.hashCode(),
otherNodeCell,
shift + LOG_MAX_BRANCHING_FACTOR,
mutator)
// additional check needed for removal
if (oldSize != mutator.size) {
intersectionSizeRef += 1
if (removed.buffer.size == 1 && removed.buffer[0] !is TrieNode<*>) removed.buffer[0]
else removed
} else thisCell
}
// same as last case, but reversed
otherIsNode -> @Suppress("UNCHECKED_CAST") {
otherNodeCell as TrieNode
thisCell as E
// "removing" a node from a value is basically checking if the value is contained in the node
if (otherNodeCell.contains(thisCell.hashCode(), thisCell, shift + LOG_MAX_BRANCHING_FACTOR)) {
intersectionSizeRef += 1
EMPTY
} else thisCell
}
// both are just E => compare them
thisCell == otherNodeCell -> {
intersectionSizeRef += 1
EMPTY
}
// both are just E, but different => nothing to remove, return left
else -> thisCell
}
}
if (newValue === EMPTY) {
// if we removed something, keep track
realBitMap = realBitMap xor positionMask
}
mutableNode.buffer[thisIndex] = newValue
}
// resulting size is popcount of the resulting mask
val realSize = realBitMap.countOneBits()
return when {
realBitMap == 0 -> EMPTY
realBitMap == bitmap -> {
when {
mutableNode.elementsIdentityEquals(this) -> this
else -> mutableNode
}
}
// single values are kept only on root level
realSize == 1 && shift != 0 -> when (val single = mutableNode.buffer[mutableNode.indexOfCellAt(realBitMap)]) {
is TrieNode<*> -> TrieNode(realBitMap, arrayOf(single), mutator.ownership)
else -> single
}
else -> {
// clean up all the EMPTYs in the resulting buffer
val realBuffer = arrayOfNulls(realSize)
mutableNode.buffer.filterTo(realBuffer)
TrieNode(realBitMap, realBuffer, mutator.ownership)
}
}
}
fun containsAll(otherNode: TrieNode, shift: Int): Boolean {
if (this === otherNode) return true
// essentially `buffer.containsAll(otherNode.buffer)`
if (shift > MAX_SHIFT) return otherNode.buffer.all { it in buffer }
// potential bitmap is an intersection of input bitmaps
val potentialBitMap = bitmap and otherNode.bitmap
// left bitmap must contain right bitmap => right bitmap must be equal to intersection
if (potentialBitMap != otherNode.bitmap) return false
// check each child, shortcut to false if any one isn't contained
potentialBitMap.forEachOneBit { positionMask, _ ->
val thisIndex = indexOfCellAt(positionMask)
val otherNodeIndex = otherNode.indexOfCellAt(positionMask)
val thisCell = buffer[thisIndex]
val otherNodeCell = otherNode.buffer[otherNodeIndex]
val thisIsNode = thisCell is TrieNode<*>
val otherIsNode = otherNodeCell is TrieNode<*>
when {
// both are nodes => check recursively
thisIsNode && otherIsNode -> @Suppress("UNCHECKED_CAST") {
thisCell as TrieNode
otherNodeCell as TrieNode
thisCell.containsAll(otherNodeCell, shift + LOG_MAX_BRANCHING_FACTOR) || return false
}
// left is node, right is just E => check containment
thisIsNode -> @Suppress("UNCHECKED_CAST") {
thisCell as TrieNode
otherNodeCell as E
thisCell.contains(otherNodeCell.hashCode(), otherNodeCell, shift + LOG_MAX_BRANCHING_FACTOR) || return false
}
// left is just E, right is node => not possible
otherIsNode -> return false
// both are just E => containment is just equality
else -> thisCell == otherNodeCell || return false
}
}
return true
}
fun add(elementHash: Int, element: E, shift: Int): TrieNode {
val cellPositionMask = 1 shl indexSegment(elementHash, shift)
if (hasNoCellAt(cellPositionMask)) { // element is absent
return addElementAt(cellPositionMask, element)
}
val cellIndex = indexOfCellAt(cellPositionMask)
if (buffer[cellIndex] is TrieNode<*>) { // element may be in node
val targetNode = nodeAtIndex(cellIndex)
val newNode = if (shift == MAX_SHIFT) {
targetNode.collisionAdd(element)
} else {
targetNode.add(elementHash, element, shift + LOG_MAX_BRANCHING_FACTOR)
}
if (targetNode === newNode) return this
return updateNodeAtIndex(cellIndex, newNode)
}
// element is directly in buffer
if (element == buffer[cellIndex]) return this
return moveElementToNode(cellIndex, elementHash, element, shift)
}
fun mutableAdd(elementHash: Int, element: E, shift: Int, mutator: PersistentHashSetBuilder<*>): TrieNode {
val cellPosition = 1 shl indexSegment(elementHash, shift)
if (hasNoCellAt(cellPosition)) { // element is absent
mutator.size++
return mutableAddElementAt(cellPosition, element, mutator.ownership)
}
val cellIndex = indexOfCellAt(cellPosition)
if (buffer[cellIndex] is TrieNode<*>) { // element may be in node
val targetNode = nodeAtIndex(cellIndex)
val newNode = if (shift == MAX_SHIFT) {
targetNode.mutableCollisionAdd(element, mutator)
} else {
targetNode.mutableAdd(elementHash, element, shift + LOG_MAX_BRANCHING_FACTOR, mutator)
}
if (targetNode === newNode) return this
return mutableUpdateNodeAtIndex(cellIndex, newNode, mutator.ownership)
}
// element is directly in buffer
if (element == buffer[cellIndex]) return this
mutator.size++
return mutableMoveElementToNode(cellIndex, elementHash, element, shift, mutator.ownership)
}
fun remove(elementHash: Int, element: E, shift: Int): TrieNode {
val cellPositionMask = 1 shl indexSegment(elementHash, shift)
if (hasNoCellAt(cellPositionMask)) { // element is absent
return this
}
val cellIndex = indexOfCellAt(cellPositionMask)
if (buffer[cellIndex] is TrieNode<*>) { // element may be in node
val targetNode = nodeAtIndex(cellIndex)
val newNode = if (shift == MAX_SHIFT) {
targetNode.collisionRemove(element)
} else {
targetNode.remove(elementHash, element, shift + LOG_MAX_BRANCHING_FACTOR)
}
if (targetNode === newNode) return this
return updateNodeAtIndex(cellIndex, newNode)
}
// element is directly in buffer
if (element == buffer[cellIndex]) {
return removeCellAtIndex(cellIndex, cellPositionMask)
}
return this
}
fun mutableRemove(elementHash: Int, element: E, shift: Int, mutator: PersistentHashSetBuilder<*>): TrieNode {
val cellPositionMask = 1 shl indexSegment(elementHash, shift)
if (hasNoCellAt(cellPositionMask)) { // element is absent
return this
}
val cellIndex = indexOfCellAt(cellPositionMask)
if (buffer[cellIndex] is TrieNode<*>) { // element may be in node
val targetNode = nodeAtIndex(cellIndex)
val newNode = if (shift == MAX_SHIFT) {
targetNode.mutableCollisionRemove(element, mutator)
} else {
targetNode.mutableRemove(elementHash, element, shift + LOG_MAX_BRANCHING_FACTOR, mutator)
}
if (ownedBy === mutator.ownership || targetNode !== newNode) {
return mutableUpdateNodeAtIndex(cellIndex, newNode, mutator.ownership)
}
return this
}
// element is directly in buffer
if (element == buffer[cellIndex]) {
mutator.size--
return mutableRemoveCellAtIndex(cellIndex, cellPositionMask, mutator.ownership) // check is empty
}
return this
}
internal companion object {
internal val EMPTY = TrieNode(0, emptyArray())
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy