DataStructures/LinkedList/SkipList/SkipList.cs

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;

namespace DataStructures.LinkedList.SkipList;

//github.com/ <summary>
//github.com/ Skip list implementation that is based on the singly linked list,
//github.com/ but offers O(log n) time complexity on most operations.
//github.com/ </summary>
//github.com/ <typeparam name="TValue">The type of the values in the list.</typeparam>
//github.com/ <remarks>
//github.com/ Skip list nodes sorted by key.
//github.com/ The "skip lanes" allow searching for a node in O(log n) time on average.
//github.com/ The worst case performence is O(n) when the height of all nodes is 1 (very
//github.com/ unluckily to happen on any decent list size).
//github.com/ These two properties make the skip list an excellent data structure for
//github.com/ implementing additional operations like finding min/max value in the list,
//github.com/ finding values with the key in a given range, etc.
//github.com/
//github.com/ Sourses:
//github.com/ - "Skip Lists: A Probabilistic Alternative to Balanced Trees" by William Pugh.
//github.com/ - https://en.wikipedia.org/wiki/Skip_list
//github.com/ - https://iq.opengenus.org/skip-list/
//github.com/ - https://medium.com/simple-computer-science/data-structures-basics-skip-list-8b8c69f9a044
//github.com/ - https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/datastructures/lists/SkipList.java
//github.com/
//github.com/ The key is hardcoded to be of type <c>int</c> to simplify the implementation,
//github.com/ but it can be easily an any generic type that implements <c>IComparable</c>.
//github.com/ </remarks>
[DebuggerDisplay("Count = {Count}")]
public class SkipList<TValue>
{
    private const double Probability = 0.5;
    private readonly int maxLevels;
    private readonly SkipListNode<TValue> head;
    private readonly SkipListNode<TValue> tail;
    private readonly Random random = new Random();

    //github.com/ <summary>
    //github.com/ Initializes a new instance of the <see cref="SkipList{TValue}"/> class.
    //github.com/ </summary>
    //github.com/ <param name="capacity">Expected number of elements the list might contain.</param>
    public SkipList(int capacity = 255)
    {
        maxLevels = (int)Math.Log2(capacity) + 1;

        head = new(int.MinValue, default(TValue), maxLevels);
        tail = new(int.MaxValue, default(TValue), maxLevels);

        for(int i = 0; i < maxLevels; i++)
        {
            head.Next[i] = tail;
        }
    }

    //github.com/ <summary>
    //github.com/ Gets the number of elements currently in the list.
    //github.com/ </summary>
    public int Count { get; private set; }

    //github.com/ <summary>
    //github.com/ Gets or sets the element with the specified key.
    //github.com/ </summary>
    //github.com/ <exception cref="KeyNotFoundException">The key is not present in the list.</exception>
    public TValue this[int key]
    {
        get
        {
            var previousNode = GetSkipNodes(key).First();
            if(previousNode.Next[0].Key == key)
            {
                return previousNode.Next[0].Value!;
            }
            else
            {
                throw new KeyNotFoundException();
            }
        }

        set => AddOrUpdate(key, value);
    }

    //github.com/ <summary>
    //github.com/ Adds an element with the specified key and value to the list.
    //github.com/ If an element with the same key already exists, updates its value.
    //github.com/ </summary>
    //github.com/ <param name="key">The key of the element to add.</param>
    //github.com/ <param name="value">The value of the element to add.</param>
    //github.com/ <remarks>
    //github.com/ Time complexity: O(log n) where n is the number of elements in the list.
    //github.com/ </remarks>
    public void AddOrUpdate(int key, TValue value)
    {
        var skipNodes = GetSkipNodes(key);

        var previousNode = skipNodes.First();
        if (previousNode.Next[0].Key == key)
        {
            // Node with the given key already exists.
            // Update its value.
            previousNode.Next[0].Value = value;
            return;
        }

        // Node with the given key does not exist.
        // Insert the new one and update the skip nodes.
        var newNode = new SkipListNode<TValue>(key, value, GetRandomHeight());
        for (var level = 0; level < newNode.Height; level++)
        {
            newNode.Next[level] = skipNodes[level].Next[level];
            skipNodes[level].Next[level] = newNode;
        }

        Count++;
    }

    //github.com/ <summary>
    //github.com/ Returns whether a value with the given key exists in the list.
    //github.com/ </summary>
    //github.com/ <remarks>
    //github.com/ Time complexity: O(log n) where n is the number of elements in the list.
    //github.com/ </remarks>
    public bool Contains(int key)
    {
        var previousNode = GetSkipNodes(key).First();
        return previousNode.Next[0].Key == key;
    }

    //github.com/ <summary>
    //github.com/ Removes the value with the given key from the list.
    //github.com/ </summary>
    //github.com/ <returns>
    //github.com/ <c>true</c> if the value was removed; otherwise, <c>false</c>.
    //github.com/ </returns>
    //github.com/ <remarks>
    //github.com/ Time complexity: O(log n) where n is the number of elements in the list.
    //github.com/ </remarks>
    public bool Remove(int key)
    {
        var skipNodes = GetSkipNodes(key);
        var previousNode = skipNodes.First();
        if (previousNode.Next[0].Key != key)
        {
            return false;
        }

        // Key exists in the list, remove it and update the skip nodes.
        var nodeToRemove = previousNode.Next[0];
        for (var level = 0; level < nodeToRemove.Height; level++)
        {
            skipNodes[level].Next[level] = nodeToRemove.Next[level];
        }

        Count--;

        return true;
    }

    //github.com/ <summary>
    //github.com/ Returns an enumerator that iterates through the list.
    //github.com/ </summary>
    //github.com/ <remarks>
    //github.com/ Order of values is the ascending order of their keys.
    //github.com/ Time complexity: O(n) where n is the number of elements in the list.
    //github.com/ </remarks>
    public IEnumerable<TValue> GetValues()
    {
        var current = head.Next[0];
        while (current.Key != tail.Key)
        {
            yield return current.Value!;
            current = current.Next[0];
        }
    }

    //github.com/ <summary>
    //github.com/ Builds a list of skip nodes on each level that
    //github.com/ are closest, but smaller than the given key.
    //github.com/ </summary>
    //github.com/ <remarks>
    //github.com/ The node on level 0 will point to the node with the given key, if it exists.
    //github.com/ Time complexity: O(log n) where n is the number of elements in the list.
    //github.com/ </remarks>
    private SkipListNode<TValue>[] GetSkipNodes(int key)
    {
        var skipNodes = new SkipListNode<TValue>[maxLevels];
        var current = head;
        for (var level = head.Height - 1; level >= 0; level--)
        {
            while (current.Next[level].Key < key)
            {
                current = current.Next[level];
            }

            skipNodes[level] = current;
        }

        return skipNodes;
    }

    //github.com/ <summary>
    //github.com/ Determines the height of skip levels for the new node.
    //github.com/ </summary>
    //github.com/ <remarks>
    //github.com/ Probability of the next level is 1/(2^level).
    //github.com/ </remarks>
    private int GetRandomHeight()
    {
        int height = 1;
        while (random.NextDouble() < Probability && height < maxLevels)
        {
            height++;
        }

        return height;
    }
}