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:

jAlbum Pro 12.6.4 - Organize your digita...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more
jAlbum 12.6.4 - Create custom photo gall...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
Microsoft Remote Desktop 8.0.16 - Connec...
With Microsoft Remote Desktop, you can connect to a remote PC and your work resources from almost anywhere. Experience the power of Windows with RemoteFX in a Remote Desktop client designed to help... Read more
Spotify 1.0.4.90. - Stream music, create...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
djay Pro 1.1 - Transform your Mac into a...
djay Pro provides a complete toolkit for performing DJs. Its unique modern interface is built around a sophisticated integration with iTunes and Spotify, giving you instant access to millions of... Read more
Vivaldi 1.0.118.19 - Lightweight browser...
Vivaldi browser. In 1994, two programmers started working on a web browser. Our idea was to make a really fast browser, capable of running on limited hardware, keeping in mind that users are... Read more
Stacks 2.6.11 - New way to create pages...
Stacks is a new way to create pages in RapidWeaver. It's a plugin designed to combine drag-and-drop simplicity with the power of fluid layout. Features: Fluid Layout: Stacks lets you build pages... Read more
xScope 4.1.3 - Onscreen graphic measurem...
xScope is powerful set of tools that are ideal for measuring, inspecting, and testing on-screen graphics and layouts. Its tools float above your desktop windows and can be accessed via a toolbar,... Read more
Cyberduck 4.7 - FTP and SFTP browser. (F...
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more
Labels & Addresses 1.7 - Powerful la...
Labels & Addresses is a home and office tool for printing all sorts of labels, envelopes, inventory labels, and price tags. Merge-printing capability makes the program a great tool for holiday... Read more

## Latest Forum Discussions

Discover Your Reflexes With Minimalist G...
Discover O, BYOF Studios, may look simple at first with its' color matching premise and swipe controls, but as you speed up the task becomes more daunting. [Read more] | Read more »
Here's Another Roundup of Notable A...
Now that the Apple Watch is publically available (kind of), even more apps and games have been popping up for it. Some of them are updates to existing software, others are brand new. The main thing is that they're all for the Apple Watch, and if you... | Read more »
Use Batting Average and the Apple Watch...
Batting Average, by Pixolini, is designed to help you manage your statistics. Every time you go to bat, you can use your Apple Watch to track  your swings, strikes, and hits. [Read more] | Read more »
Celebrate Studio Pango's 3rd Annive...
It is time to party, Pangoland pals! Studio Pango is celebrating their 3rd birthday and their gift to you is a new update to Pangoland. [Read more] | Read more »
Become the World's Most Important D...
Must Deliver, by cherrypick games, is a top-down endless-runner witha healthy dose of the living dead. [Read more] | Read more »
SoundHound + LiveLyrics is Making its De...
SoundHound Inc. has announced that SoundHound + LiveLyrics, will be one of the first third-party apps to hit the Apple Watch. With  SoundHound you'll be able to tap on your watch and have the app recognize the music you are listening to, then have... | Read more »
Adobe Joins the Apple Watch Lineup With...
A whole tidal wave of apps are headed for the Apple Watch, and Adobe has joined in with 3 new ways to enhance your creativity and collaborate with others. The watch apps pair with iPad/iPhone apps to give you total control over your Adobe projects... | Read more »
Z Steel Soldiers, Sequel to Kavcom'...
Kavcom has released Z Steel Soldiers, which continues the story of the comedic RTS originally created by the Bitmap Brothers. [Read more] | Read more »
Seene Lets You Create 3D Images With You...
Seene, by Obvious Engineering, is a 3D capture app that's meant to allow you to create visually stunning 3D images with a tap of your finger, and then share them as a 3D photo, video or gif. [Read more] | Read more »
Lost Within - Tips, Tricks, and Strategi...
Have you just downloaded Lost Within and are you in need of a guiding hand? While it’s not the toughest of games out there you might still want some helpful tips to get you started. [Read more] | Read more »

## Price Scanner via MacPrices.net

Zoho Business Apps for Apple Watch Put Select...
Pleasanton, California based Zoho has launched Zoho Business Apps for Apple Watch, a line of apps that extends Zoho business applications to let users perform select functions from an Apple Watch.... Read more
Universal Stylus Initiative Launched to Creat...
OEMs, stylus and touch controller manufacturers have announced the launch of Universal Stylus Initiative (USI), a new organization formed to develop and promote an industry specification for an... Read more
Amazon Shopping App for Apple Watch
With the new Amazon shopping app for Apple Watch, Amazon customers with one of the wearable devices can simply tap the app on the watch to purchase items in seconds, or save an idea for later. The... Read more
Intel Compute Stick: A New Mini-Computing For...
The Intel Compute Stick, a new pocket-sized computer based on a quad-core Intel Atom processor running Windows 8.1 with Bing, is available now through Intel Authorized Dealers across much of the... Read more
Heal to Launch First One-Touch House Call Doc...
Santa Monica, California based Heal, a pioneer in on-demand personal health care services — will offer the first one-touch, on-demand house call doctor app for the Apple Watch. Heal’s Watch app,... Read more
Mac Notebooks: Avoiding MagSafe Power Adapter...
Apple Support says proper usage, care, and maintenance of Your Mac notebook’s MagSafe power adapter can substantially increase the the adapter’s service life. Of course, MagSafe itself is an Apple... Read more
12″ Retina MacBook In Shootout With Air And P...
BareFeats’ rob-ART morgan has posted another comparison of the 12″ MacBook with other Mac laptops, noting that the general goodness of all Mac laptops can make which one to purchase a tough decision... Read more
FileMaker Go for iPad and iPhone: Over 1.5 Mi...
FileMaker has announced that its FileMaker Go for iPad and iPhone app has surpassed 1.5 million downloads from the iTunes App Store. The milestone confirms the continued popularity of the FileMaker... Read more
Sale! 13-inch 2.7GHz Retina MacBook Pro for \$...
Best Buy has the new 2015 13″ 2.7GHz/128GB Retina MacBook Pro on sale for \$1099 – \$200 off MSRP. Choose free shipping or free local store pickup (if available). Price for online orders only, in-... Read more
Minimalist MacBook Confirms Death of Steve Jo...
ReadWrite’s Adriana Lee has posted a eulogy for the “Digital Hub” concept Steve Jobs first proposed back in 2001, declaring the new 12-inch MacBook with its single, over-subscribed USB-C port to be... Read more

## Jobs Board

*Apple* Client Systems Solution Specialist -...
…drive revenue and profit in assigned sales segment and/or region specific to the Apple brand and product sets. This person will work directly with CDW Account Managers Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Support Technician IV - Jack Henry a...
Job Description Jack Henry & Associates is seeking an Apple Support Technician. This position while acting independently, ensures the proper day-to-day control of Read more
*Apple* Client Systems Solution Specialist -...
…drive revenue and profit in assigned sales segment and/or region specific to the Apple brand and product sets. This person will work directly with CDW Account Managers Read more
*Apple* Software Support - Casper (Can work...
…experience . Full knowledge of Mac OS X and prior . Mac OSX / Server . Apple Remote Desktop . Process Documentation . Ability to prioritize multiple tasks in a fast pace Read more