Merge branch 'master' into rotate_sll_improve

Author: Hardvan

DIRECTORY.md

@@ -523,22 +523,29 @@
           * Recursion
             * [GenerateSubsets](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/Recursion/GenerateSubsets.java)
           * scheduling
+            * [AgingScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/AgingScheduling.java)
             * diskscheduling
               * [CircularLookScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/diskscheduling/CircularLookScheduling.java)
               * [CircularScanScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/diskscheduling/CircularScanScheduling.java)
               * [LookScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/diskscheduling/LookScheduling.java)
               * [ScanScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/diskscheduling/ScanScheduling.java)
               * [SSFScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/diskscheduling/SSFScheduling.java)
             * [EDFScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/EDFScheduling.java)
+            * [FairShareScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/FairShareScheduling.java)
             * [FCFSScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/FCFSScheduling.java)
+            * [GangScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/GangScheduling.java)
             * [HighestResponseRatioNextScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/HighestResponseRatioNextScheduling.java)
             * [JobSchedulingWithDeadline](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/JobSchedulingWithDeadline.java)
             * [LotteryScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/LotteryScheduling.java)
             * [MLFQScheduler](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/MLFQScheduler.java)
+            * [MultiAgentScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/MultiAgentScheduling.java)
             * [NonPreemptivePriorityScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/NonPreemptivePriorityScheduling.java)
             * [PreemptivePriorityScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/PreemptivePriorityScheduling.java)
+            * [ProportionalFairScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/ProportionalFairScheduling.java)
             * [RRScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/RRScheduling.java)
+            * [SelfAdjustingScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/SelfAdjustingScheduling.java)
             * [SJFScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/SJFScheduling.java)
+            * [SlackTimeScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/SlackTimeScheduling.java)
             * [SRTFScheduling](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/scheduling/SRTFScheduling.java)
           * searches
             * [BinarySearch](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/searches/BinarySearch.java)
@@ -859,6 +866,7 @@
               * [QueueByTwoStacksTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/datastructures/queues/QueueByTwoStacksTest.java)
               * [QueueTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/datastructures/queues/QueueTest.java)
             * stacks
+              * [NodeStackTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/datastructures/stacks/NodeStackTest.java)
               * [StackArrayListTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/datastructures/stacks/StackArrayListTest.java)
               * [StackArrayTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/datastructures/stacks/StackArrayTest.java)
               * [StackOfLinkedListTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/datastructures/stacks/StackOfLinkedListTest.java)
@@ -1118,22 +1126,29 @@
           * Recursion
             * [GenerateSubsetsTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/Recursion/GenerateSubsetsTest.java)
           * scheduling
+            * [AgingSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/AgingSchedulingTest.java)
             * diskscheduling
               * [CircularLookSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/diskscheduling/CircularLookSchedulingTest.java)
               * [CircularScanSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/diskscheduling/CircularScanSchedulingTest.java)
               * [LookSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/diskscheduling/LookSchedulingTest.java)
               * [ScanSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/diskscheduling/ScanSchedulingTest.java)
               * [SSFSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/diskscheduling/SSFSchedulingTest.java)
             * [EDFSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/EDFSchedulingTest.java)
+            * [FairShareSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/FairShareSchedulingTest.java)
             * [FCFSSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/FCFSSchedulingTest.java)
+            * [GangSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/GangSchedulingTest.java)
             * [HighestResponseRatioNextSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/HighestResponseRatioNextSchedulingTest.java)
             * [JobSchedulingWithDeadlineTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/JobSchedulingWithDeadlineTest.java)
             * [LotterySchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/LotterySchedulingTest.java)
             * [MLFQSchedulerTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/MLFQSchedulerTest.java)
+            * [MultiAgentSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/MultiAgentSchedulingTest.java)
             * [NonPreemptivePrioritySchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/NonPreemptivePrioritySchedulingTest.java)
             * [PreemptivePrioritySchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/PreemptivePrioritySchedulingTest.java)
+            * [ProportionalFairSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/ProportionalFairSchedulingTest.java)
             * [RRSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/RRSchedulingTest.java)
+            * [SelfAdjustingSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/SelfAdjustingSchedulingTest.java)
             * [SJFSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/SJFSchedulingTest.java)
+            * [SlackTimeSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/SlackTimeSchedulingTest.java)
             * [SRTFSchedulingTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/scheduling/SRTFSchedulingTest.java)
           * searches
             * [BinarySearch2dArrayTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/BinarySearch2dArrayTest.java)

src/main/java/com/thealgorithms/datastructures/lists/SortedLinkedList.java

@@ -4,24 +4,42 @@
 import java.util.List;
 
 /**
- * A SortedLinkedList is a data structure that maintains a sorted list of elements.
- * Elements are ordered based on their natural ordering or by a Comparator provided at the time of creation.
- * This implementation uses a singly linked list to store the elements.
- * Further details can be found on this link
+ * The SortedLinkedList class represents a singly linked list that maintains its elements in sorted order.
+ * Elements are ordered based on their natural ordering, with smaller elements at the head and larger elements toward the tail.
+ * The class provides methods for inserting, deleting, and searching elements, as well as checking if the list is empty.
+ * <p>
+ * This implementation utilizes a singly linked list to maintain a dynamically sorted list.
+ * </p>
+ * <p>
+ * Further information can be found here:
  * https://runestone.academy/ns/books/published/cppds/LinearLinked/ImplementinganOrderedList.html
+ * </p>
+ *
+ * <b>Usage Example:</b>
+ * <pre>
+ *     SortedLinkedList list = new SortedLinkedList();
+ *     list.insert(10);
+ *     list.insert(5);
+ *     list.insert(20);
+ *     System.out.println(list); // Outputs: [5, 10, 20]
+ * </pre>
  */
 public class SortedLinkedList {
     private Node head;
     private Node tail;
 
+    /**
+     * Initializes an empty sorted linked list.
+     */
     public SortedLinkedList() {
         this.head = null;
         this.tail = null;
     }
 
     /**
-     * Inserts a new element into the sorted linked list.
-     * @param value the value to be inserted
+     * Inserts a new integer into the list, maintaining sorted order.
+     *
+     * @param value the integer to insert
      */
     public void insert(int value) {
         Node newNode = new Node(value);
@@ -48,16 +66,10 @@ public void insert(int value) {
     }
 
     /**
-     * Displays the elements of the sorted linked list.
-     */
-    public void display() {
-        System.out.println(this.toString());
-    }
-
-    /**
-     * Deletes the first occurrence of the specified element in the sorted linked list.
-     * @param value the value to be deleted
-     * @return true if the element is found and deleted, false otherwise
+     * Deletes the first occurrence of a specified integer in the list.
+     *
+     * @param value the integer to delete
+     * @return {@code true} if the element was found and deleted; {@code false} otherwise
      */
     public boolean delete(int value) {
         if (this.head == null) {
@@ -87,9 +99,10 @@ public boolean delete(int value) {
     }
 
     /**
-     * Searches for the specified element in the sorted linked list.
-     * @param value the value to be searched
-     * @return true if the element is found, false otherwise
+     * Searches for a specified integer in the list.
+     *
+     * @param value the integer to search for
+     * @return {@code true} if the value is present in the list; {@code false} otherwise
      */
     public boolean search(int value) {
         Node temp = this.head;
@@ -103,14 +116,17 @@ public boolean search(int value) {
     }
 
     /**
-     * Checks if the sorted linked list is empty.
-     * @return true if the list is empty, false otherwise
+     * Checks if the list is empty.
+     *
+     * @return {@code true} if the list is empty; {@code false} otherwise
      */
     public boolean isEmpty() {
         return head == null;
     }
+
     /**
-     * Returns a string representation of the sorted linked list.
+     * Returns a string representation of the sorted linked list in the format [element1, element2, ...].
+     *
      * @return a string representation of the sorted linked list
      */
     @Override
@@ -123,12 +139,14 @@ public String toString() {
                 temp = temp.next;
             }
             return "[" + String.join(", ", elements) + "]";
-
         } else {
             return "[]";
         }
     }
 
+    /**
+     * Node represents an element in the sorted linked list.
+     */
     public final class Node {
         public final int value;
         public Node next;

src/main/java/com/thealgorithms/datastructures/queues/GenericArrayListQueue.java

@@ -4,43 +4,46 @@
 import java.util.List;
 
 /**
- * This class implements a GenericArrayListQueue.
+ * This class implements a GenericArrayListQueue, a queue data structure that
+ * holds elements of any type specified at runtime, allowing flexibility in the type
+ * of elements it stores.
  *
- * A GenericArrayListQueue data structure functions the same as any
- * specific-typed queue. The GenericArrayListQueue holds elements of types
- * to-be-specified at runtime. The elements that are added first are the first
- * to be removed (FIFO). New elements are added to the back/rear of the queue.
+ * <p>The GenericArrayListQueue operates on a First-In-First-Out (FIFO) basis, where
+ * elements added first are the first to be removed. New elements are added to the back
+ * (or rear) of the queue, while removal of elements occurs from the front.
+ *
+ * @param <T> The type of elements held in this queue.
  */
 public class GenericArrayListQueue<T> {
 
     /**
-     * The generic List for the queue. T is the generic element type.
+     * A list that stores the queue's elements in insertion order.
      */
     private final List<T> elementList = new ArrayList<>();
 
     /**
      * Checks if the queue is empty.
      *
-     * @return True if the queue is empty, false otherwise.
+     * @return {@code true} if the queue has no elements; {@code false} otherwise.
      */
-    private boolean isEmpty() {
+    public boolean isEmpty() {
         return elementList.isEmpty();
     }
 
     /**
-     * Returns the element at the front of the queue without removing it.
+     * Retrieves, but does not remove, the element at the front of the queue.
      *
-     * @return The element at the front of the queue, or null if the queue is empty.
+     * @return The element at the front of the queue, or {@code null} if the queue is empty.
      */
     public T peek() {
         return isEmpty() ? null : elementList.getFirst();
     }
 
     /**
-     * Inserts an element of type T to the back of the queue.
+     * Inserts an element at the back of the queue.
      *
-     * @param element the element to be added to the queue.
-     * @return True if the element was added successfully.
+     * @param element The element to be added to the queue.
+     * @return {@code true} if the element was successfully added.
      */
     public boolean add(T element) {
         return elementList.add(element);
@@ -49,7 +52,7 @@ public boolean add(T element) {
     /**
      * Retrieves and removes the element at the front of the queue.
      *
-     * @return The element removed from the front of the queue, or null if the queue is empty.
+     * @return The element removed from the front of the queue, or {@code null} if the queue is empty.
      */
     public T poll() {
         return isEmpty() ? null : elementList.removeFirst();