Skip to content

refactor: StackPostfixNotation #5400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down Expand Up @@ -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.");
Expand Down
Original file line number Diff line number Diff line change
@@ -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 +"));
}
}