TweetFollow Us on Twitter

Oct 93 Challenge
Volume Number:9
Issue Number:10
Column Tag:Programmers’ Challenge

Programmers’ Challenge

By Mike Scanlin, MacTech Magazine Regular Contributing Author

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.


This month we have a straightforward computation challenge: Write a fast ASCII85 encoder. What’s that, you ask? It’s a method of encoding binary data as ASCII characters so that it can be put into things that understand ASCII but not binary data (e-mail messages, for example). It’s also one possible format that EPS files are stored in. If you want your application to be EPS-friendly then you’ll need this routine (as well as the corresponding decoder, which is not part of this challenge).

Here’s how it works: Every 4 bytes of binary data input results in 5 bytes of ASCII character output in the range ! through u. A newline character (0x0D) is inserted in the ASCII output at least once every 80 characters to limit the length of lines. When you have encoded all the binary data, you write out ~> as an end-of-data marker.

More precisely, each set of binary input bytes (b1, b2, b3, b4) produces a set of encoded ASCII characters (c1, c2, c3, c4, c5) such that:

(b1 * 2563) + (b2 * 2562) + (b3 * 256) + b4 =
(c1 * 854) + (c2 * 853) + (c3 * 852) + (c4 * 85) + c5

So, the 4 bytes of binary data are a base-256 number that are converted into 5 bytes of a base-85 number. The 5 digits of this number (c1..c5) are then converted to ASCII by adding 33, the ASCII code of !. ASCII characters in the range of ! to u are used, where ! represents the value 0 and u represents the value 84. There is one special case where if all 5 digits are zero they are encoded as a single character z instead of !!!!!.

If the size of the input binary data is not a multiple of 4 then the final set of output bytes are created by taking the n input bytes (1, 2 or 3) and padding with 4-n zero bytes and then converting the result to ASCII85 normally but without applying the special z case. Then, write out n+1 bytes of the resulting ASCII85 data, followed immediately by the ~> marker. This allows an ASCII85 decoder to know the actual number and values of all real input bytes.

The prototype of the function you write is:

void ASCII85Encode(inputPtr, 
 numInputBytes, outputPtr, 
char    *inputPtr;
unsigned long    numInputBytes;
char    *outputPtr;
unsigned long    *numOutputBytesPtr;

The inputPtr and numInputBytes describe the binary data input (numInputBytes will average about 64K). You fill the buffer pointed to by outputPtr with the ASCII85 data you create. The buffer is allocated for you and is big enough to handle the worst case output, given numInputBytes. You set *numOutputBytesPtr equal to the total number of bytes you put in the buffer (including the 2 for the end-of-data marker).


Perhaps I should re-emphasize that correctness is the first criteria for a winning solution. I had to disqualify 6 out of the 17 entries I received for the Replace All challenge because they lacked correctness. Be sure to test your entries with a range of inputs, please, if you’re serious about wanting to win.

Of the 11 who survived my test suite (which was not really that severe) there were four that were very close in speed. The one who came out a little faster than the others most of the time was from Tom Elwertowski (Cambridge, MA) who makes the observation that if the replacement length is not greater than the source length then you can replace strings as you find them; otherwise you have to find all the matches in a first pass and then do a second pass to make the actual replacements (back to front). Bill Karsh (location unknown) deserves mention for coming in fastest almost as often as Tom when the replacement string was equal to or shorter than the source string. However, for some cases where the replacement string was longer than the source string his code was near the bottom of the pack (the times given below are average times for all test cases).

A couple of people were quick to realize that the ROM’s Munger trap could be used to solve this puzzle. However as the table below shows, it’s possible to do much better, in terms of speed, if you don’t use Munger (‘*’ = an entry that used Munger for at least part of the solution; ‘**’ = an entry that was all Munger). Using Munger does make for small code though.

Here are the average times and sizes (numbers in parens after a person’s name indicate how many times that person has finished in the top 5 places of all previous programmer challenges, not including this one):

Name bytes avg ticks

Tom Elwertowski 864 54

Jeff Mallett (2) 770 60

Gerry Davis (1) 1042 64

Bill Karsh 1320 69

Stepan Riha (3) 1132 92

Jan Bruyndonckx 826 101

David Rand * 880 140

Bob Boonstra (2) 528 188

Dave Darrah ** 90 301

John Baxter ** 122 313

Eric Josserand 572 343

There are really 3 cases you need to think about to write a fast ReplaceAll: (1) replacement string and source string are the same length, (2) replacement string is shorter than the source string and (3) replacement string is longer than the source string. The first is the fastest; you just overwrite the source string with the replacement string in place and you don’t need to move any other bytes. The second case is almost as fast; you overwrite the source string with a shorter replacement string and then degap the Handle by the difference in lengths (of course, you cumulatively degap as you find/replace, and not completely degap after each individual replace). The third case is the slowest because it requires two passes to do it efficiently: during the first pass you find all occurrences of the source string and mark them (or keep an array of their positions), then you grow the Handle by the difference in lengths between the replacement string and the source string times the number of occurrences of the source string you found; then you start at the back of the Handle moving bytes and making replacements as you go. This guarantees a minimum of Handle resizing and gapping.

In addition, if you are motivated, you could add the special case code that Bill Karsh did that checks for replacement and source strings of length exactly equal to 1 and have a tiny little loop that screams for that case (which will catch those reviewers who time the real-world, every-day case of changing a page of “a”s into a page of “b”s to make their word processing speed comparison charts). And you could add a table driven search algorithm like Stepan Riha (Austin, TX) did that minimizes search time in cases where partial matches are common.

Or you could forget all that and listen to John Baxter (location unknown) who says “There is, IMHO, too much optimization and too little problem solving going on in the world (but I do enjoy the challenge feature and your optimization series). Clearly SOME optimization has its place, but the last time I routinely cared about squeezing the last possible cycle OR storage location out of code was about 1959.” Well, John, I can see your point but as a user who does ReplaceAlls on 200 page documents fairly often I can assure you that optimizing that operation is time well spent.

Here’s Tom’s winning solution:

/* Tom Elwertowski
 * ReplaceAll( sourceHndl, replaceHndl, targetHndl )
 * Replace all occurrances of sourceHndl in targetHndl with
 * replaceHndl. If replace length is not greater than source
 * length, replacement can be done as search proceeds.
 * Otherwise, all occurrances must be found first in order
 * to determine how much target will grow. A recursive
 * solution is used in the latter case; matches are found
 * on the way in and replacement occurs on the way out.
 * Depending upon run length, substrings are moved either
 * by a byte copy loop or by the BlockMove routine. A word
 * move loop was considered and rejected. Best performance
 * was achieved for these string sizes: byte loop: <9,
 * word loop: 9-200 and BlockMove: >200. A word loop must
 * check for and deal with word nonaligmnent however which
 * resulted in more than a few lines of code and an inline
 * solution appeared excessively cumbersome. When all three
 * approaches were put in a subroutine, the additional
 * overhead swamped the gain in most cases. The compromise
 * was to use inline code with a byte loop for substrings
 * up to 21 characters and a BlockMove otherwise.

#define kBlockMoveMin 22

typedef struct replaceParamBlock {
 Handle sourceHndl;
 long sourceSize;
 char *sourceStart;
 char *sourceEnd;
 Handle replaceHndl;
 long replaceSize;
 char *replaceStart;
 char *replaceEnd;
 Handle targetHndl;
 long targetSize;
 char *targetStart;
 char *targetEnd;
 long deltaSize;
} replaceParamBlock, *replaceParamBlockPtr;

long replaceOne( char *target, long depth, long deltaOffset,
 replaceParamBlockPtr replacePBPtr);

long ReplaceAll( Handle sourceHndl, Handle replaceHndl,
 Handle targetHndl )
 replaceParamBlock replacePB;
 char *target, *targetMatch, *targetOld, *targetNew,
 *source, *replace;
 long numReplace, deltaOffset, size;

 replacePB.sourceHndl = sourceHndl;
 replacePB.sourceSize = GetHandleSize( sourceHndl);
 replacePB.sourceStart = *sourceHndl;
 replacePB.sourceEnd =
 replacePB.sourceStart + replacePB.sourceSize;
 replacePB.replaceHndl = replaceHndl;
 replacePB.replaceSize = GetHandleSize( replaceHndl);
 replacePB.replaceStart = *replaceHndl;
 replacePB.replaceEnd =
 replacePB.replaceStart + replacePB.replaceSize;
 replacePB.targetHndl = targetHndl;
 replacePB.targetSize = GetHandleSize( targetHndl);
 replacePB.targetStart = *targetHndl;
 replacePB.targetEnd = 
 replacePB.targetStart + replacePB.targetSize;
 replacePB.deltaSize =
 replacePB.replaceSize - replacePB.sourceSize;

 numReplace = 0;
 deltaOffset = 0;
 if ( replacePB.deltaSize <= 0 ) {

 /* Iterative solution when 
  * replacement not longer then source */
 target = replacePB.targetStart;
 while ( target < replacePB.targetEnd) {
 if ( *target++ == *replacePB.sourceStart ) {

 /* Beginning of potential match */
 targetMatch = target - 1;
 source = replacePB.sourceStart + 1;
 while ( source < replacePB.sourceEnd )
 if ( *target++ != *source++ )
 goto noMatch;

 /* Match encountered */

 /* Shift unchanged segment of  target */
 if (numReplace > 0 &&
 replacePB.deltaSize < 0 ) {
 targetOld = replacePB.targetStart;
 targetNew = replacePB.targetStart +
 size = targetMatch -
 if ( size < kBlockMoveMin )
 while ( targetOld < targetMatch )
 *targetNew++ = *targetOld++;
 BlockMove( targetOld, targetNew,
 size );

 /* Do replacement */
 replace = replacePB.replaceStart;
 targetNew = targetMatch + deltaOffset;
 if ( replacePB.replaceSize < kBlockMoveMin )
 while ( replace < replacePB.replaceEnd )
 *targetNew++ = *replace++;
 BlockMove( replace, targetNew,
 replacePB.replaceSize );

 deltaOffset += replacePB.deltaSize;
 replacePB.targetStart = target;


 /* End of target encountered */

 /* If replacements have occurred and
  * replacement is shorter */
 if ( numReplace > 0 && replacePB.deltaSize < 0 ) {

 /* Compress target from last match to end */
 targetNew = replacePB.targetStart + deltaOffset;
 targetOld = replacePB.targetStart;
 size = replacePB.targetEnd -
 if ( size < kBlockMoveMin )
 while ( targetOld < replacePB.targetEnd )
 *targetNew++ = *targetOld++;
 BlockMove( targetOld, targetNew, size );

 /* Resize target*/
 SetHandleSize ( targetHndl,
 replacePB.targetSize += deltaOffset );
 if ( MemError() != noErr)
 numReplace = -1;
 /* Recursive solution when
  * replacement is longer than source */
 numReplace = replaceOne( replacePB.targetStart,
 0, 0, &replacePB );
 return ( numReplace );

long replaceOne( char *targetEntry, long depth,
 long deltaOffset, replaceParamBlockPtr replacePBPtr )
 char *source, *replace, *target;
 char *targetOld, *targetNew, *targetMatch;
 long targetEntryOffset, targetMatchOffset, size;
 long numReplace;
 target = targetEntry;
 targetEntryOffset = targetEntry -
 while ( target < replacePBPtr->targetEnd ) {
 if ( *target++ == *replacePBPtr->sourceStart ) {

 /* Beginning of potential match */
 targetMatch = target - 1;
 targetMatchOffset = targetMatch -
 source = replacePBPtr->sourceStart + 1;
 while ( source < replacePBPtr->sourceEnd )
 if ( *target++ != *source++ )
 goto noMatch;

 /* Match encountered. Look for next match */
 numReplace = replaceOne( target, depth + 1,
 deltaOffset + replacePBPtr->deltaSize,
 replacePBPtr );

 /* Expand target after all matches found */
 if ( numReplace > 0 ) {

 /* Do replacement */
 targetMatch = replacePBPtr->targetStart +
 targetNew = targetMatch + deltaOffset;
 if ( replacePBPtr->replaceSize <
 kBlockMoveMin ) {
 targetNew += replacePBPtr->replaceSize;
 replace = replacePBPtr->replaceEnd;
 while ( replace >
 replacePBPtr->replaceStart )
 *--targetNew = *--replace;
 BlockMove( replacePBPtr->replaceStart,
 replacePBPtr->replaceSize );

 /* Shift unchanged segment of target */
 if ( depth > 0 ) {
 targetOld = targetMatch;
 targetEntry =
 replacePBPtr->targetStart +
 size = targetMatch - targetEntry;
 if ( size < kBlockMoveMin )
 while ( targetOld > targetEntry )
 *--targetNew = *--targetOld;
 else {
 targetNew -= size;
 BlockMove( targetEntry, targetNew,
 size );
 return ( numReplace );

 /* End of target encountered */
 if ( depth > 0 ) {

 /* Resize target */
 SetHandleSize ( replacePBPtr->targetHndl,
 replacePBPtr->targetSize += deltaOffset );
 if ( MemError() == noErr) {
 /* Update pointers after possible relocation */
 replacePBPtr->targetStart =
 replacePBPtr->targetEnd =
 replacePBPtr->targetStart +
 replacePBPtr->replaceStart =
 replacePBPtr->replaceEnd =
 replacePBPtr->replaceStart +

 /* Expand target from last match to end */
 targetOld = replacePBPtr->targetEnd -
 targetEntry = replacePBPtr->targetStart +
 size = targetOld - targetEntry;
 if ( size < kBlockMoveMin ) {
 targetNew = replacePBPtr->targetEnd;
 while ( targetOld > targetEntry )
 *--targetNew = *--targetOld;
 else {
 targetNew = targetEntry + deltaOffset;
 BlockMove( targetEntry, targetNew, size );
 depth = -1;

 return ( depth );

The Rules

Here’s how it works: Each month there will be a different programming challenge presented here. First, you must write some code that solves the challenge. Second, you must optimize your code (a lot). Then, submit your solution to MacTech Magazine (formerly MacTutor). A winner will be chosen based on code correctness, speed, size and elegance (in that order of importance) as well as the postmark of the answer. In the event of multiple equally desirable solutions, one winner will be chosen at random (with honorable mention, but no prize, given to the runners up). The prize for the best solution each month is $50 and a limited edition “The Winner! MacTech Magazine Programming Challenge” T-shirt (not to be found in stores).

In order to make fair comparisons between solutions, all solutions must be in ANSI compatible C (i.e., don’t use Think’s Object extensions). Only pure C code can be used. Any entries with any assembly in them will be disqualified (except for those challenges specifically stated to be in assembly). However, you may call any routine in the Macintosh toolbox you want (i.e., it doesn’t matter if you use NewPtr instead of malloc). All entries will be tested with the FPU and 68020 flags turned off in THINK C. When timing routines, the latest version of THINK C will be used (with ANSI Settings plus “Honor ‘register’ first” and “Use Global Optimizer” turned on) so beware if you optimize for a different C compiler. All code should be limited to 60 characters wide. This will aid us in dealing with e-mail gateways and page layout.

The solution and winners for this month’s Programmers’ Challenge will be published in the issue two months later. All submissions must be received by the 10th day of the month printed on the front of this issue.

All solutions should be marked “Attn: Programmers’ Challenge Solution” and sent to Xplain Corporation (the publishers of MacTech Magazine) via “snail mail” or preferably, e-mail - AppleLink: MT.PROGCHAL, Internet:, CompuServe: 71552,174 and America Online: MT PRGCHAL. If you send via snail mail, please include a disk with the solution and all related files (including contact information). See page 2 for information on “How to Contact Xplain Corporation.”

MacTech Magazine reserves the right to publish any solution entered in the Programming Challenge of the Month and all entries are the property of MacTech Magazine upon submission. The submission falls under all the same conventions of an article submission.


Community Search:
MacTech Search:

Software Updates via MacUpdate

How to get a high score in every level o...
Sky Charms is an adorable match three puzzler that provides a decent challenge thanks to its creative level design. It regularly presents something new, forcing you to think on your feet. [Read more] | Read more »
Apestorm: Full Bananas (Games)
Apestorm: Full Bananas 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: ***Launch sale – limited time only!*** Fugitive Apes have taken to the skies in search of revenge after humans have... | Read more »
How to create bigger words in Spellspire
Words have power. At least they do in Spellspire,a game about blasting out magical attacks by making words out of a jumble of letters. And it's a lot of fun. But if you want to be the best, you're going to have to think tactically when you start... | Read more »
Steel Media and DeePoon have partnered f...
Virtual reality is the next big thing, and 148Apps's publisher,Steel Media, wants to know what the hottest upcoming games are. [Read more] | Read more »
Airline Director 2 - Tycoon Game (Games...
Airline Director 2 - Tycoon Game 1.2.1 Device: iOS Universal Category: Games Price: $2.99, Version: 1.2.1 (iTunes) Description: Airline Director 2 is a management game set in the challenging field of commercial aviation. As the... | Read more »
Dog Mendonca (Games)
Dog Mendonca 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: [ Solve a criminal case beyond believe in this supernatural adventure game based on the popular graphic novel trilogy published... | Read more »
Amidakuji Knight (Games)
Amidakuji Knight 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Ghost leg rules meets RPG!Select the best path and save a princess! A long long time ago, there was a beautiful and peaceful... | Read more »
The 5 best mobile games like Game of Thr...
Everyone's favourite weekly dosage of medieval depression, Game of Thrones, is back for its sixth season. An excellent time for the bloodthirsty! [Read more] | Read more »
How to approach quests in Fallen London
Sitting at over 1.5 million words, Fallen London is filled to the brim with intriguing tales and mysterious characters. From the start, you’ll find a slew of quests ripe for the taking. [Read more] | Read more »
How to survive in LOUD on Planet X
LOUD on Planet X is a hybrid of a tower defense and rhythm game that pits famous indie acts against invading aliens. You need timing and strategy in this game in order to succeed, things can get pretty overwhelming pretty quickly. Here are some... | Read more »

Price Scanner via

Aleratec Releases Mac Software Upgrade for 1...
California based Aleratec Inc., designer, developer and manufacturer of Portable Device Management (PDM) charge/sync products for mobile devices and professional-grade duplicators for hard disk... Read more
Sale! Amazon offers 27-inch iMac, 13-inch 2.9...
Amazon has the 27″ 3.2GHz 5K iMac and the 13″ 3.9GHz Retina MacBook Pro on sale for $300 off MSRP, each including free shipping, for a limited time: - 27″ 3.2GHz/1TB HD 5K iMac (model MK462LL/A): $... Read more
Apple refurbished 13-inch Retina MacBook Pros...
Apple has Certified Refurbished 13″ Retina MacBook Pros available for up to $270 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 13″ 2.7GHz... Read more
13-inch 2.7GHz/128GB Retina MacBook Pro on sa...
Take $200 off MSRP on the price of a new 13″ 2.7GHz/128GB Retina MacBook Pro (model MF839LL/A) at Amazon. Shipping is free: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1099.99 $200 off MSRP Act now if... Read more
Apple refurbished clearance 15-inch Retina Ma...
Apple has Certified Refurbished 2014 15″ 2.2GHz Retina MacBook Pros available for $1609, $390 off original MSRP. Apple’s one-year warranty is included, and shipping is free. They have refurbished 15... Read more
27-inch 5K iMacs on sale for up to $150 off M...
B&H Photo has 27″ 5K iMacs on sale for up to $150 off MSRP including free shipping plus NY sales tax only: - 27″ 3.3GHz iMac 5K: $2199 $100 off MSRP - 27″ 3.2GHz/1TB Fusion iMac 5K: $1849.99 $150... Read more
What Does The Refreshed 12-Inch MacBook Tell...
A lot of commentators are complaining that Apple’s update of the 12-Inch MacBook last week is a bit of a damp squib. I don’t know what they were expecting, since it would be very unlike Apple to do a... Read more
Free Wittify Keyboard Now Available On The Ap...
A team of Harvard Business School students have announced that the Wittify Keyboard, a new app utility for iOS devices, is now available on the Apple App Store. The Wittify keyboard and application... Read more
Apple Reports First Year-Over-Year Quarterly...
Apple on TUesday announced financial results for its fiscal 2016 second quarter ending March 26, 2016. The Company posted quarterly revenue of $50.6 billion and quarterly net income of $10.5 billion... Read more
13-inch 2.7GHz Retina MacBook Pros on sale fo...
Take $130-$150 off MSRP on the price of a new 13″ 2.7GHz Retina MacBook Pro at Amazon. Shipping is free: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1169 $130 off MSRP - 13″ 2.7GHz/256GB Retina MacBook... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
*Apple* Solutions Consultant - … (United Sta...
Job Summary As an Apple Solutions Consultant, you'll be the link between our future customers and our products. You'll showcase your entrepreneurial spirit as you Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.