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.

## ASCII85 ENCODING

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,
numOutputBytesPtr)
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).

## TWO MONTHS AGO WINNER

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 +
deltaOffset;
size = targetMatch -
replacePB.targetStart;
if ( size < kBlockMoveMin )
while ( targetOld < targetMatch )
*targetNew++ = *targetOld++;
else
BlockMove( targetOld, targetNew,
size );
}

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

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

noMatch:;
}

/* 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 -
replacePB.targetStart;
if ( size < kBlockMoveMin )
while ( targetOld < replacePB.targetEnd )
*targetNew++ = *targetOld++;
else
BlockMove( targetOld, targetNew, size );

/* Resize target*/
SetHandleSize ( targetHndl,
replacePB.targetSize += deltaOffset );
if ( MemError() != noErr)
numReplace = -1;
}
}
else
/* 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 -
replacePBPtr->targetStart;
while ( target < replacePBPtr->targetEnd ) {
if ( *target++ == *replacePBPtr->sourceStart ) {

/* Beginning of potential match */
targetMatch = target - 1;
targetMatchOffset = targetMatch -
replacePBPtr->targetStart;
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 +
targetMatchOffset;
targetNew = targetMatch + deltaOffset;
if ( replacePBPtr->replaceSize <
kBlockMoveMin ) {
targetNew += replacePBPtr->replaceSize;
replace = replacePBPtr->replaceEnd;
while ( replace >
replacePBPtr->replaceStart )
*--targetNew = *--replace;
}
else
BlockMove( replacePBPtr->replaceStart,
targetNew,
replacePBPtr->replaceSize );

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

/* 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->targetHndl;
replacePBPtr->targetEnd =
replacePBPtr->targetStart +
replacePBPtr->targetSize;
replacePBPtr->replaceStart =
*replacePBPtr->replaceHndl;

replacePBPtr->replaceEnd =
replacePBPtr->replaceStart +
replacePBPtr->replaceSize;

/* Expand target from last match to end */
targetOld = replacePBPtr->targetEnd -
deltaOffset;
targetEntry = replacePBPtr->targetStart +
targetEntryOffset;
size = targetOld - targetEntry;
if ( size < kBlockMoveMin ) {
targetNew = replacePBPtr->targetEnd;
while ( targetOld > targetEntry )
*--targetNew = *--targetOld;
}
else {
targetNew = targetEntry + deltaOffset;
BlockMove( targetEntry, targetNew, size );
}
}
else
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: progchallenge@xplain.com, 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:

Microsoft Office 2016 16.11 - Popular pr...
Microsoft Office 2016 - Unmistakably Office, designed for Mac. The new versions of Word, Excel, PowerPoint, Outlook, and OneNote provide the best of both worlds for Mac users - the familiar Office... Read more
Adobe Photoshop CC 2018 19.1.2 - Profess...
Photoshop CC 2018 is available as part of Adobe Creative Cloud for as little as \$19.99/month (or \$9.99/month if you're a previous Photoshop customer). Adobe Photoshop CC 2018, the industry standard... Read more
Adobe Dreamweaver CC 2018 18.1.0.10155 -...
Dreamweaver CC 2018 is available as part of Adobe Creative Cloud for as little as \$19.99/month (or \$9.99/month if you're a previous Dreamweaver customer). Adobe Dreamweaver CC 2018 allows you to... Read more
Adobe Flash Player 29.0.0.113 - Plug-in...
Adobe Flash Player is a cross-platform, browser-based application runtime that provides uncompromised viewing of expressive applications, content, and videos across browsers and operating systems.... Read more
Drive Genius 5.2.0 - \$79.00
Drive Genius features a comprehensive Malware Scan. Automate your malware protection. Protect your investment from any threat. The Malware Scan is part of the automated DrivePulse utility. DrivePulse... Read more
MegaSeg 6.0.6 - Professional DJ and radi...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more
ffWorks 1.0.7 - Convert multimedia files...
ffWorks (was iFFmpeg), focused on simplicity, brings a fresh approach to the use of FFmpeg, allowing you to create ultra-high-quality movies without the need to write a single line of code on the... Read more
Dash 4.1.5 - Instant search and offline...
Dash is an API documentation browser and code snippet manager. Dash helps you store snippets of code, as well as instantly search and browse documentation for almost any API you might use (for a full... Read more
Evernote 7.0.3 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
jAlbum Pro 15.3 - Organize your digital...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. You can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly... Read more

## Latest Forum Discussions

All the best games on sale for iPhone an...
It might not have been the greatest week for new releases on the App Store, but don't let that get you down, because there are some truly incredible games on sale for iPhone and iPad right now. Seriously, you could buy anything on this list and I... | Read more »
Everything You Need to Know About The Fo...
In just over a week, Epic Games has made a flurry of announcements. First, they revealed that Fortnite—their ultra-popular PUBG competitor—is coming to mobile. This was followed by brief sign-up period for interested beta testers before sending out... | Read more »
The best games that came out for iPhone...
It's not been the best week for games on the App Store. There are a few decent ones here and there, but nothing that's really going to make you throw down what you're doing and run to the nearest WiFi hotspot in order to download it. That's not to... | Read more »
Death Coming (Games)
Death Coming 1.1.1.536 Device: iOS Universal Category: Games Price: \$1.99, Version: 1.1.1.536 (iTunes) Description: --- Background Story ---You Died. Pure and simple, but death was not the end. You have become an agent of Death: a... | Read more »
Hints, tips, and tricks for Empires and...
Empires and Puzzles is a slick match-stuff RPG that mixes in a bunch of city-building aspects to keep things fresh. And it's currently the Game of the Day over on the App Store. So, if you're picking it up for the first time today, we thought it'd... | Read more »
What You Need to Know About Sam Barlow’s...
Sam Barlow’s follow up to Her Story is #WarGames, an interactive video series that reimagines the 1983 film WarGames in a more present day context. It’s not exactly a game, but it’s definitely still interesting. Here are the top things you should... | Read more »
Pixel Plex Guide - How to Build Better T...
Pixel Plex is the latest city builder that has come to the App Store, and it takes a pretty different tact than the ones that came before it. Instead of being in charge of your own city by yourself, you have to work together with other players to... | Read more »
Fortnite Will Be Better Than PUBG on Mob...
Before last week, if you asked me which game I prefer between Fortnite Battle Royale and PlayerUnknown’s Battlegrounds (PUBG), I’d choose the latter just about 100% of the time. Now that we know that both games are primed to hit our mobile screens... | Read more »
Siege of Dragonspear (Games)
Siege of Dragonspear 2.5.12 Device: iOS Universal Category: Games Price: \$9.99, Version: 2.5.12 (iTunes) Description: Experience the Siege of Dragonspear, an epic Baldur’s Gate tale, filled with with intrigue, magic, and monsters.... | Read more »
7 Wonders Guide - Should You Buy The Lea...
The fantastic mobile version of 7 Wonders just got updated with an expansion that adds Leaders to the game. This new content adds a whole layer of depth to the game, but before you spend \$1.99 to buy it blindly, check out this breakdown of exactly... | Read more »

## Price Scanner via MacPrices.net

B&H drops prices on 15″ MacBook Pros up t...
B&H Photo has dropped prices on new 2017 15″ MacBook Pros, now up to \$300 off MSRP and matching Adorama’s price drop yesterday. Shipping is free, and B&H charges sales tax for NY & NJ... Read more
Apple restocks Certified Refurbished 2017 13″...
Apple has restocked Certified Refurbished 2017 13″ 2.3GHz MacBook Pros for \$200-\$230 off MSRP. A standard Apple one-year warranty is included with each MacBook, models receive new outer cases, and... Read more
13″ Space Gray Touch Bar MacBook Pros on sale...
Adorama has new 2017 13″ Space Gray Touch Bar MacBook Pros on sale for \$150 off MSRP. Shipping is free, and Adorama charges sales tax in NY & NJ only: – 13″ 3.1GHz/256GB Space Gray MacBook Pro (... Read more
Best deal of the year on 15″ Apple MacBook Pr...
Adorama has New 2017 15″ MacBook Pros on sale for up to \$300 off MSRP. Shipping is free, and Adorama charges sales tax in NJ and NY only: – 15″ 2.8GHz Touch Bar MacBook Pro Space Gray (MPTR2LL/A): \$... Read more
Save \$100-\$150+ on 13″ Touch Bar MacBook Pros...
B&H Photo has 13″ Touch Bar MacBook Pros on sale for \$100-\$150 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13″ 3.1GHz/256GB Space Gray MacBook Pro... Read more
Current deals on 27″ Apple iMacs, models up t...
B&H Photo has 27″ iMacs on sale for up to \$150 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 27″ 3.8GHz iMac (MNED2LL/A): \$2149 \$150 off MSRP – 27″ 3... Read more
Thursday Deal: 13″ 2.3GHz MacBook Pro for \$11...
B&H Photo has the 13″ 2.3GHz/128GB Space Gray MacBook Pro on sale for \$100 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13-inch 2.3GHz/128GB Space... Read more
How to save \$100-\$190 on 10″ & 12″ iPad P...
Apple is now offering Certified Refurbished 2017 10″ and 12″ iPad Pros for \$100-\$190 off MSRP, depending on the model. An Apple one-year warranty is included with each model, and shipping is free: –... Read more
Silver 12″ 1.3GHz MacBook on sale at B&H...
B&H Photo has the 2017 12″ 1.3GHz Silver MacBook on sale for \$1399.99 including free shipping plus sales tax for NY & NJ residents only. Their price is \$200 off MSRP, and it’s the lowest... Read more
Amazon offers 21″ Apple iMacs for up to \$150...
Amazon 21″ iMacs on sale today for \$50-\$150 off MSRP, depending on the model. Shipping is free: – 21″ 3.4GHz 4K iMac (MNE02LL/A): \$1349.99 \$150 off MSRP – 21″ 3.0GHz iMac (MNDY2LL/A): \$1199 \$100 off... Read more