Skip to main content

Building an Array with array_reduce?

Whether it’s twisting a function or taking advantage of side effects and flexible language constructs, it’s no secret I occasionally take joy in writing bastard PHP code. The other day I was in an evil mood and used array_reduce() to construct an array.

If you’re not familiar with array_reduce(), it’s a function that iteratively reduces a given array to a single value using a callback function. For example, suppose the function array_sum() didn’t exist. We could achieve the desired functionality using array_reduce() like so:

<?php
$nums = [1, 2, 3, 4, 5];
$sum = array_reduce(
    $nums,
    function ($acc, $val) { return $acc + $val; },
    0
);

array_reduce() executes the callback function for each element in the array, passing to it an accumulator and the current array member. The returned value is used as the accumulator value for the next iteration. This is roughly the functional equivalent of this iterative approach:

<?php
$acc = 0;
foreach ($nums as $val) {
    $acc = $acc + $val;
}

All and all this is pretty straightforward. array_reduce() is nothing more than a mechanism that iterates over a list with an available accumulator. But what happens when you realize that nothing mandates the single result value must be a scalar? For functional programmers, this is obvious. For most PHP programmers with a procedural or OO background, this is a jaw-dropping realization.

Suppose we need to build an array using data from the Unicode Consortium’s supplemental windowsZones.xml file. To make things interesting, the keys need to be the values of the mapZones’ type properties, and the members need to be the value in the leading comments. That is, the resulting array must look like this:

Array (
    ["Etc/GMT+12"] => "(UTC-12:00) International Date Line West",
    ["Etc/GMT+11"] => "(UTC-11:00) Coordinated Universal Time-11",
    ["Pacific/Pago_Pago"] => "(UTC-11:00) Coordinated Universal Time-11",
    ["Pacific/Niue"] => "(UTC-11:00) Coordinated Universal Time-11",
    ["Pacific/Midway"] => "(UTC-11:00) Coordinated Universal Time-11",
    ["Pacific/Honolulu"] => "(UTC-10:00) Hawaii",
...

The standard XML-processing strategies become cumbersome because of the requirement pertaining to the comment values, and the next best solution is to script a rudimentary stateful parser. We can iterate each line and extract the textual value if it’s a comment, or extract the attribute value if it’s a mapZone element, and assign to the array when we have both pieces of information available.

<?php
$comValue = '';
$zones = array_reduce(
    file('windowsZones.xml'),
    function ($acc, $line) use (&$comValue) {
        $line = trim($line);
        if (strpos($line, '<!-- (') !== false) {
            $comValue = trim($line, '<!-> ');
        }
        elseif ($pos = strpos($line, 'type="')) {
            $typeValues = substr($line, $pos + 6, -3);
            foreach (explode(' ', $typeValues) as $value) {
                $acc[$value] = $comValue;
            }
        }
        return $acc;
    },
    []
);

This approach is going to be an order of magnitude slower than an iterative foreach loop that builds up the $zones array directly because the PHP run-time just isn't optimized for abuse like this. We’d gain speed with foreach, but then we’d miss an opportunity to explore how things work, blend different concepts together, and just have fun. Ultimately it's little excursions like this that help one grow and become a better programmer.

Comments

  1. using array_reduce to build an array is like going on an all butter diet to lose weight

    ReplyDelete

Post a Comment

Popular posts from this blog

Geolocation Search

Services that allow users to identify nearby points of interest continue to grow in popularity. I'm sure we're all familiar with social websites that let you search for the profiles of people near a postal code, or mobile applications that use geolocation to identify Thai restaurants within walking distance. It's surprisingly simple to implement such functionality, and in this post I will discuss how to do so.

The first step is to obtain the latitude and longitude coordinates of any locations you want to make searchable. In the restaurant scenario, you'd want the latitude and longitude of each eatery. In the social website scenario, you'd want to obtain a list of postal codes with their centroid latitude and longitude.

In general, postal code-based geolocation is a bad idea; their boundaries rarely form simple polygons, the area they cover vary in size, and are subject to change based on the whims of the postal service. But many times we find ourselves stuck on a c…

Reading Unicode (UTF-8) in C

In working on scanner code for Kiwi I did a bit of reading up on Unicode. It's not really as difficult as one might think parsing UTF-8 character by character in C. In the end I opted to use ICU so I could take advantage of its character class functions instead of rolling my own, but the by-hand method I thought was still worth sharing. Functions like getc() read in a byte from an input stream. ASCII was the predominant encoding scheme and encoded characters in 7-8 bits, so reading a byte was effectively the same as reading a character. But you can only represent 255 characters using 8 bits, far too little to represent all the characters of the world's languages. The most common Unicode scheme is UTF-8, is a multi-byte encoding scheme capable of representing over 2 million characters using 4 bytes or less. The 128 characters of 7-bit ASCII encoding scheme are encoded the same, the most-significant bit is always 0. Other characters can be encoded as multiple bytes but the mo…

Composing Music with PHP

I’m not an expert on probability theory, artificial intelligence, and machine learning. And even my Music 201 class from years ago has been long forgotten. But if you’ll indulge me for the next 10 minutes, I think you’ll find that even just a little knowledge can yield impressive results if creatively woven together. I’d like to share with you how to teach PHP to compose music. Here’s an example: You’re looking at a melody generated by PHP. It’s not the most memorable, but it’s not unpleasant either. And surprisingly, the code to generate such sequences is rather brief. So what’s going on? The script calculates a probability map of melodic intervals and applies a Markov process to generate a new sequence. In friendlier terms, musical data is analyzed by a script to learn which intervals make up pleasing melodies. It then creates a new composition by selecting pitches based on the possibilities it’s observed. . Standing on ShouldersComposition doesn’t happen in a vacuum. Bach was f…