diff --git a/DIRECTORY.md b/DIRECTORY.md index 06307d4aca78..a78efffb8d85 100644 --- a/DIRECTORY.md +++ b/DIRECTORY.md @@ -598,6 +598,7 @@ * [MaximumMinimumWindow](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/stacks/MaximumMinimumWindow.java) * [NextGreaterElement](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/stacks/NextGreaterElement.java) * [NextSmallerElement](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/stacks/NextSmallerElement.java) + * [PostfixEvaluator](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/stacks/PostfixEvaluator.java) * [PostfixToInfix](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/stacks/PostfixToInfix.java) * [PrefixToInfix](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/stacks/PrefixToInfix.java) * [SortStack](https://github.com/TheAlgorithms/Java/blob/master/src/main/java/com/thealgorithms/stacks/SortStack.java) @@ -1128,6 +1129,7 @@ * [LargestRectangleTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/stacks/LargestRectangleTest.java) * [NextGreaterElementTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/stacks/NextGreaterElementTest.java) * [NextSmallerElementTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/stacks/NextSmallerElementTest.java) + * [PostfixEvaluatorTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/stacks/PostfixEvaluatorTest.java) * [PostfixToInfixTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/stacks/PostfixToInfixTest.java) * [PrefixToInfixTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/stacks/PrefixToInfixTest.java) * [SortStackTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/stacks/SortStackTest.java) diff --git a/src/main/java/com/thealgorithms/stacks/PostfixEvaluator.java b/src/main/java/com/thealgorithms/stacks/PostfixEvaluator.java new file mode 100644 index 000000000000..02ef5af8da16 --- /dev/null +++ b/src/main/java/com/thealgorithms/stacks/PostfixEvaluator.java @@ -0,0 +1,74 @@ +package com.thealgorithms.stacks; + +import java.util.Set; +import java.util.Stack; + +/** + * Evaluate a postfix (Reverse Polish) expression using a stack. + * + *

Example: Expression "5 6 + 2 *" results in 22. + *

Applications: Used in calculators and expression evaluation in compilers. + * + * @author Hardvan + */ +public final class PostfixEvaluator { + private PostfixEvaluator() { + } + + private static final Set OPERATORS = Set.of("+", "-", "*", "/"); + + /** + * Evaluates the given postfix expression and returns the result. + * + * @param expression The postfix expression as a string with operands and operators separated by spaces. + * @return The result of evaluating the postfix expression. + * @throws IllegalArgumentException if the expression is invalid. + */ + public static int evaluatePostfix(String expression) { + Stack stack = new Stack<>(); + + for (String token : expression.split("\\s+")) { + if (isOperator(token)) { + int operand2 = stack.pop(); + int operand1 = stack.pop(); + stack.push(applyOperator(token, operand1, operand2)); + } else { + stack.push(Integer.valueOf(token)); + } + } + + if (stack.size() != 1) { + throw new IllegalArgumentException("Invalid expression"); + } + + return stack.pop(); + } + + /** + * Checks if the given token is an operator. + * + * @param token The token to check. + * @return true if the token is an operator, false otherwise. + */ + private static boolean isOperator(String token) { + return OPERATORS.contains(token); + } + + /** + * Applies the given operator to the two operands. + * + * @param operator The operator to apply. + * @param a The first operand. + * @param b The second operand. + * @return The result of applying the operator to the operands. + */ + private static int applyOperator(String operator, int a, int b) { + return switch (operator) { + case "+" -> a + b; + case "-" -> a - b; + case "*" -> a * b; + case "/" -> a / b; + default -> throw new IllegalArgumentException("Invalid operator"); + }; + } +} diff --git a/src/test/java/com/thealgorithms/stacks/PostfixEvaluatorTest.java b/src/test/java/com/thealgorithms/stacks/PostfixEvaluatorTest.java new file mode 100644 index 000000000000..882fe644ccd5 --- /dev/null +++ b/src/test/java/com/thealgorithms/stacks/PostfixEvaluatorTest.java @@ -0,0 +1,27 @@ +package com.thealgorithms.stacks; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; + +import java.util.EmptyStackException; +import org.junit.jupiter.api.Test; + +public class PostfixEvaluatorTest { + + @Test + public void testValidExpressions() { + assertEquals(22, PostfixEvaluator.evaluatePostfix("5 6 + 2 *")); + assertEquals(27, PostfixEvaluator.evaluatePostfix("7 2 + 3 *")); + assertEquals(3, PostfixEvaluator.evaluatePostfix("10 5 / 1 +")); + } + + @Test + public void testInvalidExpression() { + assertThrows(EmptyStackException.class, () -> PostfixEvaluator.evaluatePostfix("5 +")); + } + + @Test + public void testMoreThanOneStackSizeAfterEvaluation() { + assertThrows(IllegalArgumentException.class, () -> PostfixEvaluator.evaluatePostfix("5 6 + 2 * 3")); + } +}