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.

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:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Six fantastic ways to spend National Vid...
As if anyone needed an excuse to play games today, I am about to give you one: it is National Video Games Day. A day for us to play games, like we no doubt do every day. Let’s not look a gift horse in the mouth. Instead, feast your eyes on this... | Read more »
Old School RuneScape players turn out in...
The sheer leap in technological advancements in our lifetime has been mind-blowing. We went from Commodore 64s to VR glasses in what feels like a heartbeat, but more importantly, the internet. It can be a dark mess, but it also brought hundreds of... | Read more »
Today's Best Mobile Game Discounts...
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links below... | Read more »
Nintendo and The Pokémon Company's...
Unless you have been living under a rock, you know that Nintendo has been locked in an epic battle with Pocketpair, creator of the obvious Pokémon rip-off Palworld. Nintendo often resorts to legal retaliation at the drop of a hat, but it seems this... | Read more »
Apple exclusive mobile games don’t make...
If you are a gamer on phones, no doubt you have been as distressed as I am on one huge sticking point: exclusivity. For years, Xbox and PlayStation have done battle, and before this was the Sega Genesis and the Nintendo NES. On console, it makes... | Read more »
Regionally exclusive events make no sens...
Last week, over on our sister site AppSpy, I babbled excitedly about the Pokémon GO Safari Days event. You can get nine Eevees with an explorer hat per day. Or, can you? Specifically, you, reader. Do you have the time or funds to possibly fly for... | Read more »
As Jon Bellamy defends his choice to can...
Back in March, Jagex announced the appointment of a new CEO, Jon Bellamy. Mr Bellamy then decided to almost immediately paint a huge target on his back by cancelling the Runescapes Pride event. This led to widespread condemnation about his perceived... | Read more »
Marvel Contest of Champions adds two mor...
When I saw the latest two Marvel Contest of Champions characters, I scoffed. Mr Knight and Silver Samurai, thought I, they are running out of good choices. Then I realised no, I was being far too cynical. This is one of the things that games do best... | Read more »
Grass is green, and water is wet: Pokémo...
It must be a day that ends in Y, because Pokémon Trading Card Game Pocket has kicked off its Zoroark Drop Event. Here you can get a promo version of another card, and look forward to the next Wonder Pick Event and the next Mass Outbreak that will be... | Read more »
Enter the Gungeon review
It took me a minute to get around to reviewing this game for a couple of very good reasons. The first is that Enter the Gungeon's style of roguelike bullet-hell action is teetering on the edge of being straight-up malicious, which made getting... | Read more »

Price Scanner via MacPrices.net

Take $150 off every Apple 11-inch M3 iPad Air
Amazon is offering a $150 discount on 11-inch M3 WiFi iPad Airs right now. Shipping is free: – 11″ 128GB M3 WiFi iPad Air: $449, $150 off – 11″ 256GB M3 WiFi iPad Air: $549, $150 off – 11″ 512GB M3... Read more
Apple iPad minis back on sale for $100 off MS...
Amazon is offering $100 discounts (up to 20% off) on Apple’s newest 2024 WiFi iPad minis, each with free shipping. These are the lowest prices available for new minis among the Apple retailers we... Read more
Apple’s 16-inch M4 Max MacBook Pros are on sa...
Amazon has 16-inch M4 Max MacBook Pros (Silver and Black colors) on sale for up to $410 off Apple’s MSRP right now. Shipping is free. Be sure to select Amazon as the seller, rather than a third-party... Read more
Red Pocket Mobile is offering a $150 rebate o...
Red Pocket Mobile has new Apple iPhone 17’s on sale for $150 off MSRP when you switch and open up a new line of service. Red Pocket Mobile is a nationwide MVNO using all the major wireless carrier... Read more
Switch to Verizon, and get any iPhone 16 for...
With yesterday’s introduction of the new iPhone 17 models, Verizon responded by running “on us” promos across much of the iPhone 16 lineup: iPhone 16 and 16 Plus show as $0/mo for 36 months with bill... Read more
Here is a summary of the new features in Appl...
Apple’s September 2025 event introduced major updates across its most popular product lines, focusing on health, performance, and design breakthroughs. The AirPods Pro 3 now feature best-in-class... Read more
Apple’s Smartphone Lineup Could Use A Touch o...
COMMENTARY – Whatever happened to the old adage, “less is more”? Apple’s smartphone lineup. — which is due for its annual refresh either this month or next (possibly at an Apple Event on September 9... Read more
Take $50 off every 11th-generation A16 WiFi i...
Amazon has Apple’s 11th-generation A16 WiFi iPads in stock on sale for $50 off MSRP right now. Shipping is free: – 11″ 11th-generation 128GB WiFi iPads: $299 $50 off MSRP – 11″ 11th-generation 256GB... Read more
Sunday Sale: 14-inch M4 MacBook Pros for up t...
Don’t pay full price! Amazon has Apple’s 14-inch M4 MacBook Pros (Silver and Black colors) on sale for up to $220 off MSRP right now. Shipping is free. Be sure to select Amazon as the seller, rather... Read more
Mac mini with M4 Pro CPU back on sale for $12...
B&H Photo has Apple’s Mac mini with the M4 Pro CPU back on sale for $1259, $140 off MSRP. B&H offers free 1-2 day shipping to most US addresses: – Mac mini M4 Pro CPU (24GB/512GB): $1259, $... Read more

Jobs Board

All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.