Source code for climada.util.value_representation

"""
This file is part of CLIMADA.

Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.

CLIMADA is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free
Software Foundation, version 3.

CLIMADA is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with CLIMADA. If not, see <https://www.gnu.org/licenses/>.

---

Created on Mon Nov 16 19:21:42 2020

@author: ckropf
"""

import logging
import math
import decimal
import numpy as np


LOGGER = logging.getLogger(__name__)

ABBREV = {
    1:'',
    1000: 'K',
    1000000: 'M',
    1000000000: 'Bn',
    1000000000000: 'Tn'
    }


[docs]def sig_dig(x, n_sig_dig = 16): """ Rounds x to n_sig_dig number of significant digits. 0, inf, Nan are returned unchanged. Examples -------- with n_sig_dig = 5: 1.234567 -> 1.2346, 123456.89 -> 123460.0 Parameters ---------- x : float number to be rounded n_sig_dig : int, optional Number of significant digits. The default is 16. Returns ------- float Rounded number """ num_of_digits = len(str(x).replace(".", "")) if n_sig_dig >= num_of_digits: return x n = math.floor(math.log10(abs(x)) + 1 - n_sig_dig) result = decimal.Decimal(str(np.round(x * 10**(-n)))) \ * decimal.Decimal(str(10**n)) return float(result)
[docs]def sig_dig_list(iterable, n_sig_dig=16): """ Vectorized form of sig_dig. Rounds a list of float to a number of significant digits Parameters ---------- iterable : iter(float) iterable of numbers to be rounded n_sig_dig : int, optional Number of significant digits. The default is 16. Returns ------- list list of rounded floats """ return np.vectorize(sig_dig)(iterable, n_sig_dig)
[docs]def convert_monetary_value(values, abbrev, n_sig_dig=None): if isinstance(values, (int, float)): values = [values] thsder = list(ABBREV.keys())[list(ABBREV.values()).index(abbrev)] mon_val = np.array(values) / thsder if n_sig_dig is not None: mon_val = [sig_dig(val, n_sig_dig=n_sig_dig) for val in mon_val] return mon_val
[docs]def value_to_monetary_unit(values, n_sig_dig=None, abbreviations=None): """Converts list of values to closest common monetary unit. 0, Nan and inf have not unit. Parameters ---------- values : int or float, list(int or float) or np.ndarray(int or float) Values to be converted n_sig_dig : int, optional Number of significant digits to return. Examples: n_sig_di=5: 1.234567 -> 1.2346, 123456.89 -> 123460.0 Default: all digits are returned. abbreviations: dict, optional Name of the abbreviations for the money 1000s counts Default: { 1:'', 1000: 'K', 1000000: 'M', 1000000000: 'Bn', 1000000000000: 'Tn' } Returns ------- mon_val : np.ndarray Array of values in monetary unit name : string Monetary unit Examples -------- values = [1e6, 2*1e6, 4.5*1e7, 0, Nan, inf] -> [1, 2, 4.5, 0, Nan, inf] ['M'] """ if isinstance(values, (int, float)): values = [values] if abbreviations is None: abbreviations= ABBREV exponents = [] for val in values: if math.isclose(val, 0) or not math.isfinite(val): continue exponents.append(math.log10(abs(val))) if not exponents: exponents = [0] max_exp = max(exponents) min_exp = min(exponents) avg_exp = math.floor((max_exp + min_exp) / 2) # rounded down mil_exp = 3 * math.floor(avg_exp/3) thsder = int(10**mil_exp) #Remove negative exponents thsder = 1 if thsder < 1 else thsder try: name = abbreviations[thsder] except KeyError: LOGGER.warning("Warning: The numbers are larger than %s", list(abbreviations.keys())[-1]) thsder, name = list(abbreviations.items())[-1] mon_val = np.array(values) / thsder if n_sig_dig is not None: mon_val = [sig_dig(val, n_sig_dig=n_sig_dig) for val in mon_val] return (mon_val, name)