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

NetNewsWire 4.0.0 - RSS and Atom news re...
NetNewsWire is the best way to keep up with the sites and authors you read most regularly. Let NetNewsWire pull down the latest articles, and read them in a distraction-free and Mac-like way. Native... Read more
MacUpdate Desktop 6.0.6 - Search and ins...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
ForkLift 2.6.5 - Powerful file manager:...
ForkLift is a powerful file manager and ferociously fast FTP client clothed in a clean and versatile UI that offers the combination of absolute simplicity and raw power expected from a well-executed... Read more
Drive Genius 4.1.0 - Powerful system uti...
Drive Genius 4 gives you faster performance from your Mac while also protecting it. The award-winning and improved DrivePulse feature alerts you to hard drive issues before they become major problems... Read more
OnyX 2.9.7 - Maintenance and optimizatio...
OnyX is a multifunctional utility for OS X. It allows you to verify the startup disk and the structure of its System files, to run miscellaneous tasks of system maintenance, to configure the hidden... Read more
DEVONthink Pro 2.8.5 - Knowledge base, i...
DEVONthink Pro is your essential assistant for today's world, where almost everything is digital. From shopping receipts to important research papers, your life often fills your hard drive in the... Read more
Backblaze 4.0.1.878 - Online backup serv...
Backblaze is an online backup service designed from the ground-up for the Mac.With unlimited storage available for $5 per month, as well as a free 15-day trial, peace of mind is within reach with... Read more
Apple Remote Desktop Client 3.8.4 - Clie...
Note: Apple Remote Desktop Client is available only through Software Update (the Updates tab in App Store.app. Apple Remote Desktop Client is the best way to manage the Mac computers on your network... Read more
Merlin Project 3.0.7.39619 - Project man...
Merlin Project is for those of you who are responsible for complex projects. Simple lists of tasks won't suffice. Good planning raises questions about the dependencies of activities on each other,... Read more
Tidy Up 4.1.0 - Find duplicate files and...
Tidy Up is a complete duplicate finder and disk-tidiness utility. With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator, extension, time... Read more

Carbo - Handwriting in the Digital Age...
Carbo - Handwriting in the Digital Age 1.0 Device: iOS Universal Category: Productivity Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
The Apple Watch isn't Great as a Fi...
| Read more »
Show the World What You See With Stre.am...
Live broadcasting is getting popular on mobile devices, which is why you can now get Stre.am, by Infinite Takes. [Read more] | Read more »
PhotoTime's 2.1 Update Adds Apple W...
The latest PhotoTime update is adding even more functionality to the handy photo organizing app. Yep, including Apple Watch support. [Read more] | Read more »
Oh My Glob! Adventure Time Puzzle Quest...
Finn and Jake are taking over D3 Go!'s popular puzzle game series in the upcoming Adventure Time Puzzle Quest. [Read more] | Read more »
Earthcore: Shattered Elements - Tips, Tr...
At first glance, Earthcore: Shattered Elements seems like a rather simple card-battling game. Once you’re introduced to skills that will change quite a bit. Even more so once you start to acquire hero cards. But it’s not so complicated that we... | Read more »
Dungeon999F (Games)
Dungeon999F 1.33 Device: iOS Universal Category: Games Price: $.99, Version: 1.33 (iTunes) Description: "The game you must play at least once in your life!" "The game with potential of million downloads globally!" ...is what the... | Read more »
Mixels Rush - Use Mixes, Maxes and Murps...
Mixels Rush - Use Mixes, Maxes and Murps to Outrun the Nixels 1.0.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.0 (iTunes) Description: Use awesome new Mixels and make crazy combinations to beat the annoying... | Read more »
Battles of the Ancient World II (Games)
Battles of the Ancient World II 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Sword Of Xolan (Games)
Sword Of Xolan 1.0.4 Device: iOS Universal Category: Games Price: $.99, Version: 1.0.4 (iTunes) Description: Sword of Xolan is an action platformer game that includes the juice of pixel art style. Xolan is a young and brave man who... | Read more »

Price Scanner via MacPrices.net

Sale! 16GB iPad mini 3 for $349, save $50
B&H Photo has the 16GB iPad mini 3 WiFi on sale for $349 including free shipping plus NY sales tax only. Their price is $50 off MSRP, and it’s the lowest price available for this model. Read more
Price drop on 2014 15-inch Retina MacBook Pro...
B&H Photo has dropped prices on 2014 15″ Retina MacBook Pros by $200. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799.99 save $200 - 15″ 2.5GHz... Read more
Will iOS 9 Finally Bring Productivity Friendl...
Ah, the irony. From its original announcement in 2010, Apple has doggedly insisted that the iPad remain “simple,” thus arbitrarily limiting its considerable potential as a content creation and... Read more
13-inch 2.5GHz MacBook Pro (refurbished) avai...
The Apple Store has Apple Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.... Read more
Mac Pros on sale for up to $260 off MSRP
B&H Photo has Mac Pros on sale for up to $260 off MSRP. Shipping is free, and B&H charges sales tax in NY only: - 3.7GHz 4-core Mac Pro: $2799, $200 off MSRP - 3.5GHz 6-core Mac Pro: $3719.99... Read more
Save up to $600 with Apple refurbished Mac Pr...
The Apple Store has Apple Certified Refurbished Mac Pros available for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more
Apple drops price on refurbished 15-inch 2.2G...
The Apple Store has dropped their price on the Apple Certified Refurbished 2014 15″ 2.2GHz Retina MacBook Pro to $1609, $390 off original MSRP. Apple’s one-year warranty is included, and shipping is... Read more
Apple restocks refurbished Mac minis for up t...
The Apple Store has restocked Apple Certified Refurbished 2014 Mac minis, with models available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz... Read more
Cover For iPhone Helps You Create Beautiful P...
Taking photos, editing and sharing them is one of the things most of people do on their iPhones for fun, especially if they’re users of social media. Unfortunately, many iOS photo-editing solutions... Read more
Password Keyboard 1.0 For iOS Handles Logins...
Pfaeffikon, Switzerland based Power APP has introduced Password Keyboard 1.0.0, their new password utility developed for iPhone, iPad and iPod touch devices. Password Keyboard is designed to simplify... Read more

Jobs Board

Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
Visual Merchandise Manager %u2013 Accessories...
…to be part of an incredible team. Imagine what you could do here. At Apple , great ideas have a way of becoming reality very quickly. Our Accessories assortment makes Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** The ASC is an Apple employee who serves as the Apple business manager and influencer in a hyper-business critical Reseller's store which delivers Read more
Technical Project Manager - *Apple* Pay - A...
**Job Summary** Apple Pay is seeking an experienced technical PM…manage the rollout of features to merchants for the Apple Pay platform in the US Within this role Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.