String.UnicodeScalarView

struct String.UnicodeScalarView

A view of a string's contents as a collection of Unicode scalar values.

You can access a string's view of Unicode scalar values by using its unicodeScalars property. Unicode scalar values are the 21-bit codes that are the basic unit of Unicode. Each scalar value is represented by a UnicodeScalar instance and is equivalent to a UTF-32 code unit.

let flowers = "Flowers πŸ’"
for v in flowers.unicodeScalars {
    print(v.value)
}
// 70
// 108
// 111
// 119
// 101
// 114
// 115
// 32
// 128144

Some characters that are visible in a string are made up of more than one Unicode scalar value. In that case, a string's unicodeScalars view contains more values than its characters view.

let flag = "πŸ‡΅πŸ‡·"
for c in flag.characters {
    print(c)
}
// πŸ‡΅πŸ‡·

for v in flag.unicodeScalars {
    print(v.value)
}
// 127477
// 127479

You can convert a String.UnicodeScalarView instance back into a string using the String type's init(_:) initializer.

let favemoji = "My favorite emoji is πŸŽ‰"
if let i = favemoji.unicodeScalars.index(where: { $0.value >= 128 }) {
    let asciiPrefix = String(favemoji.unicodeScalars.prefix(upTo: i))
    print(asciiPrefix)
}
// Prints "My favorite emoji is "
Inheritance BidirectionalCollection, Collection, CustomDebugStringConvertible, CustomPlaygroundQuickLookable, CustomReflectable, CustomStringConvertible, RangeReplaceableCollection, Sequence View Protocol Hierarchy →
Nested Types String.UnicodeScalarView.Index, String.UnicodeScalarView.Iterator
Import import Swift

Initializers

init()

Creates an empty view instance.

Declaration

init()
init(_:)

Creates a new instance of a collection containing the elements of a sequence.

elements: The sequence of elements for the new collection.

Declaration

init<S where S : Sequence, S.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_ elements: S)

Declared In

RangeReplaceableCollection
init(repeating:count:)

Creates a new collection containing the specified number of a single, repeated value.

Here's an example of creating an array initialized with five strings containing the letter Z.

let fiveZs = Array(repeating: "Z", count: 5)
print(fiveZs)
// Prints "["Z", "Z", "Z", "Z", "Z"]"

Parameters: repeatedValue: The element to repeat. count: The number of times to repeat the value passed in the repeating parameter. count must be zero or greater.

Declaration

init(repeating repeatedValue: String.UnicodeScalarView.Iterator.Element, count: Int)

Declared In

RangeReplaceableCollection

Instance Variables

var count: String.UnicodeScalarView.IndexDistance

The number of elements in the collection.

To check whether a collection is empty, use its isEmpty property instead of comparing count to zero. Unless the collection guarantees random-access performance, calculating count can be an O(n) operation.

Complexity: O(1) if the collection conforms to RandomAccessCollection; otherwise, O(n), where n is the length of the collection.

Declaration

var count: String.UnicodeScalarView.IndexDistance { get }

Declared In

BidirectionalCollection , RangeReplaceableCollection , Collection
var customMirror: Mirror

Returns a mirror that reflects the Unicode scalars view of a string.

Declaration

var customMirror: Mirror { get }
var customPlaygroundQuickLook: PlaygroundQuickLook

A custom playground Quick Look for this instance.

If this type has value semantics, the PlaygroundQuickLook instance should be unaffected by subsequent mutations.

Declaration

var customPlaygroundQuickLook: PlaygroundQuickLook { get }
var debugDescription: String

A textual representation of this instance, suitable for debugging.

Declaration

var debugDescription: String { get }
var description: String

A textual representation of this instance.

Instead of accessing this property directly, convert an instance of any type to a string by using the String(describing:) initializer. For example:

struct Point: CustomStringConvertible {
    let x: Int, y: Int

    var description: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(describing: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's description property.

Declaration

var description: String { get }
var endIndex: String.UnicodeScalarView.Index

The "past the end" position---that is, the position one greater than the last valid subscript argument.

In an empty Unicode scalars view, endIndex is equal to startIndex.

Declaration

var endIndex: String.UnicodeScalarView.Index { get }
var first: String.UnicodeScalarView.Iterator.Element?

The first element of the collection.

If the collection is empty, the value of this property is nil.

let numbers = [10, 20, 30, 40, 50]
if let firstNumber = numbers.first {
    print(firstNumber)
}
// Prints "10"

Declaration

var first: String.UnicodeScalarView.Iterator.Element? { get }

Declared In

BidirectionalCollection , RangeReplaceableCollection , Collection
var isEmpty: Bool

A Boolean value indicating whether the collection is empty.

When you need to check whether your collection is empty, use the isEmpty property instead of checking that the count property is equal to zero. For collections that don't conform to RandomAccessCollection, accessing the count property iterates through the elements of the collection.

let horseName = "Silver"
if horseName.characters.isEmpty {
    print("I've been through the desert on a horse with no name.")
} else {
    print("Hi ho, \(horseName)!")
}
// Prints "Hi ho, Silver!")

Complexity: O(1)

Declaration

var isEmpty: Bool { get }

Declared In

BidirectionalCollection , RangeReplaceableCollection , Collection
var last: String.UnicodeScalarView.Iterator.Element?

The last element of the collection.

If the collection is empty, the value of this property is nil.

let numbers = [10, 20, 30, 40, 50]
if let lastNumber = numbers.last {
    print(lastNumber)
}
// Prints "50"

Declaration

var last: String.UnicodeScalarView.Iterator.Element? { get }

Declared In

BidirectionalCollection
var lazy: LazyBidirectionalCollection<String.UnicodeScalarView>

A view onto this collection that provides lazy implementations of normally eager operations, such as map and filter.

Use the lazy property when chaining operations to prevent intermediate operations from allocating storage, or when you only need a part of the final collection to avoid unnecessary computation.

See Also: LazySequenceProtocol, LazyCollectionProtocol.

Declaration

var lazy: LazyBidirectionalCollection<String.UnicodeScalarView> { get }

Declared In

BidirectionalCollection
var startIndex: String.UnicodeScalarView.Index

The position of the first Unicode scalar value if the string is nonempty.

If the string is empty, startIndex is equal to endIndex.

Declaration

var startIndex: String.UnicodeScalarView.Index { get }
var underestimatedCount: Int

A value less than or equal to the number of elements in the collection.

Complexity: O(1) if the collection conforms to RandomAccessCollection; otherwise, O(n), where n is the length of the collection.

Declaration

var underestimatedCount: Int { get }

Declared In

BidirectionalCollection , RangeReplaceableCollection , Collection , Sequence

Subscripts

subscript(_: Range<String.UnicodeScalarView.Index>)

Accesses the Unicode scalar values in the given range.

The example below uses this subscript to access the scalar values up to, but not including, the first comma (",") in the string.

let str = "All this happened, more or less."
let i = str.unicodeScalars.index(of: ",")!
let substring = str.unicodeScalars[str.unicodeScalars.startIndex ..< i]
print(String(substring))
// Prints "All this happened"

Complexity: O(n) if the underlying string is bridged from Objective-C, where n is the length of the string; otherwise, O(1).

Declaration

subscript(r: Range<String.UnicodeScalarView.Index>) -> String.UnicodeScalarView { get }

Declared In

String.UnicodeScalarView, RangeReplaceableCollection
subscript(_: String.UnicodeScalarView.Index)

Accesses the Unicode scalar value at the given position.

The following example searches a string's Unicode scalars view for a capital letter and then prints the character and Unicode scalar value at the found index:

let greeting = "Hello, friend!"
if let i = greeting.unicodeScalars.index(where: { "A"..."Z" ~= $0 }) {
    print("First capital letter: \(greeting.unicodeScalars[i])")
    print("Unicode scalar value: \(greeting.unicodeScalars[i].value)")
}
// Prints "First capital letter: H"
// Prints "Unicode scalar value: 72"

position: A valid index of the character view. position must be less than the view's end index.

Declaration

subscript(position: String.UnicodeScalarView.Index) -> UnicodeScalar { get }

Instance Methods

mutating func append(_:)

Appends the given Unicode scalar to the view.

c: The character to append to the string.

Declaration

mutating func append(_ x: UnicodeScalar)

Declared In

String.UnicodeScalarView, RangeReplaceableCollection
mutating func append(contentsOf:)

Appends the Unicode scalar values in the given sequence to the view.

newElements: A sequence of Unicode scalar values.

Complexity: O(n), where n is the length of the resulting view.

Declaration

mutating func append<S where S : Sequence, S.Iterator.Element == UnicodeScalar>(contentsOf newElements: S)

Declared In

String.UnicodeScalarView, RangeReplaceableCollection
func contains(where:)

Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.

You can use the predicate to check for an element of a type that doesn't conform to the Equatable protocol, such as the HTTPResponse enumeration in this example.

enum HTTPResponse {
    case ok
    case error(Int)
}

let lastThreeResponses: [HTTPResponse] = [.ok, .ok, .error(404)]
let hadError = lastThreeResponses.contains { element in
    if case .error = element {
        return true
    } else {
        return false
    }
}
// 'hadError' == true

Alternatively, a predicate can be satisfied by a range of Equatable elements or a general condition. This example shows how you can check an array for an expense greater than $100.

let expenses = [21.37, 55.21, 9.32, 10.18, 388.77, 11.41]
let hasBigPurchase = expenses.contains { $0 > 100 }
// 'hasBigPurchase' == true

predicate: A closure that takes an element of the sequence as its argument and returns a Boolean value that indicates whether the passed element represents a match. Returns: true if the sequence contains an element that satisfies predicate; otherwise, false.

Declaration

func contains(where predicate: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> Bool

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func drop(while:)

Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.

predicate: A closure that takes an element of the sequence as its argument and returns true if the element should be skipped or false if it should be included. Once the predicate returns false it will not be called again.

Complexity: O(n), where n is the length of the collection.

Declaration

func drop(while predicate: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
func dropFirst()

Returns a subsequence containing all but the first element of the sequence.

The following example drops the first element from an array of integers.

let numbers = [1, 2, 3, 4, 5]
print(numbers.dropFirst())
// Prints "[2, 3, 4, 5]"

If the sequence has no elements, the result is an empty subsequence.

let empty: [Int] = []
print(empty.dropFirst())
// Prints "[]"

Returns: A subsequence starting after the first element of the sequence.

Complexity: O(1)

Declaration

func dropFirst() -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func dropFirst(_:)

Returns a subsequence containing all but the given number of initial elements.

If the number of elements to drop exceeds the number of elements in the collection, the result is an empty subsequence.

let numbers = [1, 2, 3, 4, 5]
print(numbers.dropFirst(2))
// Prints "[3, 4, 5]"
print(numbers.dropFirst(10))
// Prints "[]"

n: The number of elements to drop from the beginning of the collection. n must be greater than or equal to zero. Returns: A subsequence starting after the specified number of elements.

Complexity: O(n), where n is the number of elements to drop from the beginning of the collection.

Declaration

func dropFirst(_ n: Int) -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
func dropLast()

Returns a subsequence containing all but the last element of the sequence.

The sequence must be finite.

let numbers = [1, 2, 3, 4, 5]
print(numbers.dropLast())
// Prints "[1, 2, 3, 4]"

If the sequence has no elements, the result is an empty subsequence.

let empty: [Int] = []
print(empty.dropLast())
// Prints "[]"

Returns: A subsequence leaving off the last element of the sequence.

Complexity: O(n), where n is the length of the sequence.

Declaration

func dropLast() -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func dropLast(_:)

Returns a subsequence containing all but the specified number of final elements.

If the number of elements to drop exceeds the number of elements in the collection, the result is an empty subsequence.

let numbers = [1, 2, 3, 4, 5]
print(numbers.dropLast(2))
// Prints "[1, 2, 3]"
print(numbers.dropLast(10))
// Prints "[]"

n: The number of elements to drop off the end of the collection. n must be greater than or equal to zero. Returns: A subsequence that leaves off n elements from the end.

Complexity: O(n), where n is the number of elements to drop.

Declaration

func dropLast(_ n: Int) -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
func elementsEqual(_:by:)

Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements, using the given predicate as the equivalence test.

At least one of the sequences must be finite.

The predicate must be a equivalence relation over the elements. That is, for any elements a, b, and c, the following conditions must hold:

  • areEquivalent(a, a) is always true. (Reflexivity)
  • areEquivalent(a, b) implies areEquivalent(b, a). (Symmetry)
  • If areEquivalent(a, b) and areEquivalent(b, c) are both true, then areEquivalent(a, c) is also true. (Transitivity)

Parameters: other: A sequence to compare to this sequence. areEquivalent: A predicate that returns true if its two arguments are equivalent; otherwise, false. Returns: true if this sequence and other contain equivalent items, using areEquivalent as the equivalence test; otherwise, false.

See Also: elementsEqual(_:)

Declaration

func elementsEqual<OtherSequence where OtherSequence : Sequence, OtherSequence.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_ other: OtherSequence, by areEquivalent: (String.UnicodeScalarView.Iterator.Element, String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> Bool

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func enumerated()

Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero, and x represents an element of the sequence.

This example enumerates the characters of the string "Swift" and prints each character along with its place in the string.

for (n, c) in "Swift".characters.enumerated() {
    print("\(n): '\(c)'")
}
// Prints "0: 'S'"
// Prints "1: 'w'"
// Prints "2: 'i'"
// Prints "3: 'f'"
// Prints "4: 't'"

When enumerating a collection, the integer part of each pair is a counter for the enumeration, not necessarily the index of the paired value. These counters can only be used as indices in instances of zero-based, integer-indexed collections, such as Array and ContiguousArray. For other collections the counters may be out of range or of the wrong type to use as an index. To iterate over the elements of a collection with its indices, use the zip(_:_:) function.

This example iterates over the indices and elements of a set, building a list of indices of names with five or fewer letters.

let names: Set = ["Sofia", "Camilla", "Martina", "Mateo", "NicolΓ‘s"]
var shorterIndices: [SetIndex<String>] = []
for (i, name) in zip(names.indices, names) {
    if name.characters.count <= 5 {
        shorterIndices.append(i)
    }
}

Now that the shorterIndices array holds the indices of the shorter names in the names set, you can use those indices to access elements in the set.

for i in shorterIndices {
    print(names[i])
}
// Prints "Sofia"
// Prints "Mateo"

Returns: A sequence of pairs enumerating the sequence.

Declaration

func enumerated() -> EnumeratedSequence<String.UnicodeScalarView>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func filter(_:)

Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.

In this example, filter is used to include only names shorter than five characters.

let cast = ["Vivien", "Marlon", "Kim", "Karl"]
let shortNames = cast.filter { $0.characters.count < 5 }
print(shortNames)
// Prints "["Kim", "Karl"]"

isIncluded: A closure that takes an element of the sequence as its argument and returns a Boolean value indicating whether the element should be included in the returned array. Returns: An array of the elements that includeElement allowed.

Declaration

func filter(_ isIncluded: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> [String.UnicodeScalarView.Iterator.Element]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func first(where:)

Returns the first element of the sequence that satisfies the given predicate.

The following example uses the first(where:) method to find the first negative number in an array of integers:

let numbers = [3, 7, 4, -2, 9, -6, 10, 1]
if let firstNegative = numbers.first(where: { $0 < 0 }) {
    print("The first negative number is \(firstNegative).")
}
// Prints "The first negative number is -2."

predicate: A closure that takes an element of the sequence as its argument and returns a Boolean value indicating whether the element is a match. Returns: The first element of the sequence that satisfies predicate, or nil if there is no element that satisfies predicate.

Declaration

func first(where predicate: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> String.UnicodeScalarView.Iterator.Element?

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func flatMap<ElementOfResult>(_: (String.UnicodeScalarView.Iterator.Element) throws -> ElementOfResult?)

Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.

Use this method to receive an array of nonoptional values when your transformation produces an optional value.

In this example, note the difference in the result of using map and flatMap with a transformation that returns an optional Int value.

let possibleNumbers = ["1", "2", "three", "///4///", "5"]

let mapped: [Int?] = possibleNumbers.map { str in Int(str) }
// [1, 2, nil, nil, 5]

let flatMapped: [Int] = possibleNumbers.flatMap { str in Int(str) }
// [1, 2, 5]

transform: A closure that accepts an element of this sequence as its argument and returns an optional value. Returns: An array of the non-nil results of calling transform with each element of the sequence.

Complexity: O(m + n), where m is the length of this sequence and n is the length of the result.

Declaration

func flatMap<ElementOfResult>(_ transform: (String.UnicodeScalarView.Iterator.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func flatMap<SegmentOfResult where SegmentOfResult : Sequence>(_: (String.UnicodeScalarView.Iterator.Element) throws -> SegmentOfResult)

Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.

Use this method to receive a single-level collection when your transformation produces a sequence or collection for each element.

In this example, note the difference in the result of using map and flatMap with a transformation that returns an array.

let numbers = [1, 2, 3, 4]

let mapped = numbers.map { Array(count: $0, repeatedValue: $0) }
// [[1], [2, 2], [3, 3, 3], [4, 4, 4, 4]]

let flatMapped = numbers.flatMap { Array(count: $0, repeatedValue: $0) }
// [1, 2, 2, 3, 3, 3, 4, 4, 4, 4]

In fact, s.flatMap(transform) is equivalent to Array(s.map(transform).joined()).

transform: A closure that accepts an element of this sequence as its argument and returns a sequence or collection. Returns: The resulting flattened array.

Complexity: O(m + n), where m is the length of this sequence and n is the length of the result. See Also: joined(), map(_:)

Declaration

func flatMap<SegmentOfResult where SegmentOfResult : Sequence>(_ transform: (String.UnicodeScalarView.Iterator.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Iterator.Element]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func forEach(_:)

Calls the given closure on each element in the sequence in the same order as a for-in loop.

The two loops in the following example produce the same output:

let numberWords = ["one", "two", "three"]
for word in numberWords {
    print(word)
}
// Prints "one"
// Prints "two"
// Prints "three"

numberWords.forEach { word in
    print(word)
}
// Same as above

Using the forEach method is distinct from a for-in loop in two important ways:

  1. You cannot use a break or continue statement to exit the current call of the body closure or skip subsequent calls.
  2. Using the return statement in the body closure will exit only from the current call to body, not from any outer scope, and won't skip subsequent calls.

body: A closure that takes an element of the sequence as a parameter.

Declaration

func forEach(_ body: (String.UnicodeScalarView.Iterator.Element) throws -> Swift.Void) rethrows

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func index(after:)

Returns the next consecutive location after i.

Precondition: The next location exists.

Declaration

func index(after i: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.Index
func index(before:)

Returns the previous consecutive location before i.

Precondition: The previous location exists.

Declaration

func index(before i: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.Index
func index(where:)

Returns the first index in which an element of the collection satisfies the given predicate.

You can use the predicate to find an element of a type that doesn't conform to the Equatable protocol or to find an element that matches particular criteria. Here's an example that finds a student name that begins with the letter "A":

let students = ["Kofi", "Abena", "Peter", "Kweku", "Akosua"]
if let i = students.index(where: { $0.hasPrefix("A") }) {
    print("\(students[i]) starts with 'A'!")
}
// Prints "Abena starts with 'A'!"

predicate: A closure that takes an element as its argument and returns a Boolean value that indicates whether the passed element represents a match. Returns: The index of the first element for which predicate returns true. If no elements in the collection satisfy the given predicate, returns nil.

See Also: index(of:)

Declaration

func index(where predicate: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> String.UnicodeScalarView.Index?

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
mutating func insert(_:at:)

Inserts a new element into the collection at the specified position.

The new element is inserted before the element currently at the specified index. If you pass the collection's endIndex property as the index parameter, the new element is appended to the collection.

var numbers = [1, 2, 3, 4, 5]
numbers.insert(100, at: 3)
numbers.insert(200, at: numbers.endIndex)

print(numbers)
// Prints "[1, 2, 3, 100, 4, 5, 200]"

Calling this method may invalidate any existing indices for use with this collection.

newElement: The new element to insert into the collection.

i: The position at which to insert the new element. index must be a valid index into the collection.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func insert(_ newElement: String.UnicodeScalarView.Iterator.Element, at i: String.UnicodeScalarView.Index)

Declared In

RangeReplaceableCollection
mutating func insert(contentsOf:at:)

Inserts the elements of a sequence into the collection at the specified position.

The new elements are inserted before the element currently at the specified index. If you pass the collection's endIndex property as the index parameter, the new elements are appended to the collection.

Here's an example of inserting a range of integers into an array of the same type:

var numbers = [1, 2, 3, 4, 5]
numbers.insert(contentsOf: 100...103, at: 3)
print(numbers)
// Prints "[1, 2, 3, 100, 101, 102, 103, 4, 5]"

Calling this method may invalidate any existing indices for use with this collection.

newElements: The new elements to insert into the collection.

i: The position at which to insert the new elements. index must be a valid index of the collection.

Complexity: O(m), where m is the combined length of the collection and newElements. If i is equal to the collection's endIndex property, the complexity is O(n), where n is the length of newElements.

Declaration

mutating func insert<C where C : Collection, C.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(contentsOf newElements: C, at i: String.UnicodeScalarView.Index)

Declared In

RangeReplaceableCollection
func lexicographicallyPrecedes(_:by:)

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.

The predicate must be a strict weak ordering over the elements. That is, for any elements a, b, and c, the following conditions must hold:

  • areInIncreasingOrder(a, a) is always false. (Irreflexivity)
  • If areInIncreasingOrder(a, b) and areInIncreasingOrder(b, c) are both true, then areInIncreasingOrder(a, c) is also true. (Transitive comparability)
  • Two elements are incomparable if neither is ordered before the other according to the predicate. If a and b are incomparable, and b and c are incomparable, then a and c are also incomparable. (Transitive incomparability)

Parameters: other: A sequence to compare to this sequence. areInIncreasingOrder: A predicate that returns true if its first argument should be ordered before its second argument; otherwise, false. Returns: true if this sequence precedes other in a dictionary ordering as ordered by areInIncreasingOrder; otherwise, false.

Note: This method implements the mathematical notion of lexicographical ordering, which has no connection to Unicode. If you are sorting strings to present to the end user, use String APIs that perform localized comparison instead. See Also: lexicographicallyPrecedes(_:)

Declaration

func lexicographicallyPrecedes<OtherSequence where OtherSequence : Sequence, OtherSequence.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_ other: OtherSequence, by areInIncreasingOrder: (String.UnicodeScalarView.Iterator.Element, String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> Bool

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func makeIterator()

Returns an iterator over the Unicode scalars that make up this view.

Returns: An iterator over this collection's UnicodeScalar elements.

Declaration

func makeIterator() -> String.UnicodeScalarView.Iterator
func map(_:)

Returns an array containing the results of mapping the given closure over the sequence's elements.

In this example, map is used first to convert the names in the array to lowercase strings and then to count their characters.

let cast = ["Vivien", "Marlon", "Kim", "Karl"]
let lowercaseNames = cast.map { $0.lowercaseString }
// 'lowercaseNames' == ["vivien", "marlon", "kim", "karl"]
let letterCounts = cast.map { $0.characters.count }
// 'letterCounts' == [6, 6, 3, 4]

transform: A mapping closure. transform accepts an element of this sequence as its parameter and returns a transformed value of the same or of a different type. Returns: An array containing the transformed elements of this sequence.

Declaration

func map<T>(_ transform: (String.UnicodeScalarView.Iterator.Element) throws -> T) rethrows -> [T]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
@warn_unqualified_access func max(by:)

Returns the maximum element in the sequence, using the given predicate as the comparison between elements.

The predicate must be a strict weak ordering over the elements. That is, for any elements a, b, and c, the following conditions must hold:

  • areInIncreasingOrder(a, a) is always false. (Irreflexivity)
  • If areInIncreasingOrder(a, b) and areInIncreasingOrder(b, c) are both true, then areInIncreasingOrder(a, c) is also true. (Transitive comparability)
  • Two elements are incomparable if neither is ordered before the other according to the predicate. If a and b are incomparable, and b and c are incomparable, then a and c are also incomparable. (Transitive incomparability)

This example shows how to use the max(by:) method on a dictionary to find the key-value pair with the highest value.

let hues = ["Heliotrope": 296, "Coral": 16, "Aquamarine": 156]
let greatestHue = hues.max { a, b in a.value < b.value }
print(greatestHue)
// Prints "Optional(("Heliotrope", 296))"

areInIncreasingOrder: A predicate that returns true if its first argument should be ordered before its second argument; otherwise, false. Returns: The sequence's maximum element if the sequence is not empty; otherwise, nil.

See Also: max()

Declaration

@warn_unqualified_access func max(by areInIncreasingOrder: (String.UnicodeScalarView.Iterator.Element, String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> String.UnicodeScalarView.Iterator.Element?

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func min(by:)

Returns the minimum element in the sequence, using the given predicate as the comparison between elements.

The predicate must be a strict weak ordering over the elements. That is, for any elements a, b, and c, the following conditions must hold:

  • areInIncreasingOrder(a, a) is always false. (Irreflexivity)
  • If areInIncreasingOrder(a, b) and areInIncreasingOrder(b, c) are both true, then areInIncreasingOrder(a, c) is also true. (Transitive comparability)
  • Two elements are incomparable if neither is ordered before the other according to the predicate. If a and b are incomparable, and b and c are incomparable, then a and c are also incomparable. (Transitive incomparability)

This example shows how to use the min(by:) method on a dictionary to find the key-value pair with the lowest value.

let hues = ["Heliotrope": 296, "Coral": 16, "Aquamarine": 156]
let leastHue = hues.min { a, b in a.value < b.value }
print(leastHue)
// Prints "Optional(("Coral", 16))"

areInIncreasingOrder: A predicate that returns true if its first argument should be ordered before its second argument; otherwise, false. Returns: The sequence's minimum element, according to areInIncreasingOrder. If the sequence has no elements, returns nil.

See Also: min()

Declaration

func min(by areInIncreasingOrder: (String.UnicodeScalarView.Iterator.Element, String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> String.UnicodeScalarView.Iterator.Element?

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func prefix(_:)

Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.

If the maximum length exceeds the number of elements in the collection, the result contains all the elements in the collection.

let numbers = [1, 2, 3, 4, 5]
print(numbers.prefix(2))
// Prints "[1, 2]"
print(numbers.prefix(10))
// Prints "[1, 2, 3, 4, 5]"

maxLength: The maximum number of elements to return. maxLength must be greater than or equal to zero. Returns: A subsequence starting at the beginning of this collection with at most maxLength elements.

Declaration

func prefix(_ maxLength: Int) -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
func prefix(through:)

Returns a subsequence from the start of the collection through the specified position.

The resulting subsequence includes the element at the position end. The following example searches for the index of the number 40 in an array of integers, and then prints the prefix of the array up to, and including, that index:

let numbers = [10, 20, 30, 40, 50, 60]
if let i = numbers.index(of: 40) {
    print(numbers.prefix(through: i))
}
// Prints "[10, 20, 30, 40]"

end: The index of the last element to include in the resulting subsequence. end must be a valid index of the collection that is not equal to the endIndex property. Returns: A subsequence up to, and including, the end position.

Complexity: O(1) See Also: prefix(upTo:)

Declaration

func prefix(through position: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
func prefix(upTo:)

Returns a subsequence from the start of the collection up to, but not including, the specified position.

The resulting subsequence does not include the element at the position end. The following example searches for the index of the number 40 in an array of integers, and then prints the prefix of the array up to, but not including, that index:

let numbers = [10, 20, 30, 40, 50, 60]
if let i = numbers.index(of: 40) {
    print(numbers.prefix(upTo: i))
}
// Prints "[10, 20, 30]"

Passing the collection's starting index as the end parameter results in an empty subsequence.

print(numbers.prefix(upTo: numbers.startIndex))
// Prints "[]"

end: The "past the end" index of the resulting subsequence. end must be a valid index of the collection. Returns: A subsequence up to, but not including, the end position.

Complexity: O(1) See Also: prefix(through:)

Declaration

func prefix(upTo end: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
func prefix(while:)

Returns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.

predicate: A closure that takes an element of the sequence as its argument and returns true if the element should be included or false if it should be excluded. Once the predicate returns false it will not be called again.

Complexity: O(n), where n is the length of the collection.

Declaration

func prefix(while predicate: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
func reduce(_:_:)

Returns the result of combining the elements of the sequence using the given closure.

Use the reduce(_:_:) method to produce a single value from the elements of an entire sequence. For example, you can use this method on an array of numbers to find their sum or product.

The nextPartialResult closure is called sequentially with an accumulating value initialized to initialResult and each element of the sequence. This example shows how to find the sum of an array of numbers.

let numbers = [1, 2, 3, 4]
let numberSum = numbers.reduce(0, { x, y in
    x + y
})
// numberSum == 10

When numbers.reduce(_:_:) is called, the following steps occur:

  1. The nextPartialResult closure is called with initialResult---0 in this case---and the first element of numbers, returning the sum: 1.
  2. The closure is called again repeatedly with the previous call's return value and each element of the sequence.
  3. When the sequence is exhausted, the last value returned from the closure is returned to the caller.

If the sequence has no elements, nextPartialResult is never executed and initialResult is the result of the call to reduce(_:_:).

Parameters: initialResult: The value to use as the initial accumulating value. initialResult is passed to nextPartialResult the first time the closure is executed. nextPartialResult: A closure that combines an accumulating value and an element of the sequence into a new accumulating value, to be used in the next call of the nextPartialResult closure or returned to the caller. Returns: The final accumulated value. If the sequence has no elements, the result is initialResult.

Declaration

func reduce<Result>(_ initialResult: Result, _ nextPartialResult: (Result, String.UnicodeScalarView.Iterator.Element) throws -> Result) rethrows -> Result

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
mutating func remove(at:)

Removes and returns the element at the specified position.

All the elements following the specified position are moved to close the gap. This example removes the middle element from an array of measurements.

var measurements = [1.2, 1.5, 2.9, 1.2, 1.6]
let removed = measurements.remove(at: 2)
print(measurements)
// Prints "[1.2, 1.5, 1.2, 1.6]"

Calling this method may invalidate any existing indices for use with this collection.

position: The position of the element to remove. position must be a valid index of the collection that is not equal to the collection's end index. Returns: The removed element.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func remove(at position: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.Iterator.Element

Declared In

RangeReplaceableCollection
mutating func removeAll(keepingCapacity:)

Removes all elements from the collection.

Calling this method may invalidate any existing indices for use with this collection.

keepCapacity: Pass true to request that the collection avoid releasing its storage. Retaining the collection's storage can be a useful optimization when you're planning to grow the collection again. The default value is false.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func removeAll(keepingCapacity keepCapacity: Bool = default)

Declared In

RangeReplaceableCollection
mutating func removeFirst()

Removes and returns the first element of the collection.

The collection must not be empty.

var bugs = ["Aphid", "Bumblebee", "Cicada", "Damselfly", "Earwig"]
bugs.removeFirst()
print(bugs)
// Prints "["Bumblebee", "Cicada", "Damselfly", "Earwig"]"

Calling this method may invalidate any existing indices for use with this collection.

Returns: The removed element.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func removeFirst() -> String.UnicodeScalarView.Iterator.Element

Declared In

RangeReplaceableCollection
mutating func removeFirst(_:)

Removes the specified number of elements from the beginning of the collection.

var bugs = ["Aphid", "Bumblebee", "Cicada", "Damselfly", "Earwig"]
bugs.removeFirst(3)
print(bugs)
// Prints "["Damselfly", "Earwig"]"

Calling this method may invalidate any existing indices for use with this collection.

n: The number of elements to remove from the collection. n must be greater than or equal to zero and must not exceed the number of elements in the collection.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func removeFirst(_ n: Int)

Declared In

RangeReplaceableCollection
mutating func removeLast()

Removes and returns the last element of the collection.

The collection must not be empty.

Calling this method may invalidate all saved indices of this collection. Do not rely on a previously stored index value after altering a collection with any operation that can change its length.

Returns: The last element of the collection.

Complexity: O(1)

Declaration

mutating func removeLast() -> String.UnicodeScalarView.Iterator.Element

Declared In

RangeReplaceableCollection
mutating func removeLast(_:)

Removes the specified number of elements from the end of the collection.

Attempting to remove more elements than exist in the collection triggers a runtime error.

Calling this method may invalidate all saved indices of this collection. Do not rely on a previously stored index value after altering a collection with any operation that can change its length.

n: The number of elements to remove from the collection. n must be greater than or equal to zero and must not exceed the number of elements in the collection.

Complexity: O(n), where n is the specified number of elements.

Declaration

mutating func removeLast(_ n: Int)

Declared In

RangeReplaceableCollection
mutating func removeSubrange(_: ClosedRange<String.UnicodeScalarView.Index>)

Removes the elements in the specified subrange from the collection.

All the elements following the specified position are moved to close the gap. This example removes two elements from the middle of an array of measurements.

var measurements = [1.2, 1.5, 2.9, 1.2, 1.5]
measurements.removeSubrange(1..<4)
print(measurements)
// Prints "[1.2, 1.5]"

Calling this method may invalidate any existing indices for use with this collection.

bounds: The range of the collection to be removed. The bounds of the range must be valid indices of the collection.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func removeSubrange(_ bounds: ClosedRange<String.UnicodeScalarView.Index>)

Declared In

RangeReplaceableCollection
mutating func removeSubrange(_: Range<String.UnicodeScalarView.Index>)

Removes the elements in the specified subrange from the collection.

All the elements following the specified position are moved to close the gap. This example removes two elements from the middle of an array of measurements.

var measurements = [1.2, 1.5, 2.9, 1.2, 1.5]
measurements.removeSubrange(1..<4)
print(measurements)
// Prints "[1.2, 1.5]"

Calling this method may invalidate any existing indices for use with this collection.

bounds: The range of the collection to be removed. The bounds of the range must be valid indices of the collection.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func removeSubrange(_ bounds: Range<String.UnicodeScalarView.Index>)

Declared In

RangeReplaceableCollection
mutating func replaceSubrange(_:with:)

Replaces the elements within the specified bounds with the given Unicode scalar values.

Calling this method invalidates any existing indices for use with this string.

Parameters: bounds: The range of elements to replace. The bounds of the range must be valid indices of the view. newElements: The new Unicode scalar values to add to the string.

Complexity: O(m), where m is the combined length of the view and newElements. If the call to replaceSubrange(_:with:) simply removes elements at the end of the string, the complexity is O(n), where n is equal to bounds.count.

Declaration

mutating func replaceSubrange<C where C : Collection, C.Iterator.Element == UnicodeScalar>(_ bounds: Range<String.UnicodeScalarView.Index>, with newElements: C)

Declared In

String.UnicodeScalarView, RangeReplaceableCollection
mutating func reserveCapacity(_:)

Reserves enough space in the view's underlying storage to store the specified number of ASCII characters.

Because a Unicode scalar value can require more than a single ASCII character's worth of storage, additional allocation may be necessary when adding to a Unicode scalar view after a call to reserveCapacity(_:).

n: The minimum number of ASCII character's worth of storage to allocate.

Complexity: O(n), where n is the capacity being reserved.

Declaration

mutating func reserveCapacity(_ n: Int)

Declared In

String.UnicodeScalarView, RangeReplaceableCollection
func reversed()

Returns a view presenting the elements of the collection in reverse order.

You can reverse a collection without allocating new space for its elements by calling this reversed() method. A ReversedCollection instance wraps an underlying collection and provides access to its elements in reverse order. This example prints the characters of a string in reverse order:

let word = "Backwards"
for char in word.characters.reversed() {
    print(char, terminator="")
}
// Prints "sdrawkcaB"

If you need a reversed collection of the same type, you may be able to use the collection's sequence-based or collection-based initializer. For example, to get the reversed version of a string, reverse its characters and initialize a new String instance from the result.

let reversedWord = String(word.characters.reversed())
print(reversedWord)
// Prints "sdrawkcaB"

Complexity: O(1)

Declaration

func reversed() -> ReversedCollection<String.UnicodeScalarView>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func sorted(by:)

Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.

When you want to sort a sequence of elements that don't conform to the Comparable protocol, pass a predicate to this method that returns true when the first element passed should be ordered before the second. The elements of the resulting array are ordered according to the given predicate.

The predicate must be a strict weak ordering over the elements. That is, for any elements a, b, and c, the following conditions must hold:

  • areInIncreasingOrder(a, a) is always false. (Irreflexivity)
  • If areInIncreasingOrder(a, b) and areInIncreasingOrder(b, c) are both true, then areInIncreasingOrder(a, c) is also true. (Transitive comparability)
  • Two elements are incomparable if neither is ordered before the other according to the predicate. If a and b are incomparable, and b and c are incomparable, then a and c are also incomparable. (Transitive incomparability)

The sorting algorithm is not stable. A nonstable sort may change the relative order of elements for which areInIncreasingOrder does not establish an order.

In the following example, the predicate provides an ordering for an array of a custom HTTPResponse type. The predicate orders errors before successes and sorts the error responses by their error code.

enum HTTPResponse {
    case ok
    case error(Int)
}

let responses: [HTTPResponse] = [.error(500), .ok, .ok, .error(404), .error(403)]
let sortedResponses = responses.sorted {
    switch ($0, $1) {
    // Order errors by code
    case let (.error(aCode), .error(bCode)):
        return aCode < bCode

    // All successes are equivalent, so none is before any other
    case (.ok, .ok): return false

    // Order errors before successes
    case (.error, .ok): return true
    case (.ok, .error): return false
    }
}
print(sortedResponses)
// Prints "[.error(403), .error(404), .error(500), .ok, .ok]"

You also use this method to sort elements that conform to the Comparable protocol in descending order. To sort your sequence in descending order, pass the greater-than operator (>) as the areInIncreasingOrder parameter.

let students: Set = ["Kofi", "Abena", "Peter", "Kweku", "Akosua"]
let descendingStudents = students.sorted(by: >)
print(descendingStudents)
// Prints "["Peter", "Kweku", "Kofi", "Akosua", "Abena"]"

Calling the related sorted() method is equivalent to calling this method and passing the less-than operator (<) as the predicate.

print(students.sorted())
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"
print(students.sorted(by: <))
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"

areInIncreasingOrder: A predicate that returns true if its first argument should be ordered before its second argument; otherwise, false. Returns: A sorted array of the sequence's elements.

See Also: sorted()

Declaration

func sorted(by areInIncreasingOrder: (String.UnicodeScalarView.Iterator.Element, String.UnicodeScalarView.Iterator.Element) -> Bool) -> [String.UnicodeScalarView.Iterator.Element]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func split(_:omittingEmptySubsequences:whereSeparator:)

Returns the longest possible subsequences of the collection, in order, that don't contain elements satisfying the given predicate.

The resulting array consists of at most maxSplits + 1 subsequences. Elements that are used to split the sequence are not returned as part of any subsequence.

The following examples show the effects of the maxSplits and omittingEmptySubsequences parameters when splitting a string using a closure that matches spaces. The first use of split returns each word that was originally separated by one or more spaces.

let line = "BLANCHE:   I don't want realism. I want magic!"
print(line.characters.split(whereSeparator: { $0 == " " })
                     .map(String.init))
// Prints "["BLANCHE:", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"

The second example passes 1 for the maxSplits parameter, so the original string is split just once, into two new strings.

print(
    line.characters.split(
        maxSplits: 1, whereSeparator: { $0 == " " }
        ).map(String.init))
// Prints "["BLANCHE:", "  I don\'t want realism. I want magic!"]"

The final example passes false for the omittingEmptySubsequences parameter, so the returned array contains empty strings where spaces were repeated.

print(line.characters.split(omittingEmptySubsequences: false, whereSeparator: { $0 == " " })
                      .map(String.init))
// Prints "["BLANCHE:", "", "", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"

Parameters: maxSplits: The maximum number of times to split the collection, or one less than the number of subsequences to return. If maxSplits + 1 subsequences are returned, the last one is a suffix of the original collection containing the remaining elements. maxSplits must be greater than or equal to zero. The default value is Int.max. omittingEmptySubsequences: If false, an empty subsequence is returned in the result for each pair of consecutive elements satisfying the isSeparator predicate and for each element at the start or end of the collection satisfying the isSeparator predicate. The default value is true. isSeparator: A closure that takes an element as an argument and returns a Boolean value indicating whether the collection should be split at that element. Returns: An array of subsequences, split from this collection's elements.

Declaration

func split(maxSplits: Int = default, omittingEmptySubsequences: Bool = default, whereSeparator isSeparator: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> [String.UnicodeScalarView.SubSequence]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func starts(with:by:)

Returns a Boolean value indicating whether the initial elements of the sequence are equivalent to the elements in another sequence, using the given predicate as the equivalence test.

The predicate must be a equivalence relation over the elements. That is, for any elements a, b, and c, the following conditions must hold:

  • areEquivalent(a, a) is always true. (Reflexivity)
  • areEquivalent(a, b) implies areEquivalent(b, a). (Symmetry)
  • If areEquivalent(a, b) and areEquivalent(b, c) are both true, then areEquivalent(a, c) is also true. (Transitivity)

Parameters: possiblePrefix: A sequence to compare to this sequence. areEquivalent: A predicate that returns true if its two arguments are equivalent; otherwise, false. Returns: true if the initial elements of the sequence are equivalent to the elements of possiblePrefix; otherwise, false. If possiblePrefix has no elements, the return value is true.

See Also: starts(with:)

Declaration

func starts<PossiblePrefix where PossiblePrefix : Sequence, PossiblePrefix.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(with possiblePrefix: PossiblePrefix, by areEquivalent: (String.UnicodeScalarView.Iterator.Element, String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> Bool

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func suffix(_:)

Returns a subsequence, up to the given maximum length, containing the final elements of the collection.

If the maximum length exceeds the number of elements in the collection, the result contains the entire collection.

let numbers = [1, 2, 3, 4, 5]
print(numbers.suffix(2))
// Prints "[4, 5]"
print(numbers.suffix(10))
// Prints "[1, 2, 3, 4, 5]"

maxLength: The maximum number of elements to return. maxLength must be greater than or equal to zero. Returns: A subsequence terminating at the end of the collection with at most maxLength elements.

Complexity: O(n), where n is equal to maxLength.

Declaration

func suffix(_ maxLength: Int) -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func suffix(from:)

Returns a subsequence from the specified position to the end of the collection.

The following example searches for the index of the number 40 in an array of integers, and then prints the suffix of the array starting at that index:

let numbers = [10, 20, 30, 40, 50, 60]
if let i = numbers.index(of: 40) {
    print(numbers.suffix(from: i))
}
// Prints "[40, 50, 60]"

Passing the collection's endIndex as the start parameter results in an empty subsequence.

print(numbers.suffix(from: numbers.endIndex))
// Prints "[]"

start: The index at which to start the resulting subsequence. start must be a valid index of the collection. Returns: A subsequence starting at the start position.

Complexity: O(1)

Declaration

func suffix(from start: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.SubSequence

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection

Conditionally Inherited Items

The initializers, methods, and properties listed below may be available on this type under certain conditions (such as methods that are available on Array when its elements are Equatable) or may not ever be available if that determination is beyond SwiftDoc.org's capabilities. Please open an issue on GitHub if you see something out of place!

Where Base.Iterator == Iterator

func filter(_:)

Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.

In this example, filter is used to include only names shorter than five characters.

let cast = ["Vivien", "Marlon", "Kim", "Karl"]
let shortNames = cast.filter { $0.characters.count < 5 }
print(shortNames)
// Prints "["Kim", "Karl"]"

includeElement: A closure that takes an element of the sequence as its argument and returns a Boolean value indicating whether the element should be included in the returned array. Returns: An array of the elements that includeElement allowed.

Declaration

func filter(_ isIncluded: (String.UnicodeScalarView.Base.Iterator.Element) throws -> Bool) rethrows -> [String.UnicodeScalarView.Base.Iterator.Element]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func makeIterator()

Returns an iterator over the elements of this sequence.

Declaration

func makeIterator() -> String.UnicodeScalarView.Base.Iterator

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func map(_:)

Returns an array containing the results of mapping the given closure over the sequence's elements.

In this example, map is used first to convert the names in the array to lowercase strings and then to count their characters.

let cast = ["Vivien", "Marlon", "Kim", "Karl"]
let lowercaseNames = cast.map { $0.lowercaseString }
// 'lowercaseNames' == ["vivien", "marlon", "kim", "karl"]
let letterCounts = cast.map { $0.characters.count }
// 'letterCounts' == [6, 6, 3, 4]

transform: A mapping closure. transform accepts an element of this sequence as its parameter and returns a transformed value of the same or of a different type. Returns: An array containing the transformed elements of this sequence.

Declaration

func map<T>(_ transform: (String.UnicodeScalarView.Base.Iterator.Element) throws -> T) rethrows -> [T]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence

Where Index : Strideable, Index.Stride : SignedInteger

mutating func removeSubrange(_: CountableClosedRange<String.UnicodeScalarView.Index>)

Removes the elements in the specified subrange from the collection.

All the elements following the specified position are moved to close the gap. This example removes two elements from the middle of an array of measurements.

var measurements = [1.2, 1.5, 2.9, 1.2, 1.5]
measurements.removeSubrange(1..<4)
print(measurements)
// Prints "[1.2, 1.5]"

Calling this method may invalidate any existing indices for use with this collection.

bounds: The range of the collection to be removed. The bounds of the range must be valid indices of the collection.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func removeSubrange(_ bounds: CountableClosedRange<String.UnicodeScalarView.Index>)

Declared In

RangeReplaceableCollection
mutating func removeSubrange(_: CountableRange<String.UnicodeScalarView.Index>)

Removes the elements in the specified subrange from the collection.

All the elements following the specified position are moved to close the gap. This example removes two elements from the middle of an array of measurements.

var measurements = [1.2, 1.5, 2.9, 1.2, 1.5]
measurements.removeSubrange(1..<4)
print(measurements)
// Prints "[1.2, 1.5]"

Calling this method may invalidate any existing indices for use with this collection.

bounds: The range of the collection to be removed. The bounds of the range must be valid indices of the collection.

Complexity: O(n), where n is the length of the collection.

Declaration

mutating func removeSubrange(_ bounds: CountableRange<String.UnicodeScalarView.Index>)

Declared In

RangeReplaceableCollection
mutating func replaceSubrange<C where C : Collection, C.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_: CountableClosedRange<String.UnicodeScalarView.Index>, with: C)

Replaces the specified subrange of elements with the given collection.

This method has the effect of removing the specified range of elements from the collection and inserting the new elements at the same location. The number of new elements need not match the number of elements being removed.

In this example, three elements in the middle of an array of integers are replaced by the five elements of a Repeated<Int> instance.

 var nums = [10, 20, 30, 40, 50]
 nums.replaceSubrange(1...3, with: repeatElement(1, count: 5))
 print(nums)
 // Prints "[10, 1, 1, 1, 1, 1, 50]"

If you pass a zero-length range as the subrange parameter, this method inserts the elements of newElements at subrange.startIndex. Calling the insert(contentsOf:at:) method instead is preferred.

Likewise, if you pass a zero-length collection as the newElements parameter, this method removes the elements in the given subrange without replacement. Calling the removeSubrange(_:) method instead is preferred.

Calling this method may invalidate any existing indices for use with this collection.

Parameters: subrange: The subrange of the collection to replace. The bounds of the range must be valid indices of the collection. newElements: The new elements to add to the collection.

Complexity: O(m), where m is the combined length of the collection and newElements. If the call to replaceSubrange simply appends the contents of newElements to the collection, the complexity is O(n), where n is the length of newElements.

Declaration

mutating func replaceSubrange<C where C : Collection, C.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_ subrange: CountableClosedRange<String.UnicodeScalarView.Index>, with newElements: C)

Declared In

RangeReplaceableCollection
mutating func replaceSubrange<C where C : Collection, C.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_: CountableRange<String.UnicodeScalarView.Index>, with: C)

Replaces the specified subrange of elements with the given collection.

This method has the effect of removing the specified range of elements from the collection and inserting the new elements at the same location. The number of new elements need not match the number of elements being removed.

In this example, three elements in the middle of an array of integers are replaced by the five elements of a Repeated<Int> instance.

 var nums = [10, 20, 30, 40, 50]
 nums.replaceSubrange(1...3, with: repeatElement(1, count: 5))
 print(nums)
 // Prints "[10, 1, 1, 1, 1, 1, 50]"

If you pass a zero-length range as the subrange parameter, this method inserts the elements of newElements at subrange.startIndex. Calling the insert(contentsOf:at:) method instead is preferred.

Likewise, if you pass a zero-length collection as the newElements parameter, this method removes the elements in the given subrange without replacement. Calling the removeSubrange(_:) method instead is preferred.

Calling this method may invalidate any existing indices for use with this collection.

Parameters: subrange: The subrange of the collection to replace. The bounds of the range must be valid indices of the collection. newElements: The new elements to add to the collection.

Complexity: O(m), where m is the combined length of the collection and newElements. If the call to replaceSubrange simply appends the contents of newElements to the collection, the complexity is O(n), where n is the length of newElements.

Declaration

mutating func replaceSubrange<C where C : Collection, C.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_ subrange: CountableRange<String.UnicodeScalarView.Index>, with newElements: C)

Declared In

RangeReplaceableCollection

Where Indices == DefaultBidirectionalIndices, Indices.Index == Index, Indices.IndexDistance == Int, Indices.Indices == DefaultBidirectionalIndices, Indices.Iterator == IndexingIterator>, Indices.SubSequence == DefaultBidirectionalIndices, Indices._Element == Index, Indices.IndexDistance.IntegerLiteralType == Int, Indices.IndexDistance.Stride == Int, Indices.IndexDistance._DisabledRangeIndex == Int._DisabledRangeIndex, Indices.Indices.Index == Index, Indices.Indices.IndexDistance == Int, Indices.Indices.Iterator == IndexingIterator>, Indices.Indices.SubSequence == DefaultBidirectionalIndices, Indices.Indices._Element == Index, Indices.Iterator.Element == Index, Indices.SubSequence.Index == Index, Indices.SubSequence.Iterator == IndexingIterator>, Indices.SubSequence.SubSequence == DefaultBidirectionalIndices, Indices.SubSequence._Element == Index, Indices.IndexDistance.Stride.IntegerLiteralType == Int, Indices.Indices.IndexDistance.IntegerLiteralType == Int, Indices.Indices.IndexDistance.Stride == Int, Indices.Indices.IndexDistance._DisabledRangeIndex == Int._DisabledRangeIndex, Indices.Indices.Iterator.Element == Index, Indices.SubSequence.Iterator.Element == Index, Indices.Indices.IndexDistance.Stride.IntegerLiteralType == Int

var indices: DefaultBidirectionalIndices<String.UnicodeScalarView>

The indices that are valid for subscripting the collection, in ascending order.

A collection's indices property can hold a strong reference to the collection itself, causing the collection to be non-uniquely referenced. If you mutate the collection while iterating over its indices, a strong reference can cause an unexpected copy of the collection. To avoid the unexpected copy, use the index(after:) method starting with startIndex to produce indices instead.

var c = MyFancyCollection([10, 20, 30, 40, 50])
var i = c.startIndex
while i != c.endIndex {
    c[i] /= 5
    i = c.index(after: i)
}
// c == MyFancyCollection([2, 4, 6, 8, 10])

Declaration

var indices: DefaultBidirectionalIndices<String.UnicodeScalarView> { get }

Declared In

BidirectionalCollection

Where Indices == DefaultIndices, Indices.Index == Index, Indices.IndexDistance == Int, Indices.Iterator == IndexingIterator>, Indices.SubSequence == DefaultIndices, Indices._Element == Index, Indices.IndexDistance.IntegerLiteralType == Int, Indices.IndexDistance.Stride == Int, Indices.IndexDistance._DisabledRangeIndex == Int._DisabledRangeIndex, Indices.Iterator.Element == Index, Indices.IndexDistance.Stride.IntegerLiteralType == Int

var indices: DefaultIndices<String.UnicodeScalarView>

The indices that are valid for subscripting the collection, in ascending order.

A collection's indices property can hold a strong reference to the collection itself, causing the collection to be non-uniquely referenced. If you mutate the collection while iterating over its indices, a strong reference can cause an unexpected copy of the collection. To avoid the unexpected copy, use the index(after:) method starting with startIndex to produce indices instead.

var c = MyFancyCollection([10, 20, 30, 40, 50])
var i = c.startIndex
while i != c.endIndex {
    c[i] /= 5
    i = c.index(after: i)
}
// c == MyFancyCollection([2, 4, 6, 8, 10])

Declaration

var indices: DefaultIndices<String.UnicodeScalarView> { get }

Declared In

BidirectionalCollection , RangeReplaceableCollection , Collection

Where Iterator == IndexingIterator, Iterator.Element == _Element

func makeIterator()

Returns an iterator over the elements of the collection.

Declaration

func makeIterator() -> IndexingIterator<String.UnicodeScalarView>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection

Where Iterator == Self

func makeIterator()

Returns an iterator over the elements of this sequence.

Declaration

func makeIterator() -> String.UnicodeScalarView

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence

Where Iterator.Element : BidirectionalCollection

func joined()

Returns the elements of this collection of collections, concatenated.

In this example, an array of three ranges is flattened so that the elements of each range can be iterated in turn.

let ranges = [0..<3, 8..<10, 15..<17]

// A for-in loop over 'ranges' accesses each range:
for range in ranges {
  print(range)
}
// Prints "0..<3"
// Prints "8..<10"
// Prints "15..<17"

// Use 'joined()' to access each element of each range:
for index in ranges.joined() {
    print(index, terminator: " ")
}
// Prints: "0 1 2 8 9 15 16"

Returns: A flattened view of the elements of this collection of collections.

See Also: flatMap(_:), joined(separator:)

Declaration

func joined() -> FlattenBidirectionalCollection<String.UnicodeScalarView>

Declared In

BidirectionalCollection

Where Iterator.Element : Collection

func joined()

Returns the elements of this collection of collections, concatenated.

In this example, an array of three ranges is flattened so that the elements of each range can be iterated in turn.

let ranges = [0..<3, 8..<10, 15..<17]

// A for-in loop over 'ranges' accesses each range:
for range in ranges {
  print(range)
}
// Prints "0..<3"
// Prints "8..<10"
// Prints "15..<17"

// Use 'joined()' to access each element of each range:
for index in ranges.joined() {
    print(index, terminator: " ")
}
// Prints: "0 1 2 8 9 15 16"

Returns: A flattened view of the elements of this collection of collections.

See Also: flatMap(_:), joined(separator:)

Declaration

func joined() -> FlattenCollection<String.UnicodeScalarView>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection

Where Iterator.Element : Comparable

func lexicographicallyPrecedes(_:)

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the less-than operator (<) to compare elements.

This example uses the lexicographicallyPrecedes method to test which array of integers comes first in a lexicographical ordering.

let a = [1, 2, 2, 2]
let b = [1, 2, 3, 4]

print(a.lexicographicallyPrecedes(b))
// Prints "true"
print(b.lexicographicallyPrecedes(b))
// Prints "false"

other: A sequence to compare to this sequence. Returns: true if this sequence precedes other in a dictionary ordering; otherwise, false.

Note: This method implements the mathematical notion of lexicographical ordering, which has no connection to Unicode. If you are sorting strings to present to the end user, use String APIs that perform localized comparison. See Also: lexicographicallyPrecedes(_:by:)

Declaration

func lexicographicallyPrecedes<OtherSequence where OtherSequence : Sequence, OtherSequence.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_ other: OtherSequence) -> Bool

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
@warn_unqualified_access func max()

Returns the maximum element in the sequence.

This example finds the smallest value in an array of height measurements.

let heights = [67.5, 65.7, 64.3, 61.1, 58.5, 60.3, 64.9]
let greatestHeight = heights.max()
print(greatestHeight)
// Prints "Optional(67.5)"

Returns: The sequence's maximum element. If the sequence has no elements, returns nil.

See Also: max(by:)

Declaration

@warn_unqualified_access func max() -> String.UnicodeScalarView.Iterator.Element?

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
@warn_unqualified_access func min()

Returns the minimum element in the sequence.

This example finds the smallest value in an array of height measurements.

let heights = [67.5, 65.7, 64.3, 61.1, 58.5, 60.3, 64.9]
let lowestHeight = heights.min()
print(lowestHeight)
// Prints "Optional(58.5)"

Returns: The sequence's minimum element. If the sequence has no elements, returns nil.

See Also: min(by:)

Declaration

@warn_unqualified_access func min() -> String.UnicodeScalarView.Iterator.Element?

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func sorted()

Returns the elements of the sequence, sorted.

You can sort any sequence of elements that conform to the Comparable protocol by calling this method. Elements are sorted in ascending order.

The sorting algorithm is not stable. A nonstable sort may change the relative order of elements that compare equal.

Here's an example of sorting a list of students' names. Strings in Swift conform to the Comparable protocol, so the names are sorted in ascending order according to the less-than operator (<).

let students: Set = ["Kofi", "Abena", "Peter", "Kweku", "Akosua"]
let sortedStudents = students.sorted()
print(sortedStudents)
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"

To sort the elements of your sequence in descending order, pass the greater-than operator (>) to the sorted(by:) method.

let descendingStudents = students.sorted(by: >)
print(descendingStudents)
// Prints "["Peter", "Kweku", "Kofi", "Akosua", "Abena"]"

Returns: A sorted array of the sequence's elements.

See Also: sorted(by:)

Declaration

func sorted() -> [String.UnicodeScalarView.Iterator.Element]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence

Where Iterator.Element : Equatable

func contains(_:)

Returns a Boolean value indicating whether the sequence contains the given element.

This example checks to see whether a favorite actor is in an array storing a movie's cast.

let cast = ["Vivien", "Marlon", "Kim", "Karl"]
print(cast.contains("Marlon"))
// Prints "true"
print(cast.contains("James"))
// Prints "false"

element: The element to find in the sequence. Returns: true if the element was found in the sequence; otherwise, false.

Declaration

func contains(_ element: String.UnicodeScalarView.Iterator.Element) -> Bool

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func elementsEqual(_:)

Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.

At least one of the sequences must be finite.

This example tests whether one countable range shares the same elements as another countable range and an array.

let a = 1...3
let b = 1...10

print(a.elementsEqual(b))
// Prints "false"
print(a.elementsEqual([1, 2, 3]))
// Prints "true"

other: A sequence to compare to this sequence. Returns: true if this sequence and other contain the same elements in the same order.

See Also: elementsEqual(_:by:)

Declaration

func elementsEqual<OtherSequence where OtherSequence : Sequence, OtherSequence.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(_ other: OtherSequence) -> Bool

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func index(of:)

Returns the first index where the specified value appears in the collection.

After using index(of:) to find the position of a particular element in a collection, you can use it to access the element by subscripting. This example shows how you can modify one of the names in an array of students.

var students = ["Ben", "Ivy", "Jordell", "Maxime"]
if let i = students.index(of: "Maxime") {
    students[i] = "Max"
}
print(students)
// Prints "["Ben", "Ivy", "Jordell", "Max"]"

element: An element to search for in the collection. Returns: The first index where element is found. If element is not found in the collection, returns nil.

See Also: index(where:)

Declaration

func index(of element: String.UnicodeScalarView.Iterator.Element) -> String.UnicodeScalarView.Index?

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
func split(_:maxSplits:omittingEmptySubsequences:)

Returns the longest possible subsequences of the collection, in order, around elements equal to the given element.

The resulting array consists of at most maxSplits + 1 subsequences. Elements that are used to split the collection are not returned as part of any subsequence.

The following examples show the effects of the maxSplits and omittingEmptySubsequences parameters when splitting a string at each space character (" "). The first use of split returns each word that was originally separated by one or more spaces.

let line = "BLANCHE:   I don't want realism. I want magic!"
print(line.characters.split(separator: " ")
                     .map(String.init))
// Prints "["BLANCHE:", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"

The second example passes 1 for the maxSplits parameter, so the original string is split just once, into two new strings.

print(line.characters.split(separator: " ", maxSplits: 1)
                      .map(String.init))
// Prints "["BLANCHE:", "  I don\'t want realism. I want magic!"]"

The final example passes false for the omittingEmptySubsequences parameter, so the returned array contains empty strings where spaces were repeated.

print(line.characters.split(separator: " ", omittingEmptySubsequences: false)
                      .map(String.init))
// Prints "["BLANCHE:", "", "", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"

Parameters: separator: The element that should be split upon. maxSplits: The maximum number of times to split the collection, or one less than the number of subsequences to return. If maxSplits + 1 subsequences are returned, the last one is a suffix of the original collection containing the remaining elements. maxSplits must be greater than or equal to zero. The default value is Int.max. omittingEmptySubsequences: If false, an empty subsequence is returned in the result for each consecutive pair of separator elements in the collection and for each instance of separator at the start or end of the collection. If true, only nonempty subsequences are returned. The default value is true. Returns: An array of subsequences, split from this collection's elements.

Declaration

func split(separator: String.UnicodeScalarView.Iterator.Element, maxSplits: Int = default, omittingEmptySubsequences: Bool = default) -> [String.UnicodeScalarView.SubSequence]

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func starts(with:)

Returns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.

This example tests whether one countable range begins with the elements of another countable range.

let a = 1...3
let b = 1...10

print(b.starts(with: a))
// Prints "true"

Passing a sequence with no elements or an empty collection as possiblePrefix always results in true.

print(b.starts(with: []))
// Prints "true"

possiblePrefix: A sequence to compare to this sequence. Returns: true if the initial elements of the sequence are the same as the elements of possiblePrefix; otherwise, false. If possiblePrefix has no elements, the return value is true.

See Also: starts(with:by:)

Declaration

func starts<PossiblePrefix where PossiblePrefix : Sequence, PossiblePrefix.Iterator.Element == String.UnicodeScalarView.Iterator.Element>(with possiblePrefix: PossiblePrefix) -> Bool

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence

Where Iterator.Element : Sequence

func joined()

Returns the elements of this sequence of sequences, concatenated.

In this example, an array of three ranges is flattened so that the elements of each range can be iterated in turn.

let ranges = [0..<3, 8..<10, 15..<17]

// A for-in loop over 'ranges' accesses each range:
for range in ranges {
  print(range)
}
// Prints "0..<3"
// Prints "8..<10"
// Prints "15..<17"

// Use 'joined()' to access each element of each range:
for index in ranges.joined() {
    print(index, terminator: " ")
}
// Prints: "0 1 2 8 9 15 16"

Returns: A flattened view of the elements of this sequence of sequences.

See Also: flatMap(_:), joined(separator:)

Declaration

func joined() -> FlattenSequence<String.UnicodeScalarView>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func joined(_:)

Returns the concatenated elements of this sequence of sequences, inserting the given separator between each element.

This example shows how an array of [Int] instances can be joined, using another [Int] instance as the separator:

let nestedNumbers = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
let joined = nestedNumbers.joined(separator: [-1, -2])
print(Array(joined))
// Prints "[1, 2, 3, -1, -2, 4, 5, 6, -1, -2, 7, 8, 9]"

separator: A sequence to insert between each of this sequence's elements. Returns: The joined sequence of elements.

See Also: joined()

Declaration

func joined<Separator where Separator : Sequence, Separator.Iterator.Element == String.UnicodeScalarView.Iterator.Element.Iterator.Element>(separator: Separator) -> JoinedSequence<String.UnicodeScalarView>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence

Where Iterator.Element == String

func joined(_:)

Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.

The following example shows how an array of strings can be joined to a single, comma-separated string:

let cast = ["Vivien", "Marlon", "Kim", "Karl"]
let list = cast.joined(separator: ", ")
print(list)
// Prints "Vivien, Marlon, Kim, Karl"

separator: A string to insert between each of the elements in this sequence. The default separator is an empty string. Returns: A single, concatenated string.

Declaration

func joined(separator: String = default) -> String

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence

Where SubSequence : Sequence, SubSequence.SubSequence == SubSequence, SubSequence.Iterator.Element == Iterator.Element

func drop(while:)

Returns a subsequence by skipping the initial, consecutive elements that satisfy the given predicate.

The following example uses the drop(while:) method to skip over the positive numbers at the beginning of the numbers array. The result begins with the first element of numbers that does not satisfy predicate.

let numbers = [3, 7, 4, -2, 9, -6, 10, 1]
let startingWithNegative = numbers.drop(while: { $0 > 0 })
// startingWithNegative == [-2, 9, -6, 10, 1]

If predicate matches every element in the sequence, the result is an empty sequence.

predicate: A closure that takes an element of the sequence as its argument and returns a Boolean value indicating whether the element should be included in the result. Returns: A subsequence starting after the initial, consecutive elements that satisfy predicate.

Complexity: O(n), where n is the length of the collection. See Also: prefix(while:)

Declaration

func drop(while predicate: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> AnySequence<String.UnicodeScalarView.Iterator.Element>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func dropFirst(_:)

Returns a subsequence containing all but the given number of initial elements.

If the number of elements to drop exceeds the number of elements in the sequence, the result is an empty subsequence.

let numbers = [1, 2, 3, 4, 5]
print(numbers.dropFirst(2))
// Prints "[3, 4, 5]"
print(numbers.dropFirst(10))
// Prints "[]"

n: The number of elements to drop from the beginning of the sequence. n must be greater than or equal to zero. Returns: A subsequence starting after the specified number of elements.

Complexity: O(1).

Declaration

func dropFirst(_ n: Int) -> AnySequence<String.UnicodeScalarView.Iterator.Element>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func dropLast(_:)

Returns a subsequence containing all but the given number of final elements.

The sequence must be finite. If the number of elements to drop exceeds the number of elements in the sequence, the result is an empty subsequence.

let numbers = [1, 2, 3, 4, 5]
print(numbers.dropLast(2))
// Prints "[1, 2, 3]"
print(numbers.dropLast(10))
// Prints "[]"

n: The number of elements to drop off the end of the sequence. n must be greater than or equal to zero. Returns: A subsequence leaving off the specified number of elements.

Complexity: O(n), where n is the length of the sequence.

Declaration

func dropLast(_ n: Int) -> AnySequence<String.UnicodeScalarView.Iterator.Element>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func prefix(_:)

Returns a subsequence, up to the specified maximum length, containing the initial elements of the sequence.

If the maximum length exceeds the number of elements in the sequence, the result contains all the elements in the sequence.

let numbers = [1, 2, 3, 4, 5]
print(numbers.prefix(2))
// Prints "[1, 2]"
print(numbers.prefix(10))
// Prints "[1, 2, 3, 4, 5]"

maxLength: The maximum number of elements to return. The value of maxLength must be greater than or equal to zero. Returns: A subsequence starting at the beginning of this sequence with at most maxLength elements.

Complexity: O(1)

Declaration

func prefix(_ maxLength: Int) -> AnySequence<String.UnicodeScalarView.Iterator.Element>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence
func prefix(while:)

Returns a subsequence containing the initial, consecutive elements that satisfy the given predicate.

The following example uses the prefix(while:) method to find the positive numbers at the beginning of the numbers array. Every element of numbers up to, but not including, the first negative value is included in the result.

let numbers = [3, 7, 4, -2, 9, -6, 10, 1]
let positivePrefix = numbers.prefix(while: { $0 > 0 })
// positivePrefix == [3, 7, 4]

If predicate matches every element in the sequence, the resulting sequence contains every element of the sequence.

predicate: A closure that takes an element of the sequence as its argument and returns a Boolean value indicating whether the element should be included in the result. Returns: A subsequence of the initial, consecutive elements that satisfy predicate.

Complexity: O(n), where n is the length of the collection. See Also: drop(while:)

Declaration

func prefix(while predicate: (String.UnicodeScalarView.Iterator.Element) throws -> Bool) rethrows -> AnySequence<String.UnicodeScalarView.Iterator.Element>

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection, Sequence

Where SubSequence == BidirectionalSlice, SubSequence.Index == Index, SubSequence.IndexDistance == IndexDistance, SubSequence.Indices == DefaultBidirectionalIndices>, SubSequence.Iterator == IndexingIterator>, SubSequence.SubSequence == BidirectionalSlice, SubSequence._Element == _Element, SubSequence.Indices.Index == Index, SubSequence.Indices.IndexDistance == Int, SubSequence.Indices.Iterator == IndexingIterator>>, SubSequence.Indices.SubSequence == DefaultBidirectionalIndices>, SubSequence.Indices._Element == Index, SubSequence.Iterator.Element == _Element, SubSequence.SubSequence.Index == Index, SubSequence.SubSequence.Iterator == IndexingIterator>, SubSequence.SubSequence.SubSequence == BidirectionalSlice, SubSequence.SubSequence._Element == _Element, SubSequence.Indices.IndexDistance.IntegerLiteralType == Int, SubSequence.Indices.IndexDistance.Stride == Int, SubSequence.Indices.IndexDistance._DisabledRangeIndex == Int._DisabledRangeIndex, SubSequence.Indices.Iterator.Element == Index, SubSequence.SubSequence.Iterator.Element == _Element, SubSequence.Indices.IndexDistance.Stride.IntegerLiteralType == Int

subscript(_: Range<String.UnicodeScalarView.Index>)

Accesses a contiguous subrange of the collection's elements.

The accessed slice uses the same indices for the same elements as the original collection uses. Always use the slice's startIndex property instead of assuming that its indices start at a particular value.

This example demonstrates getting a slice of an array of strings, finding the index of one of the strings in the slice, and then using that index in the original array.

let streets = ["Adams", "Bryant", "Channing", "Douglas", "Evarts"]
let streetsSlice = streets[2 ..< streets.endIndex]
print(streetsSlice)
// Prints "["Channing", "Douglas", "Evarts"]"

let index = streetsSlice.index(of: "Evarts")    // 4
print(streets[index!])
// Prints "Evarts"

bounds: A range of the collection's indices. The bounds of the range must be valid indices of the collection.

Declaration

subscript(bounds: Range<String.UnicodeScalarView.Index>) -> BidirectionalSlice<String.UnicodeScalarView> { get }

Declared In

BidirectionalCollection

Where SubSequence == Self

mutating func popFirst()

Removes and returns the first element of the collection.

Returns: The first element of the collection if the collection is not empty; otherwise, nil.

Complexity: O(1)

Declaration

mutating func popFirst() -> String.UnicodeScalarView.Iterator.Element?

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
mutating func popLast()

Removes and returns the last element of the collection.

You can use popLast() to remove the last element of a collection that might be empty. The removeLast() method must be used only on a nonempty collection.

Returns: The last element of the collection if the collection has one or more elements; otherwise, nil.

Complexity: O(1). See Also: removeLast()

Declaration

mutating func popLast() -> String.UnicodeScalarView.Iterator.Element?

Declared In

BidirectionalCollection
mutating func removeFirst()

Removes and returns the first element of the collection.

The collection must not be empty.

Returns: The first element of the collection.

Complexity: O(1) See Also: popFirst()

Declaration

mutating func removeFirst() -> String.UnicodeScalarView.Iterator.Element

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
mutating func removeFirst(_:)

Removes the specified number of elements from the beginning of the collection.

n: The number of elements to remove. n must be greater than or equal to zero, and must be less than or equal to the number of elements in the collection.

Complexity: O(1) if the collection conforms to RandomAccessCollection; otherwise, O(n).

Declaration

mutating func removeFirst(_ n: Int)

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection
mutating func removeLast()

Removes and returns the last element of the collection.

The collection must not be empty. To remove the last element of a collection that might be empty, use the popLast() method instead.

Returns: The last element of the collection.

Complexity: O(1) See Also: popLast()

Declaration

mutating func removeLast() -> String.UnicodeScalarView.Iterator.Element

Declared In

BidirectionalCollection, RangeReplaceableCollection
mutating func removeLast(_:)

Removes the given number of elements from the end of the collection.

n: The number of elements to remove. n must be greater than or equal to zero, and must be less than or equal to the number of elements in the collection.

Complexity: O(1) if the collection conforms to RandomAccessCollection; otherwise, O(n), where n is the length of the collection.

Declaration

mutating func removeLast(_ n: Int)

Declared In

BidirectionalCollection, RangeReplaceableCollection

Where SubSequence == Slice, SubSequence.Index == Index, SubSequence.Iterator == IndexingIterator>, SubSequence.SubSequence == Slice, SubSequence._Element == _Element, SubSequence.Iterator.Element == _Element

subscript(_: Range<String.UnicodeScalarView.Index>)

Accesses a contiguous subrange of the collection's elements.

The accessed slice uses the same indices for the same elements as the original collection uses. Always use the slice's startIndex property instead of assuming that its indices start at a particular value.

This example demonstrates getting a slice of an array of strings, finding the index of one of the strings in the slice, and then using that index in the original array.

let streets = ["Adams", "Bryant", "Channing", "Douglas", "Evarts"]
let streetsSlice = streets[2 ..< streets.endIndex]
print(streetsSlice)
// Prints "["Channing", "Douglas", "Evarts"]"

let index = streetsSlice.index(of: "Evarts")    // 4
print(streets[index!])
// Prints "Evarts"

bounds: A range of the collection's indices. The bounds of the range must be valid indices of the collection.

Complexity: O(1)

Declaration

subscript(bounds: Range<String.UnicodeScalarView.Index>) -> Slice<String.UnicodeScalarView> { get }

Declared In

BidirectionalCollection, RangeReplaceableCollection, Collection