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

Latest Forum Discussions

See All

Soft Drummer (Music)
Soft Drummer 1.0 Device: iOS Universal Category: Music Price: $14.99, Version: 1.0 (iTunes) Description: Soft Drummer is the closest thing to a pro session subtle drummer in your pocket. Easy to use and fast, it's much more than a... | Read more »
Is GO Gear the Pokemon GO map app you...
Now that we've settled into something of a Pokemon GO status quo, the number one desire of most players can best be summed out by modifying a quote from Rod Tidwell of Jerry Maguire: "Show me the Pokemon!" [Read more] | Read more »
Rodeo Stampede update: Mountains, new an...
The Savannah and Jungle were just the beginning in Rodeo Stampede. Get ready to head for the Mountains. I think I heard that in a beer ad once. [Read more] | Read more »
COSMOS RINGS (Games)
COSMOS RINGS 1.0.0 Device: iOS iPhone Category: Games Price: $5.99, Version: 1.0.0 (iTunes) Description: This game cannot be played without the Apple Watch.Released anniversary sale until August 31,2016 PST! A tragic tale of time's... | Read more »
How to get started selling on Mercari
As far as ecommerce has come over the last decade or so, there's still a tremendous opportunity to make it easier for people to buy and sell goods. That's especially true when it comes to shopping apps, which should only continue to increase in... | Read more »
Human Anatomy Atlas 2017 Edition - Compl...
Human Anatomy Atlas 2017 Edition - Complete 3D Human Body 1.0.24 Device: iOS iPhone Category: Medical Price: $24.99, Version: 1.0.24 (iTunes) Description: | Read more »
Heroes of Normandie (Games)
Heroes of Normandie 1.5 Device: iOS Universal Category: Games Price: $14.99, Version: 1.5 (iTunes) Description: The game does not support iPhone 4s and below | Read more »
Why you should never power up Pokemon in...
There's no question that candy is dandy in Pokemon GO. You need big quantities of it to evolve your Pokemon, and when combined with stardust, it can be used to power up your favorite pocket monsters as well, making them more formidable for the gym... | Read more »
Webzen launches 3D MMORPG MU Origin on i...
Mu Origin is featured time and time again at the very top of App Stores in China, and within the top five worldwide top-grossing charts on Google Play.Its popularity in Korea and China, featuring more than 120 registered players in China and 6... | Read more »
Severed (Games)
Severed 1.0 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0 (iTunes) Description: LAUNCH DISCOUNT ON NOW!! ENDS AUGUST 4! ==== Take control of a one-armed warrior named Sasha, wielding a living sword on her journey... | Read more »

Price Scanner via MacPrices.net

9-inch 32GB Space Gray iPad Pro on sale for $...
B&H Photo has the 9″ 32GB WiFi Space Gray Apple iPad Pro on sale for $50 off MSRP including free shipping. B&H charges sales tax in NY only: - 9″ Space Gray 32GB WiFi iPad Pro: $549 $50 off... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has 15″ Retina MacBook Pros on sale for up to $200 off MSRP. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina MacBook Pro: $1849 $150 off MSRP - 15″ 2.5GHz Retina... Read more
Second-Quarter Tablet Shipments Fell 4.8% –...
The latest report from the global market research firm TrendForce finds that worldwide tablet shipments for this second quarter totaled 33.54 million units, representing a quarterly drop of 4.8% and... Read more
Global Smartphone Sales Volumes Mark Second S...
According to preliminary results from the International Data Corporation (IDC) Worldwide Quarterly Mobile Phone Tracker, vendors shipped a total of 343.3 million smartphones worldwide in the second... Read more
Apple TVs on sale for $20-$40 off MSRP
Best Buy has 32GB and 64GB Apple TVs on sale for $20-$40 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Sale prices for online orders only, in-store... Read more
Mac minis on sale for $50-$100 off MSRP
B&H Photo has Mac minis on sale for $50 off MSRP including free shipping plus NY sales tax only: - 1.4GHz Mac mini: $449 $50 off MSRP - 2.6GHz Mac mini: $649 $50 off MSRP - 2.8GHz Mac mini: $949... Read more
Clearance 2015 13-inch MacBook Airs available...
B&H Photo has clearance 2015 13″ MacBook Airs available for $300 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/4GB/128GB MacBook Air (MJVE2LL/A): $799... Read more
Apple certified refurbished iPad mini 4s avai...
Apple has certified refurbished iPad mini 4s now available for up to $120 off the cost of new models. An Apple one-year warranty is included with each iPad, and shipping is free. The following models... Read more
Notebook Makers In No Rush To Adopt USB-C – R...
Digitimes’ Cage Chao and Joseph Tsai note that while the USB Type-C interface is enjoying growing popularity among smartphones and tablet makers, notebook and all-in-one (AIO) PC vendors (other than... Read more
iMacs on sale for up to $250 off MSRP
B&H Photo has 21″ and 27″ Apple iMacs on sale for up to $250 off MSRP including free shipping plus NY sales tax only: - 27″ 3.3GHz iMac 5K: $2049 $250 off MSRP - 27″ 3.2GHz/1TB Fusion iMac 5K: $... Read more

Jobs Board

*Apple* Retail - Bilingual - Multiple Positi...
…speaking a plus Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the Read more
Simply Mac *Apple* Specialist- Repair Techn...
…The Technician is a master at working with our customers to diagnose and repair Apple devices in a manner that exceeds the expectations set forth by Apple Read more
*Apple* Mobile Master - Best Buy (United Sta...
What does a Best Buy Apple Mobile Master do? At Best Buy, our mission is to leverage the unique talents and passions of our employees to inspire, delight, and enrich Read more
Best Buy *Apple* Computing Master - Best Bu...
What does a Best Buy Apple Computing Master do? At Best Buy our mission is to leverage the unique talents and passions of our employees to inspire, delight, and Read more
*Apple* Valley, CA School Speech Therapy Ope...
Apple Valley, CA School Speech Therapy Openings + Job Location: Apple Valley, CA + Category: Schools - SLP - CFY + Apply Now! + Back to Results Speech Language Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.