Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Swift: Pass array by reference?

People also ask

Does Swift pass array by reference?

Structs in Swift are passed by value, but you can use the inout modifier to modify your array (see answers below). Classes are passed by reference. Array and Dictionary in Swift are implemented as structs.

Is Swift pass by value or pass by reference?

In Swift, instances of classes are passed by reference. This is similar to how classes are implemented in Ruby and Objective-C. It implies that an instance of a class can have several owners that share a copy. Instances of structures and enumerations are passed by value.


For function parameter operator we use:

let (it's default operator, so we can omit let) to make a parameter constant (it means we cannot modify even local copy);

var to make it variable (we can modify it locally, but it wont affect the external variable that has been passed to the function); and

inout to make it an in-out parameter. In-out means in fact passing variable by reference, not by value. And it requires not only to accept value by reference, by also to pass it by reference, so pass it with & - foo(&myVar) instead of just foo(myVar)

So do it like this:

var arr = [1, 2, 3]

func addItem(_ localArr: inout [Int]) {
    localArr.append(4)
}

addItem(&arr)    
print(arr) // it will print [1, 2, 3, 4]

To be exact it's not just a reference, but a real alias for the external variable, so you can do such a trick with any variable type, for example with integer (you can assign new value to it), though it may not be a good practice and it may be confusing to modify the primitive data types like this.


Structs in Swift are passed by value, but you can use the inout modifier to modify your array (see answers below). Classes are passed by reference. Array and Dictionary in Swift are implemented as structs.


Define yourself a BoxedArray<T> that implements the Array interface but delegates all functions to a stored property. As such

class BoxedArray<T> : MutableCollection, Reflectable, ... {
  var array : Array<T>

  // ...

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

Use the BoxedArray anywhere you'd use an Array. Assigning of a BoxedArray will be by reference, it is a class, and thus changes to the stored property, through the Array interface, will be visible to all references.


For Swift versions 3-4 (XCode 8-9), use

var arr = [1, 2, 3]

func addItem(_ localArr: inout [Int]) {
    localArr.append(4)
}

addItem(&arr)
print(arr)

Something like

var a : Int[] = []
func test(inout b : Int[]) {
    b += [1,2,3,4,5]
}
test(&a)
println(a)

???


One other option is to have the consumer of the array ask the owner for it as needed. For example, something along the lines of:

class Account {
    var chats : [String]!
    var chatsViewController : ChatsViewController!

    func InitViewController() {
        chatsViewController.getChats = { return self.chats }
    }

}

class ChatsViewController {
    var getChats: (() -> ([String]))!

    func doSomethingWithChats() {
        let chats = getChats()
        // use it as needed
    }
}

You can then modify the array as much as you like inside the Account class. Note that this doesn't help you if you want to also modify the array from the view controller class.


use a NSMutableArray or a NSArray, which are classes

this way you don't need to implment any wraper and can use the build in bridging

open class NSArray : NSObject, NSCopying, NSMutableCopying, NSSecureCoding, NSFastEnumeration