File Exchange

image thumbnail

Number to Scientific Prefix

version 3.0 (9.98 KB) by

Convert a numeric value to an metric prefixed string (SI/engineering). Bonus: binary prefixes!

17 Downloads

Updated

View License

The function NUM2SIP converts a numeric scalar into a string with a metric prefix (aka SI prefix, or engineering prefix). For example the value 1000 is converted to '1 k'. The bonus function NUM2BIP converts from numeric to binary-prefixed string, for example the value 1024 is converted to '1 Ki'.

After testing the metric-prefix submissions on MATLAB FEX (see Acknowledgements) and not finding a single one that converted all values correctly and that supported the correct SI spacing, I wrote my own functions. And then exhaustively tested them to confirm that they actually give the correct output.

These functions are particularly useful to help create publications following SI standards, or where control over significant digits and trailing zeros is required, or for including numeric values in figures.

This submission:
* Always includes the space character (required by the SI standard).
* Automatically selects the most suitable prefix.
* Rounds to the requested significant figures (default==5).
* Prefix may be selected as either the full name ('kilo') or the symbol ('k').
* Trailing decimal zeros of the coefficient may be included or removed.
* Rounds up to the next prefix when significant figures require, e.g. '1 M', not '1000 k'.
* Uses simple integer even if precision is less than three (no exponent).

### Reverse Conversion ###

To convert from metric-prefixed string to numeric:

<http://www.mathworks.com/matlabcentral/fileexchange/53886-scientific-prefix-to-number>

### Metric Prefix Examples ###

num2sip(10000) OR num2sip(1e4)
 ans = '10 k'
num2sip(10000,4,true)
 ans = '10 kilo'
num2sip(10000,4,false,true)
 ans = '10.00 k'

num2sip(999,2)
 ans = '1 k'
num2sip(999,3)
 ans = '999 '

num2sip(-5.555e9,3)
 ans = '-5.56 G'

num2sip(10^2,[],'k')
 ans = '0.1 k'

['Power: ',num2sip(200*1000^2,[],true),'watt']
 ans = 'Power: 200 megawatt'

sprintf('Clock frequency is %shertz.',num2sip(1234567890,8,true))
 ans = 'Clock frequency is 1.2345679 gigahertz.'
 
### Binary Prefix Examples ###

num2bip(10240) OR num2bip(1.024e4) OR num2bip(pow2(10,10)) OR num2bip(10*2^10)
 ans = '10 Ki'
num2bip(10240,4,true)
 ans = '10 kibi'
num2bip(10240,4,false,true)
 ans = '10.00 Ki'

num2bip(1023,3)
 ans = '1020 '
num2bip(1023,2)
 ans = '1 Ki'

num2bip(-5.555e9,3)
 ans = '-5.17 Gi'

num2bip(2^19,[],'Mi')
 ans = '0.5 Mi'

['Memory: ',num2bip(200*1024^2,[],true),'byte']
 ans = 'Memory: 200 mebibyte'

sprintf('Data saved in %sbytes.',num2bip(1234567890,8,true))
 ans = 'Data saved in 1.1497809 gibibytes.'

num2bip(bip2num('9 Ti'))
 ans = '9 Ti'

### Metric Prefixes ###

Magnitude | Symbol / Name
     1000^-8 | y / yocto
     1000^-7 | z / zepto
     1000^-6 | a / atto
     1000^-5 | f / femto
     1000^-4 | p / pico
     1000^-3 | n / nano
     1000^-2 | u / micro
     1000^-1 | m / milli
     1000^0 |
     1000^1 | k / kilo
     1000^2 | M / mega
     1000^3 | G / giga
     1000^4 | T / tera
     1000^5 | P / peta
     1000^6 | E / exa
     1000^7 | Z / zetta
     1000^8 | Y / yotta

### Binary Prefixes (IEC 60027-2 A.2 and ISO/IEC 80000-13:2008) ###

Magnitude | Symbol / Name
     1024^0 |
     1024^1 | Ki / kibi
     1024^2 | Mi / mebi
     1024^3 | Gi / gibi
     1024^4 | Ti / tebi
     1024^5 | Pi / pebi
     1024^6 | Ei / exbi
     1024^7 | Zi / zebi
     1024^8 | Yi / yobi

### Notes ###

These functions have been extensively tested against many edge cases, with particular attention to ensuring the correct rounding for all choices of significant figures. Compared to similar submissions available on MATLAB File Exchange, these functions correctly:
* include the space character between the coefficient and the prefix, even if there is no prefix (try 1).
* round to the requested significant figures (try 0.999 or 999e3, with 1 or 2 significant figures).
* return a coefficient without a prefix for zero and values outside the prefix range (try 0, Inf, 1E30).
* return a coefficient without an exponent when the significant digits are less than three (try 1e5 to 1 sigfig).

Comments and Ratings (4)

Chang hsiung

Stephen Cobeldick

@Collin Pecora. Thank you for your feedback. The function returns 'u' because I wanted to stick to ASCII characters only, as different file formats and character encoding are not always compatible. You can easily edit the file or use |strrep| to get the result that you want.

Collin Pecora

Very helpfull.
Could chage micro 'u' to char(181) in your prefix cell array

Collin Pecora

Updates

3.0

* Add "fixed" prefix input option.
* Rewrite algorithm to use local functions.

2.1

* Add HTML documentation.
* Empty inputs use default values.

2.0

* Split subimssion into two: one for num->str, other for str->num.
* Rename all functions.

1.13

- Improve handling of trailing zeros.
- Improve input checking.

1.12

- Default is now lower-case E-notation.

1.11

- Add control over allowing trailing zeros in string.
- Convert all string coefficients into numeric (not just the first one).
- Return split string parts as a cell array.

1.10

- Edit the help section a little.

1.9

- Str->Num: space character between coefficient and prefix is optional.
- Str->Num: NaN and Inf may occur with prefixes.
- Help: Simplify prefix tables.

1.8

Upload all four functions for converting between numeric and string, for both SI and binary.

1.6

- Fix edge case (val=1).

1.5

- Allow positive/negative input value.
- Consistent handling of Inf/NaN values.

1.3

Provide useage examples.

1.1

Edit file description to be more accurate.

MATLAB Release
MATLAB 7.11 (R2010b)

Download apps, toolboxes, and other File Exchange content using Add-On Explorer in MATLAB.

» Watch video