gitee.com/sy_183/go-common@v1.0.5-0.20231205030221-958cfe129b47/container/ordered-tree-map.go

package container

import "gitee.com/sy_183/go-common/generic"

type OrderedTreeMap[K generic.Ordered, V any] struct {
	entries []*TreeMapEntry[K, V]
	root    *TreeMapEntry[K, V]
	head    *TreeMapEntry[K, V]
	tail    *TreeMapEntry[K, V]
}

func NewOrderedTreeMap[K generic.Ordered, V any](entries int) *OrderedTreeMap[K, V] {
	m := &OrderedTreeMap[K, V]{
		entries: make([]*TreeMapEntry[K, V], entries),
	}
	m.init()
	return m
}

func (m *OrderedTreeMap[K, V]) init() {
	rawEntries := make([]TreeMapEntry[K, V], len(m.entries))
	for i := range rawEntries {
		m.entries[i] = &rawEntries[i]
	}
	m.entries = m.entries[:0]
}

func (m *OrderedTreeMap[K, V]) Init(cpr Comparator[K], entries int) {
	*m = OrderedTreeMap[K, V]{
		entries: make([]*TreeMapEntry[K, V], entries),
	}
	m.init()
}

func (m *OrderedTreeMap[K, V]) IsNil() bool {
	return m.entries == nil
}

func (m *OrderedTreeMap[K, V]) Len() int {
	return len(m.entries)
}

func (m *OrderedTreeMap[K, V]) Empty() bool {
	return len(m.entries) == 0
}

func (m *OrderedTreeMap[K, V]) getEntry(key K) *TreeMapEntry[K, V] {
	t := m.root
	if t == nil {
		return nil
	}
	for t != nil {
		if key < t.key {
			t = t.left
		} else if key > t.key {
			t = t.right
		} else {
			return t
		}
	}
	return nil
}

func (m *OrderedTreeMap[K, V]) Has(key K) bool {
	return m.getEntry(key) != nil
}

func (m *OrderedTreeMap[K, V]) Get(key K) (value V) {
	if e := m.getEntry(key); e != nil {
		return e.value
	}
	return
}

func (m *OrderedTreeMap[K, V]) GetEntry(key K) *TreeMapEntry[K, V] {
	return m.getEntry(key)
}

func (m *OrderedTreeMap[K, V]) Load(key K) (value V, exist bool) {
	if e := m.getEntry(key); e != nil {
		return e.value, true
	}
	return
}

func (m *OrderedTreeMap[K, V]) Head() (value V, exist bool) {
	if m.head == nil {
		return value, false
	}
	return m.head.value, true
}

func (m *OrderedTreeMap[K, V]) HeadEntry() *TreeMapEntry[K, V] {
	return m.head
}

func (m *OrderedTreeMap[K, V]) Tail() (value V, exist bool) {
	if m.tail == nil {
		return value, false
	}
	return m.tail.value, true
}

func (m *OrderedTreeMap[K, V]) TailEntry() *TreeMapEntry[K, V] {
	return m.tail
}

func (m *OrderedTreeMap[K, V]) Range(f func(key K, value V) bool) bool {
	var next *TreeMapEntry[K, V]
	for cur := m.head; cur != nil; cur = next {
		next = cur.next()
		if !f(cur.key, cur.value) {
			return false
		}
	}
	return true
}

func (m *OrderedTreeMap[K, V]) RangeEntries(f func(e *TreeMapEntry[K, V]) bool) bool {
	var next *TreeMapEntry[K, V]
	for cur := m.head; cur != nil; cur = next {
		next = cur.next()
		if !f(cur) {
			return false
		}
	}
	return true
}

func (m *OrderedTreeMap[K, V]) Keys() (keys []K) {
	var next *TreeMapEntry[K, V]
	for cur := m.head; cur != nil; cur = next {
		next = cur.next()
		keys = append(keys, cur.key)
	}
	return
}

func (m *OrderedTreeMap[K, V]) Values() (values []V) {
	var next *TreeMapEntry[K, V]
	for cur := m.head; cur != nil; cur = next {
		next = cur.next()
		values = append(values, cur.value)
	}
	return
}

func (m *OrderedTreeMap[K, V]) grow() int {
	l := len(m.entries)
	if l == cap(m.entries) {
		m.entries = append(m.entries, nil)
		m.entries = m.entries[:cap(m.entries)]
		rawEntries := make([]TreeMapEntry[K, V], cap(m.entries)-l)
		for i := range rawEntries {
			m.entries[i+l] = &rawEntries[i]
		}
		m.entries = m.entries[:l]
	}
	return l
}

func (m *OrderedTreeMap[K, V]) newEntry(key K, value V, color int) (e *TreeMapEntry[K, V]) {
	l := m.grow()
	m.entries = m.entries[:l+1]
	e = m.entries[l]
	e.key = key
	e.value = value
	e.color = color
	return m.entries[l]
}

func (m *OrderedTreeMap[K, V]) freeEntry(e *TreeMapEntry[K, V]) {
	l := len(m.entries)
	m.entries[l-1] = e
	m.entries = m.entries[:l-1]
}

func (*OrderedTreeMap[K, V]) colorOf(p *TreeMapEntry[K, V]) int {
	if p == nil {
		return treeMapColorBlack
	}
	return p.color
}

func (*OrderedTreeMap[K, V]) parentOf(p *TreeMapEntry[K, V]) *TreeMapEntry[K, V] {
	if p == nil {
		return nil
	}
	return p.parent
}

func (*OrderedTreeMap[K, V]) setColor(p *TreeMapEntry[K, V], color int) {
	if p != nil {
		p.color = color
	}
}

func (*OrderedTreeMap[K, V]) leftOf(p *TreeMapEntry[K, V]) *TreeMapEntry[K, V] {
	if p == nil {
		return nil
	}
	return p.left
}

func (*OrderedTreeMap[K, V]) rightOf(p *TreeMapEntry[K, V]) *TreeMapEntry[K, V] {
	if p == nil {
		return nil
	}
	return p.right
}

func (m *OrderedTreeMap[K, V]) rotateLeft(p *TreeMapEntry[K, V]) {
	if p != nil {
		r := p.right
		p.right = r.left
		if r.left != nil {
			r.left.parent = p
		}
		r.parent = p.parent
		if p.parent == nil {
			m.root = r
		} else if p.parent.left == p {
			p.parent.left = r
		} else {
			p.parent.right = r
		}
		r.left = p
		p.parent = r
	}
}

func (m *OrderedTreeMap[K, V]) rotateRight(p *TreeMapEntry[K, V]) {
	if p != nil {
		l := p.left
		p.left = l.right
		if l.right != nil {
			l.right.parent = p
		}
		l.parent = p.parent
		if p.parent == nil {
			m.root = l
		} else if p.parent.right == p {
			p.parent.right = l
		} else {
			p.parent.left = l
		}
		l.right = p
		p.parent = l
	}
}

func (m *OrderedTreeMap[K, V]) redirectRelation(p, l, r, o, n *TreeMapEntry[K, V]) {
	if p != nil {
		if p.left == o {
			p.left = n
		} else if p.right == o {
			p.right = n
		} else {
			panic("parent not parent of old")
		}
	}
	if l != nil {
		l.parent = n
	}
	if r != nil {
		r.parent = n
	}
}

func (m *OrderedTreeMap[K, V]) replaceRelation(old, e *TreeMapEntry[K, V]) {
	e.parent = old.parent
	e.left, e.right = old.left, old.right
	e.color = old.color
	m.redirectRelation(old.parent, old.left, old.right, old, e)
	if m.root == old {
		m.root = e
	}
	if m.head == old {
		m.head = e
	}
	if m.tail == old {
		m.tail = e
	}
	old.parent = nil
	old.left, old.right = nil, nil
	old.color = treeMapColorNone
}

func (m *OrderedTreeMap[K, V]) swapRelation(e1, e2 *TreeMapEntry[K, V]) {
	p1, l1, r1 := e1.parent, e1.left, e1.right
	p2, l2, r2 := e2.parent, e2.left, e2.right
	m.redirectRelation(p1, l1, r1, e1, e2)
	m.redirectRelation(p2, l2, r2, e2, e1)
	e1.parent, e2.parent = e2.parent, e1.parent
	e1.left, e2.left = e2.left, e1.left
	e1.right, e2.right = e2.right, e1.right
	e1.color, e2.color = e2.color, e1.color
	if m.root == e1 {
		m.root = e2
	} else if m.root == e2 {
		m.root = e1
	}
	if m.head == e1 {
		m.head = e2
	} else if m.head == e2 {
		m.head = e1
	}
	if m.tail == e1 {
		m.tail = e2
	} else if m.tail == e2 {
		m.tail = e1
	}
}

func (m *OrderedTreeMap[K, V]) fixAfterInsertion(x *TreeMapEntry[K, V]) {
	x.color = treeMapColorRed

	for x != nil && x != m.root && x.parent.color == treeMapColorRed {
		if m.parentOf(x) == m.leftOf(m.parentOf(m.parentOf(x))) {
			y := m.rightOf(m.parentOf(m.parentOf(x)))
			if m.colorOf(y) == treeMapColorRed {
				m.setColor(m.parentOf(x), treeMapColorBlack)
				m.setColor(y, treeMapColorBlack)
				m.setColor(m.parentOf(m.parentOf(x)), treeMapColorRed)
				x = m.parentOf(m.parentOf(x))
			} else {
				if x == m.rightOf(m.parentOf(x)) {
					x = m.parentOf(x)
					m.rotateLeft(x)
				}
				m.setColor(m.parentOf(x), treeMapColorBlack)
				m.setColor(m.parentOf(m.parentOf(x)), treeMapColorRed)
				m.rotateRight(m.parentOf(m.parentOf(x)))
			}
		} else {
			y := m.leftOf(m.parentOf(m.parentOf(x)))
			if m.colorOf(y) == treeMapColorRed {
				m.setColor(m.parentOf(x), treeMapColorBlack)
				m.setColor(y, treeMapColorBlack)
				m.setColor(m.parentOf(m.parentOf(x)), treeMapColorRed)
				x = m.parentOf(m.parentOf(x))
			} else {
				if x == m.leftOf(m.parentOf(x)) {
					x = m.parentOf(x)
					m.rotateRight(x)
				}
				m.setColor(m.parentOf(x), treeMapColorBlack)
				m.setColor(m.parentOf(m.parentOf(x)), treeMapColorRed)
				m.rotateLeft(m.parentOf(m.parentOf(x)))
			}
		}
	}
	m.root.color = treeMapColorBlack
}

func (m *OrderedTreeMap[K, V]) addEntryToEmpty(e *TreeMapEntry[K, V]) {
	m.root = e
	m.head, m.tail = e, e
}

func (m *OrderedTreeMap[K, V]) addEntryToParent(e, p *TreeMapEntry[K, V], addToLeft bool) {
	e.parent = p
	if addToLeft {
		p.left = e
		if p == m.head {
			m.head = e
		}
	} else {
		p.right = e
		if p == m.tail {
			m.tail = e
		}
	}
	m.fixAfterInsertion(e)
}

func (m *OrderedTreeMap[K, V]) add(key K, value V, mode int) (old V, exist bool) {
	t := m.root
	if t == nil {
		m.addEntryToEmpty(m.newEntry(key, value, treeMapColorBlack))
		return value, false
	}
	var parent *TreeMapEntry[K, V]
	var cmp int
	for t != nil {
		parent = t
		if key < t.key {
			t = t.left
			cmp = -1
		} else if key > t.key {
			t = t.right
			cmp = 1
		} else {
			switch mode {
			case treeMapPut:
				m.replaceRelation(t, m.newEntry(key, value, treeMapColorBlack))
				return value, false
			case treeMapReplace, treeMapStore:
				old = t.value
				t.value = value
				return old, true
			case treeMapLoadOrStore:
				return t.value, true
			}
		}
	}
	if mode != treeMapReplace {
		m.addEntryToParent(m.newEntry(key, value, treeMapColorBlack), parent, cmp < 0)
		return value, false
	}
	return
}

func (m *OrderedTreeMap[K, V]) Store(key K, value V) {
	m.add(key, value, treeMapStore)
}

func (m *OrderedTreeMap[K, V]) Set(key K, value V) (old V, exist bool) {
	return m.add(key, value, treeMapStore)
}

func (m *OrderedTreeMap[K, V]) LoadOrStore(key K, value V) (old V, exist bool) {
	return m.add(key, value, treeMapLoadOrStore)
}

func (m *OrderedTreeMap[K, V]) Replace(ket K, value V) bool {
	_, exist := m.add(ket, value, treeMapReplace)
	return !exist
}

func (m *OrderedTreeMap[K, V]) Put(key K, value V) (old V, exist bool) {
	return m.add(key, value, treeMapPut)
}

func (m *OrderedTreeMap[K, V]) fixAfterDeletion(x *TreeMapEntry[K, V]) {
	for x != m.root && m.colorOf(x) == treeMapColorBlack {
		if x == m.leftOf(m.parentOf(x)) {
			sib := m.rightOf(m.parentOf(x))

			if m.colorOf(sib) == treeMapColorRed {
				m.setColor(sib, treeMapColorBlack)
				m.setColor(m.parentOf(x), treeMapColorRed)
				m.rotateLeft(m.parentOf(x))
				sib = m.rightOf(m.parentOf(x))
			}

			if m.colorOf(m.leftOf(sib)) == treeMapColorBlack &&
				m.colorOf(m.rightOf(sib)) == treeMapColorBlack {
				m.setColor(sib, treeMapColorRed)
				x = m.parentOf(x)
			} else {
				if m.colorOf(m.rightOf(sib)) == treeMapColorBlack {
					m.setColor(m.leftOf(sib), treeMapColorBlack)
					m.setColor(sib, treeMapColorRed)
					m.rotateRight(sib)
					sib = m.rightOf(m.parentOf(x))
				}
				m.setColor(sib, m.colorOf(m.parentOf(x)))
				m.setColor(m.parentOf(x), treeMapColorBlack)
				m.setColor(m.rightOf(sib), treeMapColorBlack)
				m.rotateLeft(m.parentOf(x))
				x = m.root
			}
		} else { // symmetric
			sib := m.leftOf(m.parentOf(x))

			if m.colorOf(sib) == treeMapColorRed {
				m.setColor(sib, treeMapColorBlack)
				m.setColor(m.parentOf(x), treeMapColorRed)
				m.rotateRight(m.parentOf(x))
				sib = m.leftOf(m.parentOf(x))
			}

			if m.colorOf(m.rightOf(sib)) == treeMapColorBlack &&
				m.colorOf(m.leftOf(sib)) == treeMapColorBlack {
				m.setColor(sib, treeMapColorRed)
				x = m.parentOf(x)
			} else {
				if m.colorOf(m.leftOf(sib)) == treeMapColorBlack {
					m.setColor(m.rightOf(sib), treeMapColorBlack)
					m.setColor(sib, treeMapColorRed)
					m.rotateLeft(sib)
					sib = m.leftOf(m.parentOf(x))
				}
				m.setColor(sib, m.colorOf(m.parentOf(x)))
				m.setColor(m.parentOf(x), treeMapColorBlack)
				m.setColor(m.leftOf(sib), treeMapColorBlack)
				m.rotateRight(m.parentOf(x))
				x = m.root
			}
		}
	}

	m.setColor(x, treeMapColorBlack)
}

func (m *OrderedTreeMap[K, V]) deleteEntry(p *TreeMapEntry[K, V]) {
	// If strictly internal, copy successor's element to p and then make p
	// point to successor.
	if p.left != nil && p.right != nil {
		m.swapRelation(p, p.next())
	} // p has 2 children

	if p == m.head {
		m.head = p.next()
	}
	if p == m.tail {
		m.tail = p.prev()
	}

	// Start fixup at replacement node, if it exists.
	var replacement *TreeMapEntry[K, V]
	if p.left != nil {
		replacement = p.left
	} else {
		replacement = p.right
	}

	if replacement != nil {
		// Link replacement to parent
		replacement.parent = p.parent
		if p.parent == nil {
			m.root = replacement
		} else if p == p.parent.left {
			p.parent.left = replacement
		} else {
			p.parent.right = replacement
		}

		// Null out links so they are OK to use by fixAfterDeletion.
		p.left, p.right, p.parent = nil, nil, nil

		// Fix replacement
		if p.color == treeMapColorBlack {
			m.fixAfterDeletion(replacement)
		}
	} else if p.parent == nil { // return if we are the only node.
		m.root = nil
	} else { //  No children. Use self as phantom replacement and unlink.
		if p.color == treeMapColorBlack {
			m.fixAfterDeletion(p)
		}

		if p.parent != nil {
			if p == p.parent.left {
				p.parent.left = nil
			} else if p == p.parent.right {
				p.parent.right = nil
			}
			p.parent = nil
		}
	}

	p.color = treeMapColorNone
	m.freeEntry(p)
}

func (m *OrderedTreeMap[K, V]) Remove(key K) (old V, exist bool) {
	if e := m.getEntry(key); e != nil {
		old, exist = e.value, true
		m.deleteEntry(e)
	}
	return
}

func (m *OrderedTreeMap[K, V]) RemoveEntry(e *TreeMapEntry[K, V]) bool {
	if e.Removed() {
		return false
	}
	m.deleteEntry(e)
	return true
}

func (m *OrderedTreeMap[K, V]) Delete(key K) {
	if e := m.getEntry(key); e != nil {
		m.deleteEntry(e)
	}
	return
}

func (m *OrderedTreeMap[K, V]) Shift() (v V, exist bool) {
	if m.head != nil {
		v, exist = m.head.value, true
		m.deleteEntry(m.head)
	}
	return
}

func (m *OrderedTreeMap[K, V]) ShiftKey() (k K, exist bool) {
	if m.head != nil {
		k, exist = m.head.key, true
		m.deleteEntry(m.head)
	}
	return
}

func (m *OrderedTreeMap[K, V]) Pop() (v V, exist bool) {
	if m.tail != nil {
		v, exist = m.tail.value, true
		m.deleteEntry(m.tail)
	}
	return
}

func (m *OrderedTreeMap[K, V]) PopKey() (k K, exist bool) {
	if m.tail != nil {
		k, exist = m.tail.key, true
		m.deleteEntry(m.tail)
	}
	return
}

func (m *OrderedTreeMap[K, V]) Clear() {
	for _, entry := range m.entries {
		entry.color = treeMapColorNone
		entry.parent, entry.left, entry.right = nil, nil, nil
	}
	m.entries = m.entries[:0]
	m.root, m.head, m.tail = nil, nil, nil
}