TweetFollow Us on Twitter

SANE Normalized
Volume Number:6
Issue Number:1
Column Tag:XCMD Corner

SANE Normalized

By Donald Koscheka, Ernst & Young, MacTutor Contributing Editor

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

Ten years makes a big difference. When I started engineering school in 1973, I wanted to learn everything I could about the nascent microcomputer technology. For several years after graduation, however, I had trouble securing meaningful employment as a microcomputer engineer. With the exception of Silicon Valley and an instrumental little hotspot in Texas, there wasn’t much calling for people who knew about microcomputers. Employers were intrigued by my background, but they regarded the microcomputer as not much more than an interesting toy. They argued that micros didn’t have enough memory to do real work, they couldn’t do real number crunching, and so on.

I found myself apologizing for these shortcomings. Realizing that I would probably have to beef up my computer experience, I enrolled in graduate school in 1980 at the University of Illinois. At the time, the school used yet another derivative of the IBM 370. You can imagine my reaction when I discovered that this behemoth was running an operating system called CMS (Conversational Mode System or some such). The entire goal of this operating system was to transform this monolithic hunk of iron in hundreds of “virtual personal computers”. The same people that were pooh-poohing my microcomputer training were spending vast amounts of effort trying to make their mainframes look like personal computers!

Ten years later, I think it’s safe to say that the personal computer cum micro has come of age. Aside from the obvious advances in user interface design, tremendous progress has been made in the personal computer technology.

Nowhere is this more evident than in the floating point support that ships at no extra cost with each and every Macintosh: the Standard Apple Numerics Environment (SANE). Numerics on the Macintosh are as good as or better than numerics on many mainframes. The implications of this quiet little revolution are profound, you can trust your Macintosh to do real number crunching accurately and reliably!

SANE guarantees well-behaved results and you don’t have to be an expert in floating point arithmetic to use the Macintosh numerics package. If you do need to get into the details, SANE is beautifully documented in the Apple Numerics Manual, Second Addition by Addison Wesley. This is one of the best technical publications I have ever read; it is a paragon of simplicity and clarity.

I recently implemented a business graphics package as a set of XCMDs that accepts numbers from Hypercard and plots them into a windoid. I wanted to scale the picture so that it exactly fits within the dimensions of the windoid. I also didn’t want to limit the input data to the domain of integers; a floating point implementation was indicated.

When using SANE, the old adage that knowledge is power is a statement of fact (if one’s definition of power is the number of floating point operations per second). To exploit SANE, you should understand how floating point numbers work in the binary world.

HyperTalk’s callback mechnanism supports conversions between strings and extendeds (80 bit floating point numbers). While this is a good starting place, it only begins to untap the magic of SANE.

Floating point numbers come in a variety of flavors. You must consider factors such as range, precision, speed and space before settling on a format for your program. Simple applications might make do with the 32-bit single precision type, float. Most applications will be adequately served with the 64-bit double precision floating point type (double in “C” or Pascal). Understanding the internals of SANE can help you make a more informed decision.

For example, knowing that all SANE internal operations are performed on the extended type allows you to make an important design decision: if speed is important, you might want to consider doing all of your arithmetic with 80-bit extended numbers so that you can spare your code the overhead of automatic type conversions. If you know a priori that your product will have co-processor support, then the 96-bit extended type may better suit your needs.

For bean counters, there’s even a computational type that allows you to manipulate very large signed integers (64 bits).

The extended data type is the essential SANE type but it is implementation dependent. You should store your numbers in some other language specific format. If you intend to massage the data heavily, you might consider declaring your variables as extendeds so that no intermediate conversions will be made yielding speed for the potential loss of portability. This assumes that you have some worthwhile machine that you want to port to in the first place.

As I studied these floating point formats, I discovered some interesting properties of floating point representations in the binary world. I debug in TMON, so I need to be able to disassemble floating point numbers with the same ease that I disassemble integers. I needed to learn how to read floating point numbers from hex dumps. This is an illuminating exercise so I hope you won’t mind if I share it with you.

A decimal number can be broken down into the product of three numbers (if you ever learned how to use a slide rule, you’ll appreciate the value of this representation):

 -100110 = -1 * 1.001 * 103

Let’s call 1.001 the significand and 3 the exponent (the power of 10 that the significand is raised to). Any decimal number can be represented as the product of a sign, a significand and an exponent. It turns out that this is not just a property of decimal numbers. Binary numbers can be represented in the same fashion:

 1.001 * 23 

is equal to 9 base ten. Demonstrating this provides us with some insights into floating point numbers.

SANE stores numbers in either normalized or denormalized forms. Normalization maximizes precision for a given number of bits (can you prove this to yourself?) Unfortunately, very small numbers cannot be represented in this normalized format; how small the number has to be depends on the number of bits used to represent the number. Unless your idea of a fun afternoon is exploring the Mandelbrot set, you probably won’t need to concern yourself with the difference between normalized and denormalized numbers; suffice it to say that denormalized numbers are very small and characteristically hover around the origin.

SANE uses the format in figure 1 to store 80-bit normalized extended numbers.

Figure 1. Format of extended numbers in SANE.

The most significant bit is the sign bit, just as in signed integers. The next fifteen bits represent the exponent using the formula:

 2(e-16383)

This representation allows for numbers whose orders of magnitude range from 2-16385 to 2+16385. The next field in the number (the i-bit) is set if this is a normalized number, cleared otherwise. The “f” field represents the fractional portion of the significand. If the i-bit is set, then the significand is assembled as 1.f otherwise, the significand is assembled as 0.f. The exponent determines the range of the numbers while the significand determines the resolution of the numbers.

The complete representation for the extended type becomes the product of its components (for normalized numbers):

 (-1)s * 2(e-16383) * 1.f

To test this format, I wrote the following “C” program:

/* 1 */

main(){
 extended x;

 x = 9;
}

to determine the extended representation of 9 decimal. On debugging this number, I noticed that the integer 9 is first converted to a SANE extended which pops out as:

 $4002 9000 0000 0000 0000

To see if this is truly the extended representation of the number, let’s dissect it. The most significant bit is turned off so we know this is a positive number. The next 15 bits represent the exponent, in this case $4002 (hex) which is equal to 16386 decimal. Putting the sign and exponent together reveals the order of magnitude of the number:

 (-1)0 * 2(16386-16383) = 1 * 23 = 8

The rest of the number is the significand. The i-bit is set so this is a normalized number:

 1.0012

The significand is a binary fraction (the word decimal doesn’t quite seem to fit here).

When you see the decimal numbers 0.1, 0.01, 0.001 , you interpret them as 1/10, 1/100 and 1/1000 respectively. The binary numbers 0.12, 0.012 and 0.0012 have identical representations: 1/10, 1/100 and 1/1000 respectively, albeit in a different number system. To determine the value of a binary fraction, you need to know the decimal equivalent of these numbers. That’s simple: (1/10)2 is equivalent to (1/2)10. In the same fashion (1/100)2 = 1/4 and (1/1000)2 = 1/8. By now you should have inferred that these binary fractions are the negative powers of 2.

Armed with this knowledge, we can now determine that 1.0012 is equal to 1 + 1/8 or (1.125)10. We can now finish converting our extended number:

 1 * 23 * 1.125 = 8 * 1.125 = 9

If the significand raised to its exponent yields an integer (no fractional part) you can very quickly determine that value of the number:

  (-1)0 * 23 * 1.001 = 1 * 8 * 1.0012 = 910

In other words, just slide the significand to the right by the number of “decimal” places in the exponent. This is a simple trick that any student of the metric system understands but tends to be forgotten when we change to a non-decimal number system.

Try some of these problems on your own. You might want to consider exercises like finding the largest positive and negative numbers that a given format can represent. Equally interesting, is finding smallest number that can be represented in this format. What does 0 look like (watch this, it’s a trick question)?

Listing 1 contains a grab bag of SANE glue routines which I’ve provided as illustrations of how to interface with SANE. You may never need to use these conversions but knowing how this mechanism works will surely help you to debug code that references SANE.

SANE operations get dispatched via the trap _FP68K which most likely stands for “Floating Point, 68000” (SANE has been implemented on ALL Apple platforms since the mid-80s).

The conversions typically take an input parameter, an output parameter and an opword. The opwords are mnemonic, FX2D stands for extended to double and FL2X stands for long to extended. The conversion utilities in SANE give you a lot of control over how you want to represent your data and how you want to present it to the user. If you’re serious about these conversions, you might want to write a general purpose converter that can convert between any two formats.

If you want to explore SANE further, get a copy of the Apple Numerics Manual. The next time you run into one of those old hacks who believe that, “it ain’t a real computer unless it’s water cooled”, don’t get upset. They need all that power to compensate for the fact that some of those monoliths can’t even add as well as the Macintosh!

/* 2 */

void  ExtToDouble( ext, dbl )
 extended *ext;
 double *dbl;
/******************************
* given the extended IEEE number
* passed in, return its double
* representation
*
******************************/
{

asm{
 move.l 8(A6),-(sp); address of the extended
 move.l 12(A6),-(sp) ; address of the double
 move.w #FX2D,-(sp); push the appropriate opword
 _FP68K
 }
}

void  DoubleToExt( dbl, ext )
 double *dbl;
 extended *ext;
/******************************
* given the double number
* passed in, return its extended
* representation
*
******************************/
{

asm{
 move.l 8(A6),-(sp); address of the double
 move.l 12(A6),-(sp) ; address of the extended
 move.w #FD2X,-(sp); push the appropriate opword
 _FP68K
 }
}

void  LongToExt( lg, ext )
 long   *lg;
 extended *ext;
/******************************
* given the long  number
* passed in, return its extended
* representation
*
******************************/
{

asm{
 move.l 8(A6),-(sp); address of the long
 move.l 12(A6),-(sp) ; address of the extended
 move.w #FL2X,-(sp); push the appropriate opword
 _FP68K
 }
}

void  ExtToLong( ext, theint )
 extended *ext;
 long   *theint;
/******************************
* given the extended IEEE number
* passed in, return its long word
* representation
*
******************************/
{
asm{
 move.l 8(A6),-(sp); pointer to the extended
 move.l 12(A6),-(sp) ; address of the long
 move.w #FX2L,-(sp); push the appropriate opword
 _FP68K
 }
}

void  DoubleToLong( dbl, theint )
 double *dbl;
 long   *theint;
/******************************
* A simple conversion utility that might be useful
* for debugging at the TMON and MACSBUG level.
******************************/
{
 extended temp;
 
 DoubleToExt( dbl, &temp);
 ExtToLong( &temp, theint );
}

void  ExtendedToStr( ext, theStr )
 extended *ext;
 char   *theStr;
/*******************************
* convert an extended to a string
* 
* First convert the number to 
* a decimal record and then convert
* the decimal record to a string.
*
* The Hypercard callback “ExtToStr” does
* this for you.  I’ve added it here for those
* cases where you can’t make a callback
*
* The conversions uses the decimal record 
* structure that’s documented in Apple Numerics
* manual.
*******************************/
{
 decformdecrec;
 decimaldecnum;
 
 /*** convert the extended to a decimal ***/

 decrec.style = FIXEDDECIMAL;
 decrec.digits= 0;
 num2str( &decrec, *ext, theStr );
}

LISTING 1. Some Interesting SANE conversion utilities

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Bookends 12.7.8 - Reference management a...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Bookends uses the cloud to sync reference libraries on all the Macs you use.... Read more
VirtualBox 5.1.14 - x86 virtualization s...
VirtualBox is a family of powerful x86 virtualization products for enterprise as well as home use. Not only is VirtualBox an extremely feature rich, high performance product for enterprise customers... Read more
FileZilla 3.24.0 - Fast and reliable FTP...
FileZilla (ported from Windows) is a fast and reliable FTP client and server with lots of useful features and an intuitive interface. Version 3.24.0: New The context menu for remote file search... Read more
BusyContacts 1.1.6 - Fast, efficient con...
BusyContacts is a contact manager for OS X that makes creating, finding, and managing contacts faster and more efficient. It brings to contact management the same power, flexibility, and sharing... Read more
BusyCal 3.1.4 - Powerful calendar app wi...
BusyCal is an award-winning desktop calendar that combines personal productivity features for individuals with powerful calendar sharing capabilities for families and workgroups. Its unique features... Read more
Duplicate Annihilator 5.8.3 - Find and d...
Duplicate Annihilator takes on the time-consuming task of comparing the images in your iPhoto library using effective algorithms to make sure that no duplicate escapes. Duplicate Annihilator detects... Read more
MarsEdit 3.7.10 - Quick and convenient b...
MarsEdit is a blog editor for OS X that makes editing your blog like writing email, with spell-checking, drafts, multiple windows, and even AppleScript support. It works with with most blog services... Read more
WALTR 2 2.0.9 - $39.95
WALTR 2 helps you wirelessly drag-and-drop any music, ringtones, videos, PDF, and ePub files onto your iPhone, iPad, or iPod without iTunes. It is the second major version of Softorino's critically-... Read more
Paperless 2.3.9 - $49.95
Paperless is a digital documents manager. Remember when everyone talked about how we would soon be a paperless society? Now it seems like we use paper more than ever. Let's face it - we need and we... Read more
Adobe After Effects CC 2017 14.1 - Creat...
After Effects CC 2017 is available as part of Adobe Creative Cloud for as little as $19.99/month (or $9.99/month if you're a previous After Effects customer). The new, more connected After Effects CC... Read more

Super Mario Run dashes onto Android in M...
Super Mario Run was one of the biggest mobile launches in 2016 before it was met with a lukewarm response by many. While the game itself plays a treat, it's pretty hard to swallow the steep price for the full game. With that said, Android users... | Read more »
WarFriends Beginner's Guide: How to...
Chillingo's new game, WarFriends, is finally available world wide, and so far it's a refreshing change from common mobile game trends. The game's a mix of tower defense, third person shooter, and collectible card game. There's a lot to unpack here... | Read more »
Super Gridland (Entertainment)
Super Gridland 1.0 Device: iOS Universal Category: Entertainment Price: $1.99, Version: 1.0 (iTunes) Description: Match. Build. Survive. "exquisitely tuned" - Rock Paper Shotgun No in-app purches, and no ads! | Read more »
Red's Kingdom (Games)
Red's Kingdom 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Mad King Mac has kidnapped your father and stolen your golden nut! Solve puzzles and battle goons as you explore and battle your... | Read more »
Turbo League Guide: How to tame the cont...
| Read more »
Fire Emblem: Heroes coming to Google Pla...
Nintendo gave us our first look at Fire Emblem: Heroes, the upcoming mobile Fire Emblem game the company hinted at last year. Revealed at the Fire Emblem Direct event held today, the game will condense the series' tactical RPG combat into bite-... | Read more »
ReSlice (Music)
ReSlice 1.0 Device: iOS Universal Category: Music Price: $9.99, Version: 1.0 (iTunes) Description: Audio Slice Machine Slice your audio samples with ReSlice and create flexible musical atoms which can be triggered by MIDI notes or... | Read more »
Stickman Surfer rides in with the tide t...
Stickson is back and this time he's taken up yet another extreme sport - surfing. Stickman Surfer is out this Thursday on both iOS and Android, so if you've been following the other Stickman adventures, you might be interested in picking this one... | Read more »
Z-Exemplar (Games)
Z-Exemplar 1.4 Device: iOS Universal Category: Games Price: $3.99, Version: 1.4 (iTunes) Description: | Read more »
5 dastardly difficult roguelikes like th...
Edmund McMillen's popular roguelike creation The Binding of Isaac: Rebirth has finally crawled onto mobile devices. It's a grotesque dual-stick shooter that tosses you into an endless, procedurally generated basement as you, the pitiable Isaac,... | Read more »

Price Scanner via MacPrices.net

Twelve South Releases RelaxedLeather Cases fo...
Inspired by the laid-back luxury of burnished leather boots and crafted in rich tones of taupe, herb and marsala, RelaxedLeather cases deliver smart, easy protection for the iPhone 7. Each genuine... Read more
Week’s Best Deal: New 2016 13-inch 2.0GHz Mac...
Amazon has the new 2016 13″ 2.0GHz non-Touch Bar MacBook Pros on sale for a limited time for $225 off MSRP including free shipping: - 13″ 2.0GHz MacBook Pro, Space Gray (MLL42LL/A): $1274.99 $225 off... Read more
Back in stock: Apple refurbished Mac minis fr...
Apple has Certified Refurbished Mac minis available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz Mac mini: $419 $80 off MSRP - 2.6GHz Mac... Read more
Apple Ranked ‘Most Intimate Brand’
The top ranked ‘”intimate” brands continued to outperform the S&P and Fortune 500 indices in revenue and profit over the past 10 years, according to MBLM’s Brand Intimacy 2017 Report, the largest... Read more
B-Eng introduces SSD Health Check for Mac OS
Fehraltorf, Switzerland based independant Swiss company- B-Eng has announced the release and immediate availability of SSD Health Check 1.0, the company’s new hard drive utility for Mac OS X. As the... Read more
Apple’s Education discount saves up to $300 o...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free: -... Read more
4-core 3.7GHz Mac Pro on sale for $2290, save...
Guitar Center has the 3.7GHz 4-core Mac Pro (MD253LL/A) on sale for $2289.97 including free shipping or free local store pickup (if available). Their price is a $710 savings over standard MSRP for... Read more
128GB Apple iPad Air 2, refurbished, availabl...
Apple has Certified Refurbished 128GB iPad Air 2s WiFis available for $419 including free shipping. That’s an $80 savings over standard MSRP for this model. A standard Apple one-year warranty is... Read more
13-inch 2.7GHz Retina MacBook Pro on sale for...
B&H Photo has the 2015 13″ 2.7GHz/128GB Retina Apple MacBook Pro on sale for $100 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro (MF839LL/A): $... Read more
Laptop Market – Flight To Quality? – The ‘Boo...
Preliminary quarterly PC shipments data released by Gartner Inc. last week reveal an interesting disparity between sales performance of major name PC vendors as opposed to that of less well-known... Read more

Jobs Board

*Apple* & PC Desktop Support Technician...
Apple & PC Desktop Support Technician job in Manhattan, NY Introduction: We have immediate job openings for several Desktop Support Technicians with one of our most Read more
Senior Workstation Administrator - *Apple*...
…with extraordinary HR. QualificationsJOB SUMMARY/OVERVIEWThe Senior Workstation Administrator - Apple supports the mission of TriNet by providing advanced level Read more
Intermediate *Apple* macOS Systems Integrat...
**Position Summary:** SC3 is actively seeking an Intermediate Apple macOS systems integration administrator that will be responsible for providing Apple Mac Read more
*Apple* & PC Desktop Support Technician...
Apple & PC Desktop Support Technician job in Los Angeles, CA Introduction: We have immediate job openings for several Desktop Support Technicians with one of our Read more
*Apple* Retail - Multiple Positions - Apple,...
SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.