refactor: review and group scattered palindrome implementation (#7487)

* feat: add utility to find lowest base for palindromic numbers and implement palindrome check for singly linked lists

* feat: add palindrome check for linked lists and find lowest base palindrome implementation

* feat: add utility to check if an integer's binary representation is a palindrome

* feat: add algorithm to check if a singly linked list is a palindrome

* feat: add PalindromeNumber utility class to check for palindromic integers

* style: remove redundant import to fix checkstyle error

* style: add blank line between static and non-static imports

Author: priyanshuvishwakarma273403

src/main/java/com/thealgorithms/bitmanipulation/BinaryPalindromeCheck.java

@@ -9,6 +9,12 @@
  * </p>
  *
  * @author Hardvan
+ * @see com.thealgorithms.strings.Palindrome
+ * @see com.thealgorithms.stacks.PalindromeWithStack
+ * @see com.thealgorithms.maths.LowestBasePalindrome
+ * @see com.thealgorithms.datastructures.lists.PalindromeSinglyLinkedList
+ * @see com.thealgorithms.maths.PalindromePrime
+ * @see com.thealgorithms.maths.PalindromeNumber
  */
 public final class BinaryPalindromeCheck {
     private BinaryPalindromeCheck() {

…hms/misc/PalindromeSinglyLinkedList.java …es/lists/PalindromeSinglyLinkedList.javasrc/main/java/com/thealgorithms/misc/PalindromeSinglyLinkedList.java renamed to src/main/java/com/thealgorithms/datastructures/lists/PalindromeSinglyLinkedList.java src/main/java/com/thealgorithms/misc/PalindromeSinglyLinkedList.java renamed to src/main/java/com/thealgorithms/datastructures/lists/PalindromeSinglyLinkedList.java

@@ -1,4 +1,4 @@
-package com.thealgorithms.misc;
+package com.thealgorithms.datastructures.lists;
 
 import java.util.Stack;
 
@@ -9,6 +9,13 @@
  *
  * See more:
  * https://www.geeksforgeeks.org/function-to-check-if-a-singly-linked-list-is-palindrome/
+ *
+ * @see com.thealgorithms.strings.Palindrome
+ * @see com.thealgorithms.stacks.PalindromeWithStack
+ * @see com.thealgorithms.bitmanipulation.BinaryPalindromeCheck
+ * @see com.thealgorithms.maths.LowestBasePalindrome
+ * @see com.thealgorithms.maths.PalindromePrime
+ * @see com.thealgorithms.maths.PalindromeNumber
  */
 @SuppressWarnings("rawtypes")
 public final class PalindromeSinglyLinkedList {

…orithms/others/LowestBasePalindrome.java …gorithms/maths/LowestBasePalindrome.javasrc/main/java/com/thealgorithms/others/LowestBasePalindrome.java renamed to src/main/java/com/thealgorithms/maths/LowestBasePalindrome.java src/main/java/com/thealgorithms/others/LowestBasePalindrome.java renamed to src/main/java/com/thealgorithms/maths/LowestBasePalindrome.java

@@ -1,4 +1,4 @@
-package com.thealgorithms.others;
+package com.thealgorithms.maths;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -23,6 +23,12 @@
  *
  * @see <a href="https://oeis.org/A016026">OEIS A016026 - Smallest base in which
  *      n is palindromic</a>
+ * @see com.thealgorithms.strings.Palindrome
+ * @see com.thealgorithms.stacks.PalindromeWithStack
+ * @see com.thealgorithms.bitmanipulation.BinaryPalindromeCheck
+ * @see com.thealgorithms.datastructures.lists.PalindromeSinglyLinkedList
+ * @see com.thealgorithms.maths.PalindromePrime
+ * @see com.thealgorithms.maths.PalindromeNumber
  * @author TheAlgorithms Contributors
  */
 public final class LowestBasePalindrome {

src/main/java/com/thealgorithms/maths/PalindromeNumber.java

@@ -1,5 +1,16 @@
 package com.thealgorithms.maths;
 
+/**
+ * A class to check if a given number is a palindrome.
+ * A palindromic number is a number that remains the same when its digits are reversed.
+ *
+ * @see com.thealgorithms.strings.Palindrome
+ * @see com.thealgorithms.stacks.PalindromeWithStack
+ * @see com.thealgorithms.bitmanipulation.BinaryPalindromeCheck
+ * @see com.thealgorithms.maths.LowestBasePalindrome
+ * @see com.thealgorithms.datastructures.lists.PalindromeSinglyLinkedList
+ * @see com.thealgorithms.maths.PalindromePrime
+ */
 public final class PalindromeNumber {
     private PalindromeNumber() {
     }

…/thealgorithms/misc/PalindromePrime.java …thealgorithms/maths/PalindromePrime.javasrc/main/java/com/thealgorithms/misc/PalindromePrime.java renamed to src/main/java/com/thealgorithms/maths/PalindromePrime.java src/main/java/com/thealgorithms/misc/PalindromePrime.java renamed to src/main/java/com/thealgorithms/maths/PalindromePrime.java

@@ -1,8 +1,19 @@
-package com.thealgorithms.misc;
+package com.thealgorithms.maths;
 
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * A class to check and generate palindromic prime numbers.
+ * A palindromic prime is a prime number that is also a palindromic number.
+ *
+ * @see com.thealgorithms.strings.Palindrome
+ * @see com.thealgorithms.stacks.PalindromeWithStack
+ * @see com.thealgorithms.bitmanipulation.BinaryPalindromeCheck
+ * @see com.thealgorithms.maths.LowestBasePalindrome
+ * @see com.thealgorithms.datastructures.lists.PalindromeSinglyLinkedList
+ * @see com.thealgorithms.maths.PalindromeNumber
+ */
 public final class PalindromePrime {
     private PalindromePrime() {
     }

src/main/java/com/thealgorithms/stacks/PalindromeWithStack.java

@@ -8,6 +8,13 @@
  * which we will pop one-by-one to create the string in reverse.
  *
  * Reference: https://www.geeksforgeeks.org/check-whether-the-given-string-is-palindrome-using-stack/
+ *
+ * @see com.thealgorithms.strings.Palindrome
+ * @see com.thealgorithms.bitmanipulation.BinaryPalindromeCheck
+ * @see com.thealgorithms.maths.LowestBasePalindrome
+ * @see com.thealgorithms.datastructures.lists.PalindromeSinglyLinkedList
+ * @see com.thealgorithms.maths.PalindromePrime
+ * @see com.thealgorithms.maths.PalindromeNumber
  */
 public class PalindromeWithStack {
     private LinkedList<Character> stack;

src/main/java/com/thealgorithms/strings/Palindrome.java

@@ -2,6 +2,13 @@
 
 /**
  * Wikipedia: https://en.wikipedia.org/wiki/Palindrome
+ *
+ * @see com.thealgorithms.stacks.PalindromeWithStack
+ * @see com.thealgorithms.bitmanipulation.BinaryPalindromeCheck
+ * @see com.thealgorithms.maths.LowestBasePalindrome
+ * @see com.thealgorithms.datastructures.lists.PalindromeSinglyLinkedList
+ * @see com.thealgorithms.maths.PalindromePrime
+ * @see com.thealgorithms.maths.PalindromeNumber
  */
 final class Palindrome {
     private Palindrome() {

…misc/PalindromeSinglyLinkedListTest.java …ists/PalindromeSinglyLinkedListTest.javasrc/test/java/com/thealgorithms/misc/PalindromeSinglyLinkedListTest.java renamed to src/test/java/com/thealgorithms/datastructures/lists/PalindromeSinglyLinkedListTest.java src/test/java/com/thealgorithms/misc/PalindromeSinglyLinkedListTest.java renamed to src/test/java/com/thealgorithms/datastructures/lists/PalindromeSinglyLinkedListTest.java

@@ -1,9 +1,8 @@
-package com.thealgorithms.misc;
+package com.thealgorithms.datastructures.lists;
 
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-import com.thealgorithms.datastructures.lists.SinglyLinkedList;
 import org.junit.jupiter.api.Test;
 
 public class PalindromeSinglyLinkedListTest {

…hms/others/LowestBasePalindromeTest.java …thms/maths/LowestBasePalindromeTest.javasrc/test/java/com/thealgorithms/others/LowestBasePalindromeTest.java renamed to src/test/java/com/thealgorithms/maths/LowestBasePalindromeTest.java src/test/java/com/thealgorithms/others/LowestBasePalindromeTest.java renamed to src/test/java/com/thealgorithms/maths/LowestBasePalindromeTest.java

@@ -1,4 +1,4 @@
-package com.thealgorithms.others;
+package com.thealgorithms.maths;
 
 import java.util.ArrayList;
 import java.util.Arrays;

…algorithms/misc/PalindromePrimeTest.java …lgorithms/maths/PalindromePrimeTest.javasrc/test/java/com/thealgorithms/misc/PalindromePrimeTest.java renamed to src/test/java/com/thealgorithms/maths/PalindromePrimeTest.java src/test/java/com/thealgorithms/misc/PalindromePrimeTest.java renamed to src/test/java/com/thealgorithms/maths/PalindromePrimeTest.java

@@ -1,4 +1,4 @@
-package com.thealgorithms.misc;
+package com.thealgorithms.maths;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;