배열을 활용한 Stack 구현해보기

Stack에 대한 기본적인 개념

스택(Stack)은 데이터를 일시적으로 저장하기 위한 선형 자료구조로, "후입선출" (Last In, First Out :: LIFO) 원칙을 따릅니다. 이 원칙은 가장 마지막에 추가된 요소가 가장 먼저 제거된다는 것을 의미한다. 스택을 일상생활의 예로 설명하면, 식당에서 사용된 접시를 쌓아 두었다가 사용할 때 가장 위에 있는 접시부터 꺼내는 것과 비슷하다.

스택의 주요 연산

• Push : 스택에 요소를 추가하는 연산이다. 스택의 맨 위에 새로운 요소를 놓는다.
• Pop : 스택에서 요소를 제거하는 연산이다. 스택의 맨 위에 있는 요소를 꺼내며, 그 요소는 스택에서 삭제된다.
• Peek, Top : 스택의 맨 위에 있는 요소를 반환하지만, 제거하지는 않는다. 스택의 최상위 요소를 확인할 때 사용한다.
• IsEmpty : 스택이 비어 있는지 확인한다. 비어 있다면 true, 그렇지 않다면 false를 반환한다.
• Size : 스택에 저장된 요소의 개수를 반환한다.

package structure;

public class MyArrayStack {

	int top;
	TencoIntArray arrayStack;

	public MyArrayStack() {
		top = 0; // 스택 포인터 초기화
		arrayStack = new TencoIntArray(); // 배열칸 10개 생성 됨
	}

	public MyArrayStack(int size) {
		top = 0;
		arrayStack = new TencoIntArray(size);
	}

	// 스택의 크기(요소갯수)를 반환
	public int getSize() {
		return top;
	}

	// 스택이 비어있는지 확인
	public boolean isEmpty() {
		return top == 0;
	}

	// 스택의 요소가 가득 찼는지 확인하는 메서드를 만들어보자.
	public boolean isFull() {
		return top == arrayStack.ARRAY_SIZE;
	}

	// 스택의 모든 요소를 출력하는 기능
	public void printAll() {
		arrayStack.printAll();
	}

	// 스택에 데이터를 추가하는 기능
	public void push(int data) {
		// 방어적 코드
		if (isFull()) {
			System.out.println("메모리가 가득 가득");
			return;
		}
		arrayStack.addElement(data);
		top++;
	}

	// 스택에서 데이터를 제거하는 메서드
	public int pop() {
		if (top == 0) {
			System.out.println("stack is empty !!");
		}
		int temp = peek(); // int 데이터 타입의 값은 변하지 않음
		System.out.println("LOG 1 : " + (top -1));
		arrayStack.removeElement(top - 1);	// 인덱스라 -1, 여기서 값을 지우면 어떤걸 지웠는지 모르기 때문에 temp에 미리 값을 저장
		top--;
		return temp;
	}

	// 스택의 최상위 요소를 반환하지만 제거는 하지 않음
	public int peek() {
		if (top == 0) {
			return TencoIntArray.ERROR_NUM;
		}
		return arrayStack.getElement(top - 1);
	}

	// 코드 테스트
	public static void main(String[] args) {

		MyArrayStack stack = new MyArrayStack();
		stack.push(100);
		stack.push(200);
		stack.push(300);

		// 전체 출력
		// stack.printAll();
		stack.pop();	// 버그 발생 -> 해결 완료 -> pop 에 제거된 요소를 반환할 수 있도록 코드 수정
		System.out.println("--------------------------");
		// stack.printAll();
		System.out.println(stack.peek());
		System.out.println("--------------------------");
		stack.printAll();
		System.out.println(stack.pop());
		
	}// end of main

}

package structure;

/**
 * 배열을 활용한 클래스를 설계 물론 이미 자바 표준 API 개발자들이 잘 만들어 준 클래스들이 존재한다.
 * 하지만 직접 기능을 확장해서 만들어보자.
 */
public class TencoIntArray {

	int[] intArr;
	int count; // 배열 안에 들어간 요소의 갯수
	public final int ARRAY_SIZE;
	public static final int ERROR_NUM = -99999999;

	public TencoIntArray() {
		count = 0;
		ARRAY_SIZE = 10;
		intArr = new int[ARRAY_SIZE];
	}

	public TencoIntArray(int size) {
		count = 0;
		ARRAY_SIZE = size;
		intArr = new int[ARRAY_SIZE];
	}

	// 기능 설계
	// 배열 요소의 제일 뒤에 값을 추가하는 기능을 가진다.
	public void addElement(int inputData) {
		// 방어적 코드 필요
		if (count >= ARRAY_SIZE) {
			System.out.println("메모리 공간이 가득 찼습니다.");
			return; // 실행의 제어권을 반납
		}

		intArr[count] = inputData;
		count++;
	}

	// 지정한 인덱스 번호에 요소를 꺼내주기
	public int getElement(int position) {
		// 배열의 크기 10
		// [0] [1] [2]
		if (position < 0 || position > count - 1) {
			System.out.println("검색 위치 오류. 현재 리스트의 갯수는 " + count + "개 입니다.");
			return ERROR_NUM;
		}
		return intArr[position];
	}

	// 요소를 전체 출력하는 기능 만들어주기
	public void printAll() {
		if (count == 0) {
			System.out.println("출력할 내용이 없습니다.");
			return;
		}

		for (int i = 0; i < intArr.length; i++) {
			System.out.println(intArr[i]);
		}
//		for (int i : intArr) {
//			System.out.println(intArr[i]);
//		}
	}

	// 전체 삭제하는 기능
	public void removeAll() {
		for (int i = 0; i < intArr.length; i++) {
			intArr[i] = 0;
		}
		// 요소의 갯수 상태를 항상 관리하고 처리해야 한다.
		count = 0;
	}

	// 배열의 크기가 아닌 현재 요소의 갯수를 반환
	public int getCountSize() {
		return count;
	}

	// 현재 요소가 하나도 없는 상태이다.
	public boolean isEmpty() {
		if (count == 0) {
			return true;
		} else {
			return false;
		}
	}

	// 배열의 지정한 인덱스 위치에 값을 삽입 하기
	public void insertElement(int position, int inputData) {
		// 방어적 코드 작성 1
		if (count >= ARRAY_SIZE) {
			System.out.println("메모리 공간이 가득 찼습니다.");
			return; // 실행의 제어권을 반납
		}

		// 방어적 코드 2
		// 10 0
		if (position < 0 || ARRAY_SIZE < position) {
			System.out.println("지정한 인덱스 번호가 잘못 되었습니다.");
			return;
		}

		// 요청값 : position -> 3
		// [11, 12, 13, [] 14, 15]
		// [11, 12, 13, [], 14, 15]
		for (int i = count - 1; i >= position; i--) {
			intArr[i + 1] = intArr[i]; // 하나씩
			// intArr[5] = 15; 수행1
			// intArr[4] = 14; 수행2
		}

		intArr[position] = inputData;
		count++;
	}

	// 지정한 인덱스 번호의 요소를 삭제하기
	public void removeElement(int position) {
		// 방어적 코드
		if (isEmpty()) {
			System.out.println("삭제할 요소가 없습니다.");
		}
		// position : 2 <- 넘겨 받은 값
		System.out.println("Log 2 : " + count);

		// 인덱스 범위를 잘못 지정했다면 방어적 코드
		if (position < 0 || position >= count) {
			System.out.println("잘못된 요청입니다.");
		}

		//   0     1     2
		// [100] [200] [300]
		for (int i = position; i < count; i++) {
			intArr[i] = intArr[i + 1];
		}
		count--;
	}

}