Merge branch 'master' into test/RegexMatchingTest

Author: siriak

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

@@ -1,19 +1,15 @@
 package com.thealgorithms.stacks;
 
 import java.util.Stack;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 public final class InfixToPostfix {
     private InfixToPostfix() {
     }
 
-    public static void main(String[] args) throws Exception {
-        assert "32+".equals(infix2PostFix("3+2"));
-        assert "123++".equals(infix2PostFix("1+(2+3)"));
-        assert "34+5*6-".equals(infix2PostFix("(3+4)*5-6"));
-    }
-
     public static String infix2PostFix(String infixExpression) throws Exception {
-        if (!BalancedBrackets.isBalanced(infixExpression)) {
+        if (!BalancedBrackets.isBalanced(filterBrackets(infixExpression))) {
             throw new Exception("invalid expression");
         }
         StringBuilder output = new StringBuilder();
@@ -55,4 +51,10 @@ private static int precedence(char operator) {
             return -1;
         }
     }
+
+    private static String filterBrackets(String input) {
+        Pattern pattern = Pattern.compile("[^(){}\\[\\]<>]");
+        Matcher matcher = pattern.matcher(input);
+        return matcher.replaceAll("");
+    }
 }

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

@@ -5,8 +5,15 @@
 import java.util.function.BiFunction;
 
 /**
- * @brief Utility class evaluating postix expressions, cf. https://en.wikipedia.org/wiki/Reverse_Polish_notation
- * @details The computation is done using Integers.
+ * Utility class for evaluating postfix expressions using integer arithmetic.
+ * <p>
+ * Postfix notation, also known as Reverse Polish Notation (RPN), is a mathematical notation in which operators follow their operands.
+ * This class provides a method to evaluate expressions written in postfix notation.
+ * </p>
+ * <p>
+ * For more information on postfix notation, refer to
+ * <a href="https://en.wikipedia.org/wiki/Reverse_Polish_notation">Reverse Polish Notation (RPN) on Wikipedia</a>.
+ * </p>
  */
 public final class StackPostfixNotation {
     private StackPostfixNotation() {
@@ -55,7 +62,7 @@ private static void consumeExpression(Stack<Integer> s, final String exp) {
      * @exception IllegalArgumentException exp is not a valid postix expression.
      */
     public static int postfixEvaluate(final String exp) {
-        Stack<Integer> s = new Stack<Integer>();
+        Stack<Integer> s = new Stack<>();
         consumeExpression(s, exp);
         if (s.size() != 1) {
             throw new IllegalArgumentException("exp is not a proper postfix expression.");

src/test/java/com/thealgorithms/stacks/InfixToPostfixTest.java

@@ -0,0 +1,33 @@
+package com.thealgorithms.stacks;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.util.stream.Stream;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+class InfixToPostfixTest {
+
+    @ParameterizedTest
+    @MethodSource("provideValidExpressions")
+    void testValidExpressions(String infix, String expectedPostfix) throws Exception {
+        assertEquals(expectedPostfix, InfixToPostfix.infix2PostFix(infix));
+    }
+
+    private static Stream<Arguments> provideValidExpressions() {
+        return Stream.of(Arguments.of("3+2", "32+"), Arguments.of("1+(2+3)", "123++"), Arguments.of("(3+4)*5-6", "34+5*6-"));
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideInvalidExpressions")
+    void testInvalidExpressions(String infix, String expectedMessage) {
+        Exception exception = assertThrows(Exception.class, () -> InfixToPostfix.infix2PostFix(infix));
+        assertEquals(expectedMessage, exception.getMessage());
+    }
+
+    private static Stream<Arguments> provideInvalidExpressions() {
+        return Stream.of(Arguments.of("((a+b)*c-d", "invalid expression"));
+    }
+}

src/test/java/com/thealgorithms/stacks/StackPostfixNotationTest.java

@@ -1,43 +1,32 @@
 package com.thealgorithms.stacks;
 
-import static java.util.Map.entry;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
-import java.util.Map;
-import org.junit.jupiter.api.Test;
+import java.util.stream.Stream;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 
 public class StackPostfixNotationTest {
-    @Test
-    public void testEvaluate() {
-        final Map<String, Integer> testCases = Map.ofEntries(entry("1 1 +", 2), entry("2 3 *", 6), entry("6 2 /", 3), entry("-5 -2 -", -3), entry("5 2 + 3 *", 21), entry("-5", -5));
-        for (final var tc : testCases.entrySet()) {
-            assertEquals(tc.getValue(), StackPostfixNotation.postfixEvaluate(tc.getKey()));
-        }
-    }
-
-    @Test
-    public void testIfEvaluateThrowsExceptionForEmptyInput() {
-        assertThrows(IllegalArgumentException.class, () -> StackPostfixNotation.postfixEvaluate(""));
-    }
 
-    @Test
-    public void testIfEvaluateThrowsExceptionForInproperInput() {
-        assertThrows(IllegalArgumentException.class, () -> StackPostfixNotation.postfixEvaluate("3 3 3"));
+    @ParameterizedTest
+    @MethodSource("provideValidTestCases")
+    void testEvaluate(String expression, int expected) {
+        assertEquals(expected, StackPostfixNotation.postfixEvaluate(expression));
     }
 
-    @Test
-    public void testIfEvaluateThrowsExceptionForInputWithUnknownOperation() {
-        assertThrows(IllegalArgumentException.class, () -> StackPostfixNotation.postfixEvaluate("3 3 !"));
+    static Stream<Arguments> provideValidTestCases() {
+        return Stream.of(Arguments.of("1 1 +", 2), Arguments.of("2 3 *", 6), Arguments.of("6 2 /", 3), Arguments.of("-5 -2 -", -3), Arguments.of("5 2 + 3 *", 21), Arguments.of("-5", -5));
     }
 
-    @Test
-    public void testIfEvaluateThrowsExceptionForInputWithTooFewArgsA() {
-        assertThrows(IllegalArgumentException.class, () -> StackPostfixNotation.postfixEvaluate("+"));
+    @ParameterizedTest
+    @MethodSource("provideInvalidTestCases")
+    void testEvaluateThrowsException(String expression) {
+        assertThrows(IllegalArgumentException.class, () -> StackPostfixNotation.postfixEvaluate(expression));
     }
 
-    @Test
-    public void testIfEvaluateThrowsExceptionForInputWithTooFewArgsB() {
-        assertThrows(IllegalArgumentException.class, () -> StackPostfixNotation.postfixEvaluate("2 +"));
+    static Stream<Arguments> provideInvalidTestCases() {
+        return Stream.of(Arguments.of(""), Arguments.of("3 3 3"), Arguments.of("3 3 !"), Arguments.of("+"), Arguments.of("2 +"));
     }
 }