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:


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)>

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
Michael Maximilien, better known as max or Dr. Max, is a computer scientist with IBM. At IBM Research Triangle Park, he was a principal engineer for the worldwide industry point-of-sale standard: JavaPOS. At IBM Research, some highlights include pioneering research on semantic Web services, mashups, and cloud computing, and platform-as-a-service. He joined the IBM Cloud Labs in 2014 and works closely with Pivotal Inc., to help make the Cloud Found the best PaaS.
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
"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.
Business professionals no longer wonder if they'll migrate to the cloud; it's now a matter of when. The cloud environment has proved to be a major force in transitioning to an agile business model that enables quick decisions and fast implementation that solidify customer relationships. And when the cloud is combined with the power of cognitive computing, it drives innovation and transformation that achieves astounding competitive advantage.
The Founder of NostaLab and a member of the Google Health Advisory Board, John is a unique combination of strategic thinker, marketer and entrepreneur. His career was built on the "science of advertising" combining strategy, creativity and marketing for industry-leading results. Combined with his ability to communicate complicated scientific concepts in a way that consumers and scientists alike can appreciate, John is a sought-after speaker for conferences on the forefront of healthcare science,...
Data is the fuel that drives the machine learning algorithmic engines and ultimately provides the business value. In his session at Cloud Expo, Ed Featherston, a director and senior enterprise architect at Collaborative Consulting, discussed the key considerations around quality, volume, timeliness, and pedigree that must be dealt with in order to properly fuel that engine.
Explosive growth in connected devices. Enormous amounts of data for collection and analysis. Critical use of data for split-second decision making and actionable information. All three are factors in making the Internet of Things a reality. Yet, any one factor would have an IT organization pondering its infrastructure strategy. How should your organization enhance its IT framework to enable an Internet of Things implementation? In his session at @ThingsExpo, James Kirkland, Red Hat's Chief Archi...
The current age of digital transformation means that IT organizations must adapt their toolset to cover all digital experiences, beyond just the end users’. Today’s businesses can no longer focus solely on the digital interactions they manage with employees or customers; they must now contend with non-traditional factors. Whether it's the power of brand to make or break a company, the need to monitor across all locations 24/7, or the ability to proactively resolve issues, companies must adapt to...
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settl...
Organizations planning enterprise data center consolidation and modernization projects are faced with a challenging, costly reality. Requirements to deploy modern, cloud-native applications simultaneously with traditional client/server applications are almost impossible to achieve with hardware-centric enterprise infrastructure. Compute and network infrastructure are fast moving down a software-defined path, but storage has been a laggard. Until now.
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...
DXWorldEXPO LLC announced today that the upcoming DXWorldEXPO | CloudEXPO New York event will feature 10 companies from Poland to participate at the "Poland Digital Transformation Pavilion" on November 12-13, 2018.
Digital Transformation is much more than a buzzword. The radical shift to digital mechanisms for almost every process is evident across all industries and verticals. This is often especially true in financial services, where the legacy environment is many times unable to keep up with the rapidly shifting demands of the consumer. The constant pressure to provide complete, omnichannel delivery of customer-facing solutions to meet both regulatory and customer demands is putting enormous pressure on...
The best way to leverage your CloudEXPO | DXWorldEXPO presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering CloudEXPO | DXWorldEXPO will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at CloudEXPO. Product announcements during our show provide your company with the most reach through our targeted audienc...
JETRO showcased Japan Digital Transformation Pavilion at SYS-CON's 21st International Cloud Expo® at the Santa Clara Convention Center in Santa Clara, CA. The Japan External Trade Organization (JETRO) is a non-profit organization that provides business support services to companies expanding to Japan. With the support of JETRO's dedicated staff, clients can incorporate their business; receive visa, immigration, and HR support; find dedicated office space; identify local government subsidies; get...
DXWorldEXPO LLC announced today that All in Mobile, a mobile app development company from Poland, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. All In Mobile is a mobile app development company from Poland. Since 2014, they maintain passion for developing mobile applications for enterprises and startups worldwide.
@DevOpsSummit at Cloud Expo, taking place November 12-13 in New York City, NY, is co-located with 22nd international CloudEXPO | first international DXWorldEXPO and will feature technical sessions from a rock star conference faculty and the leading industry players in the world.
"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.
As data explodes in quantity, importance and from new sources, the need for managing and protecting data residing across physical, virtual, and cloud environments grow with it. Managing data includes protecting it, indexing and classifying it for true, long-term management, compliance and E-Discovery. Commvault can ensure this with a single pane of glass solution – whether in a private cloud, a Service Provider delivered public cloud or a hybrid cloud environment – across the heterogeneous enter...
DXWorldEXPO LLC announced today that ICC-USA, a computer systems integrator and server manufacturing company focused on developing products and product appliances, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City. ICC is a computer systems integrator and server manufacturing company focused on developing products and product appliances to meet a wide range of ...