[Swift] 공식 문서 정리 (12) - Subscripts (서브 스크립트, [])

안녕하세요, 감자입니다. 오늘은 서브스크립트에 대해서 공부해보았습니다. 코드를 살펴보면, string에서 인덱스로 접근하는 방식에 대해서도 나오는데요, 이 부분에 대해서도 파이썬에서는 자연스럽게 되는데, 왜 안돼!!! 하면서 성질냈던 기억이 있네요 허허... 서브스크립트를 활용하면 문자열에서도 [index]를 활용하여 접근할 수 있다는 사실! 그럼 이제 살펴보도록 하죠.

Swift Documents chap.12 Subscripts 바로가기

Subscripts — The Swift Programming Language (Swift 5.6)

---

 

Subscripts란?

클래스, 구조체, 그리고 열거형에서 시퀀스의 멤버 요소에 접근하기 위한 바로가기 첨자로, 단일 타입에 여러 서브 스크립트를 정의할 수 있다. 서브스크립트를 이용하면 추가적인 메서드 없이 특정 값을 할당하거나 가져올 수 있다.

우리는 평소에 서브스크립트를 자주 사용해왔다. 배열에 접근하기 위해서는 someArray[index]로, 딕셔너리에 접근하기 위해서는 someDictionary[index]로 [] 를 활용하여 접근할 수 있었다. 이 [] 가 바로 서브스크립트이다.

배열 index에 접근하는 []의 정의를 따라가보면, 아래와 같다.

@inlinable public subscript(index: Int) -> Element

[]는 이렇게 정의되어 있는데, 배열의 서브스크립트는 parameter로 Int형을 index로 받고, 해당 index에 해당하는 Element를 반환하는 형태임을 알 수 있다.

서브스크립트는 이처럼 시퀀스의 멤버 요소에 접근할 때 사용된다.

 

Subscript Syntax (서브스크립트 문법)

서브 스크립트 선언 문법은 인스턴스 메서드와 연산 프로퍼티를 선언하는 것과 비슷하다. 인스턴스 메서드와 다른 점은, 서브스크립트는 읽고-쓰기 혹은 읽기 전용만 가능하다는 것이다. 정의는 연산 프로퍼티 방식과 같이 setter, getter 방식을 따른다.

subscript(index: Int) -> Int {
    get {
        // 적절한 반환 값
    }
    set(newValue) {
        // 적절한 set 액션
    }
}

서브스크립트의 set에 대한 인자 값을 따로 지정하지 않으면, 기본 값으로 newValue를 사용한다. 읽기 전용으로 선언하려면, get, set을 지우고 따로 지정하지 않고 작성하게 되면 get으로 동작하게 되서 읽기 전용으로 선언된다.

아래 코드는 읽기 전용으로 선언된 서브스크립트 코드이다.

/*---------읽기 전용 기본 형태--------*/
subscript(index: Int) -> Int {
    // 적절한 반환 값
}

struct TimesTable {
    let multiplier: Int
    subscript(index: Int) -> Int {
        return multiplier * index
    }
}
let threeTimesTable = TimesTable(multiplier: 3)
print("six times three is \\(threeTimesTable[6])")
// "six times three is 18" 출력

▷ 코드 설명

• TimeTable 구조체의 multiplier를 3으로 설정하고 threeTimesTable[6]에서 6번째 값, 여기서는 3에 6을 곱한값을 출력함.

 

Subscript Usage (서브스트립트 사용하기)

서브스크립트 사용 예시를 살펴보자.

var numberOfLegs = ["spider": 8, "ant": 6, "cat": 4]
numberOfLegs["bird"] = 2

numberOfLegs 값은 타입 추론에 의해 [String: Int]형을 갖는다. numberOfLegs[”bird”] = 2 는 사전형 변수 numberOfLegs 에 key로 bird를 , 그 값은 2를 넣으려는 서브스크립트 문법이다.

▷ note

• 딕셔너리의 반환값은 optional이다. 사전에 특정 키 값이 없는 경우가 있을 수 있기 때문이다.

 

서브스크립트 사용하기 (1)

let name = "jisoo"
name[0]  //ERROR

name[0]을 하면 제일 앞에있는 알파벳 “j”가 반환되면 좋겠지만, 이는 에러이다. 해당 스크립트를 사용할 수 없다는 에러가 발생할 것이다. 우리는 이제 값에 접근하기 위한 서브스크립트를 정의하는 방법을 배웠으니, 이렇게 인덱스로 알파벳에 접근하는 서브스크립트를 간단하게 만들어보자.

extension String {
	subscript(idx: Int) -> String? {
		guard(0..<count).conrtains(idx) else {
				return nil
		}
		let target = index(startIndex, offsetBy: idx)
		return String(self[target])
	}
}

이렇게 String을 확장하여 서브스크립트를 직접구현해주면 아래처럼 우리가 원하는 방식으로 String에 접근할 수 있다.

let name = "jisoo"
name[0]  //optional("j")
name[100]  //nil 

 

서브스크립트 사용하기 (2)

struct Stack {
	var stack: [Int] = [0,1,2,3,4,5]

	subscript(index: Int) -> Int {
		get {
			return stack[index]
		}
		set {
			stack[index] = newValue
		}
	}
}

/*---------- []를 통해 getter, setter에 접근하기 ------------*/
var stack: Stack = .init()
stack[0]   // 서브스크립트 getter에 접근
stack[1] = 2   // 서브스크립트 setter 에 접근

 

Subscript Options

서브스크립트는 입력 인자의 숫자에 제한이 없고, 입력 인자의 타입과 반환타입의 제한도 없다. 다만 in-out 파라미터나 기본 파라미터 값을 제공할 수는 없다. 서브스크립트는 오버로딩도 허용한다. 그래서 인자형, 반환형에 따라 원하는 수 만큼의 서브스크립트를 선언할 수 있다. 다음은 서브스크립트를 이용하여 다차원 행렬을 선언하고 접근하는 예시이다.

struct Matrix {
    let rows: Int, columns: Int
    var grid: [Double]
    init(rows: Int, columns: Int) {
        self.rows = rows
        self.columns = columns
        grid = Array(repeating: 0.0, count: rows * columns)
    }
    func indexIsValid(row: Int, column: Int) -> Bool {
        return row >= 0 && row < rows && column >= 0 && column < columns
    }
    subscript(row: Int, column: Int) -> Double {
        get {
            assert(indexIsValid(row: row, column: column), "Index out of range")
            return grid[(row * columns) + column]
        }
        set {
            assert(indexIsValid(row: row, column: column), "Index out of range")
            grid[(row * columns) + column] = newValue
        }
    }
}

위 코드에서 subscript(row: Int, column: Int) -> Double 코드와 같이 row, column 2개의 인자를 받고, Double을 반환하는 서브스크립트를 선언했다. get, set 각각에 indexIsValid메서드를 사용해서 유요한 인덱스가 아닌 경우 프로그램이 바로 종료되도록 assert를 호출했다. 선언한 스크립트 문법을 이용해 var matrix = Matrix(rows: 2, columns: 2) 2 by 2 행렬을 선언한다.

grid 배열은 서브스크립트에 의해 위와 같이 row와 column을 갖는 행렬도 동작한다. 행렬에 서브스크립트를 이용해 특정 row, column에 값을 넣을 수 있다.

matrix[0, 1] = 1.5
matrix[1, 0] = 3.2

값을 넣은 결과 행렬은 아래와 같다.

 

행렬의 입출력시 row나 column의 범위가 적절한지 아래의 코드로 확인할 수 있다.

func indexIsValid(row: Int, column: Int) -> Bool {
    return row >= 0 && row < rows && column >= 0 && column < columns
}

만약 적절한 범위를 벗어나면 assert가 실행된다.

let someValue = matrix[2, 2]
// [2, 2]가 사용할 수 있는 행렬의 범위를 벗어나므로 assert가 실행됩니다.