Home > Articles > Mobile Application Development & Programming

Building a Bag Class in Swift: Explorations into Generics and the Swift Generator Underbelly

Of Swift's many high-octane features, generics are among the most powerful. As the name implies, generics enable you to build classes and structures that operate across types to provide powerful, reusable code. With generics and a bit of know-how, this article will help you learn to create collections that leverage custom storage and enumeration for nearly any kind of class or structure.
Like this article? We recommend

I recently decided to build a Bag class in Swift. I thought it would be an exciting way to learn to create a custom generator. Generators are the Swift feature that support collection enumeration, letting you iterate across the members of a collection. It was also an opportunity to pick up some practical experience using generics, the feature that enables collections to store a broad range of types. In my journey, I learned how generics and generators work hand-in-hand to create the enumeration I was aiming for and picked up some valuable experience along the way.

Building Bags

If you’re not familiar with them, bags are counted sets. Sets are collections of distinct objects. Their counted variant enables you to store the quantity of each item along with the items themselves. In Cocoa and Cocoa Touch NSCountedSet and CFBag provide the Foundation and Core Foundation versions of Bags. This is a data type I often used when developing in Smalltalk and one that seemed a good match to implementing in Swift. While Swift offers native arrays and dictionaries, sets and counted sets are not built-in collection types.

A bag might hold integers, strings, or, say, socks. If you add a sock twice, you have two socks. Add five more socks, and you have seven. Each add and remove operation keeps track of that count. When you remove the last of an item from the bag, it's gone. Removed items won't participate in enumeration or appear in a list of members. Like sets, bags are unordered. You can iterate through them to visit each member in an arbitrary order.

Because dictionaries can store a value for each key, they make a fine internal representation for bags. The key acts as the set member. The value stores the current count. In the following Bag class definition, the _storage dictionary acts as a backing store. To make clear that the internal storage isn't meant for outside consumption, the _storage variable uses an underscore prefix. Swift does not support private variables or offer any access control mechanisms; however, Apple does promise this feature in future updates.

class Bag<T: Hashable> {
    var _storage = Dictionary<T, Int>()


You might be wondering about those T’s that appear in the declaration between angle brackets. They refer to generics. Generics permit you to work with elements whose type you don’t know in advance. A generic dictionary typed Dictionary<T, Int> says, "give me a dictionary whose key-value pairs always map to an integer but whose key type is not yet defined."

The compiler infers that type when the class is used. When you build an actual bag, it can contain numbers, strings, structures, or any other element. But when you design the bag, you won’t know how it will end up being used. That’s where generics come in. You specify the behavior but not the type.

In this minimal definition, a generic type is mentioned twice – first in the class declaration and then in the variable declaration. The letter “T” is conventional. It means “some type,” but you are not tied to using T. You might substitute KeyType, BagElementType, or DancingHippopotami as the generic type token if you want to. (Although I sadly discourage the last of these.) These full names have the advantage of clarity and self-documentation. However, names are not as instantly identifiable as the single-letter convention. Single letters pop from the code.

class Bag<KeyType: Hashable> {
    var _storage = Dictionary<KeyType, Int>()

Whatever generic token you use for this implementation, its type must conform to the Hashable protocol. This protocol enables those keys to be hashed to a fixed value and used with the _storage dictionary. This is the same hashing requirement you’d encounter with NSDictionary in Objective C. 

Resolving Generics

When using generics, tokens are resolved when the bag is created. In the following code, test1 stores a bag of Ints and test2 stores one of Strings. Specifying the type on creation builds a type-safe bag ready to hold only those objects.

var test1 = Bag<Int>()
var test2 = Bag<String>()

The class-<type> definition used here can be clunky. If you expand the class to include a variadic initializer, the bag can infer a type from the arguments you pass. This avoids the angle brackets and type specification and leverages Swift’s strong type inference features.

class Bag<T: Hashable > {
    var _storage = Dictionary<T, Int>()
    init(_ items:T ...){}
var test3 = Bag(3, 5, 7, 5, 2)

Building the Bag

The code that follows fills out a trivial Bag implementation. It allows you to add items and remove them, and by conforming to the Printable protocol, its description property produces a representation suitable for inspection.

class Bag<T: Hashable> : Printable {
    var _storage = Dictionary<T, Int>()

    init(_ items : T ...)
        for item in items

    func addItem(item : T)
        if let count = _storage[item] {
            _storage[item] = count + 1
        } else {
            _storage[item] = 1
    func removeItem(item: T) {
        if let count = _storage[item]
            if (count > 1) {
                _storage[item] = count - 1
            } else {
    var description : String {
        return _storage.description

Each method remains agnostic as to the type of item it stores, using the generic T type indicator in place of actual class names. So long as the type can be hashed and referenced with a dictionary, the bag can store any kind of element.

Although this implementation provides the base functionality required by a bag, it does not yet support the enumeration mentioned earlier in this write-up, an important element for custom collections. Adding enumeration builds on the generic implementation and produces a stream of objects from the collection that stores them.

Adding Enumeration

To take advantage of enumeration, classes conform to the Sequence protocol. You may have encountered this protocol in the WWDC Intermediate Swift video. A sequence can be iterated through its entirety. Enable the protocol by declaring a generator type alias and implement a generate() function, as in the following extension.

extension Bag : Sequence {
    typealias GeneratorType = BagGenerator<T>
    func generate() -> BagGenerator<T>{
        return BagGenerator<T>(_storage)

In the preceding snippet, enumeration features rely on a BagGenerator. This is a new class or structured built around the generic key type, which you can see from the <T> that follows each mention. You build generators to support this enumeration.

A simple generator requires just a few lines of code: a declaration of the kind of Element you're producing at each iteration and a next() function that produces each element. The element can be a single return type or a tuple. One of Swift’s really cool features is that it permits you to retrieve not just a single index but all the key elements involved in collection iteration. A standard array enumerates to a sequence of items. A dictionary enumerates to a key/value tuple. Bags should enumerate to keys and their counts.

Here is an example of a bag generator implementation. With the class Sequence extension and this generator, bags are ready for enumeration.

struct BagGenerator<T:Hashable> : Generator{
    var _backingGenerator : DictionaryGenerator<T, Int>
    init(_ backingDictionary : Dictionary<T, Int>) {
        _backingGenerator = backingDictionary.generate()
    typealias Element = (T, Int)
    mutating func next() -> (T, Int)? {
        return _backingGenerator.next()

Enumeration enables you to iterate through your bag to print out a list of its contents. The following enumeration retrieves a sequence of key-count pairs and prints them to the console.

for (key, count) in test3 {
    println("\(key): \(count)")

Extending Enumeration

The BagGenerator implementation you just saw leveraged a one-to-one correspondence between the bag’s enumeration and that of the underlying dictionary. That’s not always possible or desirable. The following implementation tweaks the next() function to explicitly create a tuple instead of relying on redirection. There’s not much different in this example, but it exposes how to structure a custom return type.

struct BagGenerator<T:Hashable> : Generator{
    var _backingGenerator : DictionaryGenerator<T, Int>
    init(_ backingDictionary : Dictionary<T, Int>) {
        _backingGenerator = backingDictionary.generate()
    typealias Element = (T, Int)
    mutating func next() -> (T, Int)? {
        if let (key, value) = _backingGenerator.next(){
           return (key, value)
        return nil

See how far this might get pushed for custom enumeration by expanding this yet again. The following example returns a 3-tuple instead of a pair. This tuple consists of the key, its count, and the internal index. Although this index breaks the contract of an unordered set, it provides a good example of how to enumerate additional elements to create whatever return type you need for your applications.

struct BagGenerator<T:Hashable> : Generator{
    var _backingGenerator : DictionaryGenerator<T, Int>
    var index = 0
    init(_ backingDictionary : Dictionary<T, Int>) {
        _backingGenerator = backingDictionary.generate()
    typealias Element = (T, Int, Int)
    mutating func next() -> (T, Int, Int)? {
    if let (key, value) = _backingGenerator.next(){
       return (key, value, index++)
    } else {
        return nil


A Bag that can store any type provides a reusability advantage over one that is limited to a single class or structure. Generics enable your code to cater to many use cases for the most powerful coding solutions. By adding enumeration, your custom collections can participate as a flexible coding solution in Swift development.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020