| 1 | ''' |
|---|
| 2 | *GSASIIpy3: Python 3.x Routines* |
|---|
| 3 | ================================ |
|---|
| 4 | |
|---|
| 5 | Module to hold python 3-compatible code, to keep it separate from |
|---|
| 6 | code that will break with __future__ options. |
|---|
| 7 | |
|---|
| 8 | ''' |
|---|
| 9 | from __future__ import division |
|---|
| 10 | import numpy as np |
|---|
| 11 | import GSASIIpath |
|---|
| 12 | GSASIIpath.SetVersionNumber("$Revision: 1447 $") |
|---|
| 13 | # declare symbol (pi) and functions allowed in expressions |
|---|
| 14 | sind = sin = s = lambda x: np.sin(x*np.pi/180.) |
|---|
| 15 | cosd = cos = c = lambda x: np.cos(x*np.pi/180.) |
|---|
| 16 | tand = tan = t = lambda x: np.tan(x*np.pi/180.) |
|---|
| 17 | sqrt = sq = lambda x: np.sqrt(x) |
|---|
| 18 | pi = np.pi |
|---|
| 19 | |
|---|
| 20 | def FormulaEval(string): |
|---|
| 21 | '''Evaluates a algebraic formula into a float, if possible. Works |
|---|
| 22 | properly on fractions e.g. 2/3 only with python 3.0+ division. |
|---|
| 23 | |
|---|
| 24 | Expressions such as 2/3, 3*pi, sin(45)/2, 2*sqrt(2), 2**10 can all |
|---|
| 25 | be evaluated. |
|---|
| 26 | |
|---|
| 27 | :param str string: Character string containing a Python expression |
|---|
| 28 | to be evaluated. |
|---|
| 29 | |
|---|
| 30 | :returns: the value for the expression as a float or None if the expression does not |
|---|
| 31 | evaluate to a valid number. |
|---|
| 32 | |
|---|
| 33 | ''' |
|---|
| 34 | try: |
|---|
| 35 | val = float(eval(string)) |
|---|
| 36 | if np.isnan(val) or np.isinf(val): return None |
|---|
| 37 | except: |
|---|
| 38 | return None |
|---|
| 39 | return val |
|---|
| 40 | |
|---|
| 41 | def FormatPadValue(val,maxdigits=None): |
|---|
| 42 | '''Format a float to fit in ``maxdigits[0]`` spaces with maxdigits[1] after decimal. |
|---|
| 43 | |
|---|
| 44 | :param float val: number to be formatted. |
|---|
| 45 | |
|---|
| 46 | :param list maxdigits: the number of digits & places after decimal to be used for display of the |
|---|
| 47 | number (defaults to [10,2]). |
|---|
| 48 | |
|---|
| 49 | :returns: a string with exactly maxdigits[0] characters (except under error conditions), |
|---|
| 50 | but last character will always be a space |
|---|
| 51 | ''' |
|---|
| 52 | if maxdigits is None: |
|---|
| 53 | digits = [10,2] |
|---|
| 54 | else: |
|---|
| 55 | digits = list(maxdigits) |
|---|
| 56 | fmt = '{:'+str(digits[0])+'}' |
|---|
| 57 | s = fmt.format(FormatValue(val,digits)) |
|---|
| 58 | if s[-1] == ' ': |
|---|
| 59 | return s |
|---|
| 60 | else: |
|---|
| 61 | return s+' ' |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | def FormatValue(val,maxdigits=None): |
|---|
| 65 | '''Format a float to fit in at most ``maxdigits[0]`` spaces with maxdigits[1] after decimal. |
|---|
| 66 | Note that this code has been hacked from FormatSigFigs and may have unused sections. |
|---|
| 67 | |
|---|
| 68 | :param float val: number to be formatted. |
|---|
| 69 | |
|---|
| 70 | :param list maxdigits: the number of digits & places after decimal to be used for display of the |
|---|
| 71 | number (defaults to [10,2]). |
|---|
| 72 | |
|---|
| 73 | :returns: a string with <= maxdigits characters (usually). |
|---|
| 74 | ''' |
|---|
| 75 | if maxdigits is None: |
|---|
| 76 | digits = [10,2] |
|---|
| 77 | else: |
|---|
| 78 | digits = list(maxdigits) |
|---|
| 79 | fmt="{:."+str(digits[1])+"f}" |
|---|
| 80 | string = fmt.format(float(val)).strip() # will standard .f formatting work? |
|---|
| 81 | if len(string) <= digits[0]: |
|---|
| 82 | if ':' in string: # deal with weird bug where a colon pops up in a number when formatting (EPD 7.3.2!) |
|---|
| 83 | string = str(val) |
|---|
| 84 | if digits[1] > 0: # strip off extra zeros on right side |
|---|
| 85 | string = string.rstrip('0') |
|---|
| 86 | if string[-1] == '.': string += "0" |
|---|
| 87 | return string |
|---|
| 88 | if val < 0: digits[0] -= 1 # negative numbers, reserve space for the sign |
|---|
| 89 | decimals = digits[0] - digits[1] |
|---|
| 90 | if abs(val) > 1e99: # for very large numbers, use scientific notation and use all digits |
|---|
| 91 | fmt = "{" + (":{:d}.{:d}g".format(digits[0],digits[0]-6))+"}" |
|---|
| 92 | elif abs(val) > 1e9: |
|---|
| 93 | fmt = "{" + (":{:d}.{:d}g".format(digits[0],digits[0]-5))+"}" |
|---|
| 94 | elif abs(val) < 10**(4-decimals): # make sure at least 4 decimals show |
|---|
| 95 | # this clause is probably no longer needed since the number probably shows as 0.0 |
|---|
| 96 | decimals = min(digits[0]-5,digits[1]) |
|---|
| 97 | fmt = "{" + (":{:d}.{:d}g".format(digits[0],decimals))+"}" |
|---|
| 98 | elif abs(val) >= 10**(decimals-1): # deal with large numbers in smaller spaces |
|---|
| 99 | decimals = max(0,digits[0]-5) |
|---|
| 100 | fmt = "{" + (":{:d}.{:d}g".format(digits[0],decimals))+"}" |
|---|
| 101 | elif abs(val) < 1: # use f format for small numbers |
|---|
| 102 | # this clause is probably no longer needed since the number probably shows as 0.0 |
|---|
| 103 | decimals = min(digits[0]-3,digits[1]) |
|---|
| 104 | fmt = "{" + (":{:d}.{:d}f".format(digits[0],decimals))+"}" |
|---|
| 105 | else: # in range where g formatting should do what I want |
|---|
| 106 | # used? |
|---|
| 107 | decimals = digits[0] - 1 |
|---|
| 108 | fmt = "{" + (":{:d}.{:d}g".format(digits[0],decimals))+"}" |
|---|
| 109 | try: |
|---|
| 110 | return fmt.format(float(val)).strip() |
|---|
| 111 | except ValueError as err: |
|---|
| 112 | print 'FormatValue Error with val,maxdigits,fmt=',val,maxdigits,fmt |
|---|
| 113 | return str(val) |
|---|
| 114 | |
|---|
| 115 | def FormatSigFigs(val, maxdigits=10, sigfigs=5, treatAsZero=1e-20): |
|---|
| 116 | '''Format a float to use ``maxdigits`` or fewer digits with ``sigfigs`` |
|---|
| 117 | significant digits showing (if room allows). |
|---|
| 118 | |
|---|
| 119 | :param float val: number to be formatted. |
|---|
| 120 | |
|---|
| 121 | :param int maxdigits: the number of digits to be used for display of the |
|---|
| 122 | number (defaults to 10). |
|---|
| 123 | |
|---|
| 124 | :param int sigfigs: the number of significant figures to use, if room allows |
|---|
| 125 | |
|---|
| 126 | :param float treatAsZero: numbers that are less than this in magnitude |
|---|
| 127 | are treated as zero. Defaults to 1.0e-20, but this can be disabled |
|---|
| 128 | if set to None. |
|---|
| 129 | |
|---|
| 130 | :returns: a string with <= maxdigits characters (I hope). |
|---|
| 131 | ''' |
|---|
| 132 | if treatAsZero is not None: |
|---|
| 133 | if abs(val) < treatAsZero: |
|---|
| 134 | return '0.0' |
|---|
| 135 | # negative numbers, leave room for a sign |
|---|
| 136 | if val < 0: maxdigits -= 1 |
|---|
| 137 | if abs(val) < 1e-99 or abs(val) > 9.999e99: |
|---|
| 138 | decimals = min(maxdigits-6,sigfigs) |
|---|
| 139 | fmt = "{" + (":{:d}.{:d}g".format(maxdigits,decimals))+"}" # create format string |
|---|
| 140 | elif abs(val) < 1e-9 or abs(val) > 9.999e9: |
|---|
| 141 | decimals = min(maxdigits-5,sigfigs) |
|---|
| 142 | fmt = "{" + (":{:d}.{:d}g".format(maxdigits,decimals))+"}" |
|---|
| 143 | elif abs(val) < 9.9999999*10**(sigfigs-maxdigits): |
|---|
| 144 | decimals = min(maxdigits-5,sigfigs) |
|---|
| 145 | fmt = "{" + (":{:d}.{:d}g".format(maxdigits,decimals))+"}" |
|---|
| 146 | elif abs(val) >= 10**sigfigs: # deal with large numbers in smaller spaces |
|---|
| 147 | decimals = min(maxdigits-5,sigfigs) |
|---|
| 148 | fmt = "{" + (":{:d}.{:d}g".format(maxdigits,decimals))+"}" |
|---|
| 149 | elif abs(val) < 1: # small numbers, add to decimal places |
|---|
| 150 | decimals = sigfigs - int(np.log10(abs(val))) |
|---|
| 151 | fmt = "{" + (":{:d}.{:d}f".format(maxdigits,decimals))+"}" |
|---|
| 152 | else: # larger numbers, remove decimal places |
|---|
| 153 | decimals = sigfigs - 1 - int(np.log10(abs(val))) |
|---|
| 154 | if decimals <= 0: |
|---|
| 155 | fmt = "{" + (":{:d}.0f".format(maxdigits))+"}." |
|---|
| 156 | else: |
|---|
| 157 | fmt = "{" + (":{:d}.{:d}f".format(maxdigits,decimals))+"}" |
|---|
| 158 | try: |
|---|
| 159 | return fmt.format(float(val)).strip() |
|---|
| 160 | except ValueError as err: |
|---|
| 161 | print 'FormatValue Error with val,maxdigits, sigfigs, fmt=',val, maxdigits,sigfigs, fmt |
|---|
| 162 | return str(val) |
|---|
| 163 | |
|---|
| 164 | if __name__ == '__main__': |
|---|
| 165 | for i in (1.23456789e-129,1.23456789e129,1.23456789e-99,1.23456789e99,-1.23456789e-99,-1.23456789e99): |
|---|
| 166 | print FormatSigFigs(i),i |
|---|
| 167 | for i in (1,10,100,1000,10000,100000,1000000,10000000,100000000,1000000000): |
|---|
| 168 | print FormatSigFigs(1.23456789e-9*i),1.23456789e-9*i |
|---|
| 169 | for i in (1,10,100,1000,10000,100000,1000000,10000000,100000000): |
|---|
| 170 | print FormatSigFigs(1.23456789e9/i),1.23456789e9/i |
|---|
| 171 | |
|---|
| 172 | print FormatSigFigs(200,10,3) |
|---|
