algorithm/Java
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/Java.git synced 2025-07-07 17:56:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add SplayTree (#5142)

Browse Source
This commit is contained in:
SOZEL
2024-09-02 03:25:34 +07:00
committed by GitHub
parent b396a9790e
commit a5b083cab0
3 changed files with 513 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

324
src/main/java/com/thealgorithms/datastructures/trees/SplayTree.java Normal file
View File

@ -0,0 +1,324 @@
package com.thealgorithms.datastructures.trees;
import java.util.LinkedList;
import java.util.List;
/**
* Implementation of a Splay Tree data structure.
*
* A splay tree is a self-adjusting binary search tree with the additional
* property
* that recently accessed elements are quick to access again. It performs basic
* operations such as insertion, deletion, and searching in O(log n) amortized
* time,
* where n is the number of elements in the tree.
*
* The key feature of splay trees is the splay operation, which moves a node
* closer
* to the root of the tree when it is accessed. This operation helps to maintain
* good balance and improves the overall performance of the tree. After
* performing
* a splay operation, the accessed node becomes the new root of the tree.
*
* Splay trees have applications in various areas, including caching, network
* routing,
* and dynamic optimality analysis.
*/
public class SplayTree {
public static final TreeTraversal PRE_ORDER = new PreOrderTraversal();
public static final TreeTraversal IN_ORDER = new InOrderTraversal();
public static final TreeTraversal POST_ORDER = new PostOrderTraversal();
private Node root;
/**
* Checks if the tree is empty.
*
* @return True if the tree is empty, otherwise false.
*/
public boolean isEmpty() {
return root == null;
}
/**
* Insert a key into the SplayTree.
*
* @param key The key to insert.
*/
public void insert(final int key) {
root = insertRec(root, key);
root = splay(root, key);
}
/**
* Search for a key in the SplayTree.
*
* @param key The key to search for.
* @return True if the key is found, otherwise false.
*/
public boolean search(int key) {
root = splay(root, key);
return root != null && root.key == key;
}
/**
* Deletes a key from the SplayTree.
*
* @param key The key to delete.
* @throws IllegalArgumentException If the tree is empty.
*/
public void delete(final int key) {
if (isEmpty()) {
throw new EmptyTreeException("Cannot delete from an empty tree");
}
root = splay(root, key);
if (root.key != key) {
return;
}
if (root.left == null) {
root = root.right;
} else {
Node temp = root;
root = splay(root.left, findMax(root.left).key);
root.right = temp.right;
}
}
/**
* Perform a traversal of the SplayTree.
*
* @param traversal The type of traversal method.
* @return A list containing the keys in the specified traversal order.
*/
public List<Integer> traverse(TreeTraversal traversal) {
List<Integer> result = new LinkedList<>();
traversal.traverse(root, result);
return result;
}
/**
* Finds the node with the maximum key in a given subtree.
*
* <p>
* This method traverses the right children of the subtree until it finds the
* rightmost node, which contains the maximum key.
* </p>
*
* @param root The root node of the subtree.
* @return The node with the maximum key in the subtree.
*/
private Node findMax(Node root) {
while (root.right != null) {
root = root.right;
}
return root;
}
/**
* Zig operation.
*
* <p>
* The zig operation is used to perform a single rotation on a node to move it
* closer to
* the root of the tree. It is typically applied when the node is a left child
* of its parent
* and needs to be rotated to the right.
* </p>
*
* @param x The node to perform the zig operation on.
* @return The new root node after the operation.
*/
private Node rotateRight(Node x) {
Node y = x.left;
x.left = y.right;
y.right = x;
return y;
}
/**
* Zag operation.
*
* <p>
* The zag operation is used to perform a single rotation on a node to move it
* closer to
* the root of the tree. It is typically applied when the node is a right child
* of its parent
* and needs to be rotated to the left.
* </p>
*
* @param x The node to perform the zag operation on.
* @return The new root node after the operation.
*/
private Node rotateLeft(Node x) {
Node y = x.right;
x.right = y.left;
y.left = x;
return y;
}
/**
* Splay operation.
*
* <p>
* The splay operation is the core operation of a splay tree. It moves a
* specified node
* closer to the root of the tree by performing a series of rotations. The goal
* of the splay
* operation is to improve the access time for frequently accessed nodes by
* bringing them
* closer to the root.
* </p>
*
* <p>
* The splay operation consists of three main cases:
* <ul>
* <li>Zig-Zig case: Perform two consecutive rotations.</li>
* <li>Zig-Zag case: Perform two consecutive rotations in opposite
* directions.</li>
* <li>Zag-Zag case: Perform two consecutive rotations.</li>
* </ul>
* </p>
*
* <p>
* After performing the splay operation, the accessed node becomes the new root
* of the tree.
* </p>
*
* @param root The root of the subtree to splay.
* @param key The key to splay around.
* @return The new root of the splayed subtree.
*/
private Node splay(Node root, final int key) {
if (root == null || root.key == key) {
return root;
}
if (root.key > key) {
if (root.left == null) {
return root;
}
// Zig-Zig case
if (root.left.key > key) {
root.left.left = splay(root.left.left, key);
root = rotateRight(root);
} else if (root.left.key < key) {
root.left.right = splay(root.left.right, key);
if (root.left.right != null) {
root.left = rotateLeft(root.left);
}
}
return (root.left == null) ? root : rotateRight(root);
} else {
if (root.right == null) {
return root;
}
// Zag-Zag case
if (root.right.key > key) {
root.right.left = splay(root.right.left, key);
if (root.right.left != null) {
root.right = rotateRight(root.right);
}
} else if (root.right.key < key) {
root.right.right = splay(root.right.right, key);
root = rotateLeft(root);
}
return (root.right == null) ? root : rotateLeft(root);
}
}
private Node insertRec(Node root, final int key) {
if (root == null) {
return new Node(key);
}
if (key < root.key) {
root.left = insertRec(root.left, key);
} else if (key > root.key) {
root.right = insertRec(root.right, key);
} else {
throw new DuplicateKeyException("Duplicate key: " + key);
}
return root;
}
public static class EmptyTreeException extends RuntimeException {
private static final long serialVersionUID = 1L;
public EmptyTreeException(String message) {
super(message);
}
}
public static class DuplicateKeyException extends RuntimeException {
private static final long serialVersionUID = 1L;
public DuplicateKeyException(String message) {
super(message);
}
}
private static class Node {
final int key;
Node left;
Node right;
Node(int key) {
this.key = key;
left = null;
right = null;
}
}
public interface TreeTraversal {
/**
* Recursive function for a specific order traversal.
*
* @param root The root of the subtree to traverse.
* @param result The list to store the traversal result.
*/
void traverse(Node root, List<Integer> result);
}
private static final class InOrderTraversal implements TreeTraversal {
private InOrderTraversal() {
}
public void traverse(Node root, List<Integer> result) {
if (root != null) {
traverse(root.left, result);
result.add(root.key);
traverse(root.right, result);
}
}
}
private static final class PreOrderTraversal implements TreeTraversal {
private PreOrderTraversal() {
}
public void traverse(Node root, List<Integer> result) {
if (root != null) {
result.add(root.key);
traverse(root.left, result);
traverse(root.right, result);
}
}
}
private static final class PostOrderTraversal implements TreeTraversal {
private PostOrderTraversal() {
}
public void traverse(Node root, List<Integer> result) {
if (root != null) {
traverse(root.left, result);
traverse(root.right, result);
result.add(root.key);
}
}
}
}