Modules/Containers/public/Tree.hpp

#pragma once

#include "ContainersCommon.hpp"

namespace tp {

	template <typename NumericType>
	struct AvlNumericKey {

		NumericType val;

		AvlNumericKey() = default;
		AvlNumericKey(NumericType val) :
			val(val) {}

		inline bool descentRight(AvlNumericKey in) const { return in.val > val; }
		inline bool descentLeft(AvlNumericKey in) const { return in.val < val; }
		inline bool exactNode(AvlNumericKey in) const { return in.val == val; }

		inline AvlNumericKey getFindKey(/**/) const { return *this; }
		inline AvlNumericKey keyInRightSubtree(AvlNumericKey in) const { return in; }
		inline AvlNumericKey keyInLeftSubtree(AvlNumericKey in) const { return in; }

		inline void updateTreeCacheCallBack() {}
	};

	template <typename Key, typename Data, class Allocator = DefaultAllocator>
	class AvlTree {
		typedef SelectValueOrReference<Key> KeyArg;
		typedef SelectValueOrReference<Data> DataArg;

	public:
		class Node {
			friend AvlTree;

		private:
			Node(KeyArg aKey, DataArg aData) :
				key(aKey),
				data(aData) {}

		public:
			Data data;
			Key key;

		private:
			Node* mLeft = nullptr;
			Node* mRight = nullptr;
			Node* mParent = nullptr;
			ualni mHeight = 0;

		private:
			inline bool descentRight(KeyArg aKey) const { return key.descentRight(aKey); }
			inline bool descentLeft(KeyArg aKey) const { return key.descentLeft(aKey); }
			inline bool exactNode(KeyArg aKey) const { return key.exactNode(aKey); }

			inline KeyArg getFindKey(const Node* node = nullptr) const { return key.getFindKey(/*node*/); }
			inline KeyArg keyInRightSubtree(KeyArg aKey) const { return key.keyInRightSubtree(aKey); }
			inline KeyArg keyInLeftSubtree(KeyArg aKey) const { return key.keyInLeftSubtree(aKey); }

			inline void updateTreeCacheCallBack() { key.updateTreeCacheCallBack(); }
		};

	private:
		Node* mRoot = nullptr;
		ualni mSize = 0;
		Allocator mAlloc;

	private:
		inline void deleteNode(Node* node) {
			node->~Node();
			mAlloc.deallocate(node);
		}

		inline Node* newNode(KeyArg key, DataArg data) { return new (mAlloc.allocate(sizeof(Node))) Node(key, data); }

		inline void injectNodeInstead(Node* place, Node* inject) {
			// TODO : swap instead of copy
			place->data = inject->data;
			place->key = inject->key;
		}

		inline alni getNodeHeight(const Node* node) const { return node ? node->mHeight : -1; }

		// returns new head
		Node* rotateLeft(Node* pivot) {
			DEBUG_ASSERT(pivot);

			Node* const head = pivot;
			Node* const right = pivot->mRight;
			Node* const right_left = right->mLeft;
			Node* const parent = pivot->mParent;

			// parents
			if (right_left) right_left->mParent = head;
			head->mParent = right;
			right->mParent = parent;

			// children
			head->mRight = right_left;
			right->mLeft = head;

			// heights
			head->mHeight = 1 + max(getNodeHeight(head->mLeft), getNodeHeight(head->mRight));
			right->mHeight = 1 + max(getNodeHeight(right->mLeft), getNodeHeight(right->mRight));

			// cache
			head->updateTreeCacheCallBack();
			right->updateTreeCacheCallBack();

			return right;
		}

		Node* rotateRight(Node* pivot) {
			DEBUG_ASSERT(pivot);

			Node* const head = pivot;
			Node* const left = pivot->mLeft;
			Node* const left_right = left->mRight;
			Node* const parent = pivot->mParent;

			// parents
			if (left_right) left_right->mParent = head;
			head->mParent = left;
			left->mParent = parent;

			// children
			head->mLeft = left_right;
			left->mRight = head;

			// heights
			head->mHeight = 1 + max(getNodeHeight(head->mLeft), getNodeHeight(head->mRight));
			left->mHeight = 1 + max(getNodeHeight(left->mLeft), getNodeHeight(left->mRight));

			// cache
			head->updateTreeCacheCallBack();
			left->updateTreeCacheCallBack();

			return left;
		}

		// recursively returns valid isLeft or isRight child or root
		Node* insertUtil(Node* head, KeyArg key, DataArg data) {

			Node* insertedNode;

			if (head == nullptr) {
				mSize++;
				Node* out = newNode(key, data);
				out->updateTreeCacheCallBack();
				return out;
			} else if (head->exactNode(key)) {
				return head;
			} else if (head->descentRight(key)) {
				insertedNode = insertUtil(head->mRight, head->keyInRightSubtree(key), data);
				head->mRight = insertedNode;
				insertedNode->mParent = head;
			} else {
				insertedNode = insertUtil(head->mLeft, head->keyInLeftSubtree(key), data);
				head->mLeft = insertedNode;
				insertedNode->mParent = head;
			}

			// update height
			head->mHeight = 1 + max(getNodeHeight(head->mRight), getNodeHeight(head->mLeft));

			alni balance = alni(getNodeHeight(head->mRight) - getNodeHeight(head->mLeft));

			if (balance > 1) {
				if (head->mRight->descentRight(head->keyInRightSubtree(key))) {
					return rotateLeft(head);
				} else {
					head->mRight = rotateRight(head->mRight);
					return rotateLeft(head);
				}
			} else if (balance < -1) {
				if (head->mLeft->descentLeft(head->keyInLeftSubtree(key))) {
					return rotateRight(head);
				} else {
					head->mLeft = rotateLeft(head->mLeft);
					return rotateRight(head);
				}
			}

			head->updateTreeCacheCallBack();

			return head;
		}

		Node* removeUtil(Node* head, KeyArg key) {
			if (head == nullptr) return head;

			if (head->exactNode(key)) {
				if (head->mRight && head->mLeft) {
					Node* min = minNode(head->mRight);
					auto const& newKey = min->getFindKey(head->mRight);
					injectNodeInstead(head, min);
					head->mRight = removeUtil(head->mRight, newKey);
				} else if (head->mRight) {
					injectNodeInstead(head, head->mRight);
					deleteNode(head->mRight);
					head->mRight = nullptr;
					mSize--;
				} else if (head->mLeft) {
					injectNodeInstead(head, head->mLeft);
					deleteNode(head->mLeft);
					head->mLeft = nullptr;
					mSize--;
				} else {
					deleteNode(head);
					mSize--;
					head = nullptr;
				}
			} else if (head->descentRight(key)) {
				head->mRight = removeUtil(head->mRight, head->keyInRightSubtree(key));
			} else if (head->descentLeft(key)) {
				head->mLeft = removeUtil(head->mLeft, head->keyInLeftSubtree(key));
			}

			if (head == nullptr) return head;

			head->mHeight = 1 + max(getNodeHeight(head->mRight), getNodeHeight(head->mLeft));
			alni balance = getNodeHeight(head->mRight) - getNodeHeight(head->mLeft);

			if (balance < -1) {
				if (getNodeHeight(head->mLeft->mLeft) >= getNodeHeight(head->mLeft->mRight)) {
					return rotateRight(head);
				} else {
					head->mLeft = rotateLeft(head->mLeft);
					return rotateRight(head);
				}
			} else if (balance > 1) {
				if (getNodeHeight(head->mRight->mRight) >= getNodeHeight(head->mRight->mLeft)) {
					return rotateLeft(head);
				} else {
					head->mRight = rotateRight(head->mRight);
					return rotateLeft(head);
				}
			}

			head->updateTreeCacheCallBack();

			return head;
		}

	public:
		AvlTree() { MODULE_SANITY_CHECK(gModuleContainers) }

		[[nodiscard]] ualni size() const { return mSize; }

		Node* head() const { return this->mRoot; }

		void insert(KeyArg key, DataArg data) {
			mRoot = insertUtil(mRoot, key, data);
			mRoot->mParent = nullptr;
		}

		void remove(KeyArg key) {
			mRoot = removeUtil(mRoot, key);
			if (mRoot) mRoot->mParent = nullptr;
		}

		Node* maxNode(Node* head) const {
			if (!head) return nullptr;
			while (head->mRight != nullptr) {
				head = head->mRight;
			}
			return head;
		}

		Node* minNode(Node* head) const {
			if (!head) return nullptr;
			while (head->mLeft != nullptr) {
				head = head->mLeft;
			}
			return head;
		}

		Node* find(KeyArg key) const {
			Node* iter = mRoot;
			while (true) {
				if (!iter) return nullptr;
				if (iter->exactNode(key)) return iter;
				if (iter->descentLeft(key)) {
					key = iter->keyInLeftSubtree(key);
					iter = iter->mLeft;
				} else {
					key = iter->keyInRightSubtree(key);
					iter = iter->mRight;
				}
			}
		}

		Node* findLessOrEq(KeyArg key) const {
			Node* iter = mRoot;
			while (true) {
				if (!iter) return nullptr;
				if (iter->exactNode(key)) return iter;
				if (iter->descentLeft(key)) {
					if (iter->mLeft) {
						key = iter->keyInLeftSubtree(key);
						iter = iter->mLeft;
					} else {
						return iter;
					}
				} else {
					if (iter->mRight) {
						key = iter->keyInRightSubtree(key);
						iter = iter->mRight;
					} else {
						return iter;
					}
				}
			}
		}

		// returns first invalid node
		const Node* findInvalidNode(const Node* head) const {
			if (head == nullptr) return nullptr;

			if (head->mLeft) {
				// TODO: incomplete test
				if (!head->descentLeft(head->mLeft->getFindKey(head))) return head;
				if (head->mLeft->mParent != head) return head;
				if (!head->mRight && head->mLeft->mHeight != head->mHeight - 1) return head;
			}

			if (head->mRight) {
				if (!head->descentRight(head->mRight->getFindKey(head))) return head;
				if (head->mRight->mParent != head) return head;
				if (!head->mLeft && head->mRight->mHeight != head->mHeight - 1) return head;
			}

			if (head->mLeft && head->mRight) {
				if (max(head->mLeft->mHeight, head->mRight->mHeight) != head->mHeight - 1) return head;
			}

			int balance = getNodeHeight(head->mRight) - getNodeHeight(head->mLeft);

			if (balance > 1 || balance < -1) return head;

			const Node* ret = findInvalidNode(head->mRight);

			if (ret) return ret;

			return findInvalidNode(head->mLeft);
		}

		bool isValid() { return findInvalidNode(head()) == nullptr; }

		template <typename tFunctor>
		void traverse(Node* node, bool after, tFunctor functor) {
			if (!after) functor(node);
			if (node->mLeft) traverse(node->mLeft, after, functor);
			if (node->mRight) traverse(node->mRight, after, functor);
			if (after) functor(node);
		}

		void removeAll() {
			traverse(mRoot, true, [this](Node* node) { deleteNode(node); });
			mRoot = nullptr;
			mSize = 0;
		}

	public:
		template <class tArchiver>
		void archiveWrite(tArchiver& file) const {
			FAIL("not implemented")
		}

		template <class tArchiver>
		void archiveRead(tArchiver&) {
			FAIL("not implemented")
		}
	};
}