Welcome!

You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion

ColdFusion: Article

Playing with Arrays

A powerful tool in the hands of a skilled coder

When I found out this month's issue would be a "back to basics" issue, I was torn between several topics that I hope are of interest to every CFML developer. I settled on the array, which is a powerful tool in the hands of a skilled coder. Just to make sure everyone's on board we'll start with the assumption that we need to explore the nature of an array first.

Every programming language has simple datatypes and complex datatypes. Simple datatypes are things like strings and numbers - datatypes that store a single value. Complex datatypes are things like arrays and structures (which are also called associative arrays) - datatypes that can store more than one simple value. An array is a complex datatype that stores values in a series of elements. Each element is addressed by a number known as its index.

That's the programming definition of an array. To get a handle on the concept, I find it easiest to think of an array as a container with several pockets like an egg carton. To put something in the carton, we have to say something like "Put an egg in pocket one of the egg carton." In CFML that statement looks like this:

<cfset eggCarton[1] = "egg">

or if we're working inside a <cfscript> block:

eggCarton[1] = "egg";

Similarly, if we want to find out what's in the fifth pocket of the egg carton, we could output it to the browser like this:

<cfoutput>#eggCarton[5]#</cfoutput>

The egg carton example is an array of one dimension. That means it only has one index number - the number of the pocket we need. But we can also have more complex situations. For example, we could have a set of egg cartons. In that case we have to specify not only which pocket we need, but which carton as well. To do this, we use a second index number. So the sixth pocket of the second egg carton could be referenced as eggCartons[2][6] (the plural eggCartons is arbitrary; it just helps to remember the purpose of this particular array). This new array has two dimensions indicated by the two index numbers used. We can think of the first dimension as "carton" and the second dimension as "pocket."

This brings us around to the syntax for creating an array in ColdFusion. Before we can put anything in the array, we have to create a variable with the array datatype. The ArrayNew() function handles the job, and it takes one argument: the number of dimensions we want in the array. CFML will accept a value of 1, 2, or 3 for the number of dimensions. Here are the statements we would use to create the arrays used in the two egg carton examples we've seen so far:

<cfset eggCarton = ArrayNew(1)>
<cfset eggCartons = ArrayNew(2)>

The ArrayNew() function creates an array, but it doesn't store any values in the array's elements. That job remains for us to do.

Even though ColdFusion only allows us to create up to three dimensions with the ArrayNew() function, the number of dimensions isn't really restricted to three. Each extra dimension is really another layer of arrays, so it's possible to manually construct arrays of more than three dimensions. That's a discussion for another article, but here's a bit of code to give you a hint; we could create the eggCartons array this way (assuming we want four cartons):

<cfset eggCartons = ArrayNew(1)>
<cfset ArraySet(eggCartons,1,4,ArrayNew(1))>

The second line in this example is equivalent to the following loop:

<cfloop from="1" to="4" index="i">
    <cfset eggCartons[i] = ArrayNew(1)>
</cfloop>

Based on this example, we can extrapolate the same technique to build an array of as many dimensions as desired. In practical use, though, arrays of more than three dimensions are generally reserved for esoteric uses.

In some programming languages, an array's elements must all be the same datatype such as integer or alphanumeric. This is not the case where ColdFusion is concerned. We can store any datatype in any element of an array, even mixing datatypes in the array. We can have arrays of structures or arrays of arrays (as seen in the code above), or arrays of CFCs. Again, that's a little more than we have room to cover in this article.

However, we do want to do something useful with arrays and take advantage of a few of the array functions in CFML, so let's get to some more practical code. Card games seem to be increasingly popular these days, especially poker, so let's say we want to cook up a way to store a deck of cards, shuffle them, and deal out hands.

The first thing we want to do is create, in code, a model of a deck of cards. Listing 1 shows one way to approach the job with CardsArray.cfm. A quick note on the listings in this article: they all use a Fusedoc at the top of the file to describe the expectations for the code. Even though this code isn't being written for a Fusebox application, the Fusedocs help communicate our intentions in designing the code.

So the responsibilities for CardsArray.cfm are to create an array then populate it with 52 members representing the cards of a standard deck. Line 20 sets up the array then we start the code to get it populated.

Line 21 sets a variable with a list of the suits we want in the deck. Lines 24-34 contain code, including a nested loop, to store card values in the deck array. The outer loop uses the list of suits and the variable aSuit to hold the value of each element of the list as it loops through. For each value in the list of suits, the inner loop stores the number cards (2-10).

The inner loop uses the variable i to store the value of its index. This is common practice when using counting loops - i is an abbreviation for index. When counting loops are nested, it's common practice to use sequential letters starting with i for the indices. So two nested counting loops are often seen using the indices i and j.

The ArrayAppend() function is used to add a new element to the deckArray. ArrayAppend() is very useful in that we don't need to know the size of the array to add an element - we just specify the array's name and the value to append. Once the inner loop has run, we use four more ArrayAppend() statements to add the face cards and aces for the suit. That's it - the deckArray array has been created and populated. However, there's no code in CardsArray.cfm to display the array, so how do we know it worked properly? Since we might want to reuse this routine, we don't want to display its output here. So we'll use a test harness template.

The test harness is named testCardsArray.cfm, and is shown in Listing 2. All it does is use <cfinclude> for the CardsArray.cfm template then <cfdump> to show the deckArray variable. The output is shown in Figure 1 (the cfdump output has been broken up to save print space).

Now that we have a deck of cards, we're ready to start playing. So we sit down at the card table and I pick up the deck and start dealing. What's that you say? You want me to shuffle the cards? Oh, all right, if you insist. Some people are such sticklers for details.

Listing 3 shows ShuffleDeck.cfm. Its job is to take deckArray as created by CardsArray.cfm and produce a shuffled copy of it named shuffledDeckArray. Line 24 creates the copy then lines 27-31 take care of the shuffle.

There have been many articles written over the years on the subject of sorting and shuffling. There are probably as many shuffle algorithms available in the programming world as there are opinions on any given topic. Fortunately for us, there's a function in CFML that makes shuffling easy. That function is ArraySwap(). As its name implies, it swaps two specified elements of an array. So to do our shuffle, we just pick two random indexes between 1 and 52 using the RandRange() function and then swap those two elements in the deck using the ArraySwap() function.


More Stories By Jeff Peters

Jeff Peters works for Open Source Data Integration Software company XAware.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Conference Guru has been named “Media Sponsor” of the 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. A valuable conference experience generates new contacts, sales leads, potential strategic partners and potential investors; helps gather competitive intelligence and even provides inspiration for new products and services. Conference Guru works with conference organizers to pass great deals to gre...
The Internet of Things will challenge the status quo of how IT and development organizations operate. Or will it? Certainly the fog layer of IoT requires special insights about data ontology, security and transactional integrity. But the developmental challenges are the same: People, Process and Platform. In his session at @ThingsExpo, Craig Sproule, CEO of Metavine, demonstrated how to move beyond today's coding paradigm and shared the must-have mindsets for removing complexity from the develop...
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
"Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.