"""
open/dulcinea/lib/tolerance.py
"""
from dulcinea.base import Copyable
from qp.lib.spec import either, require, add_getters, Specified, number_classes

class Tolerance (Specified, Copyable):
    """
    A tolerance value can be associated with another value
    in order to specify the relative tolerance (in percent) of
    that value.
    """
    lo_is = either(*number_classes)
    hi_is = either(*number_classes)

    def __init__(self, hi=0.0, lo=None):
        assert hi >= 0
        require(hi, float)
        if lo is None:
            lo = hi
        else:
            assert lo >= 0
            require(lo, float)
        self.hi = hi
        if abs(hi - lo) < 1e-9:
            lo = hi
        self.lo = lo

    def __str__(self):
        return self.format()

    def format(self, html=0):
        if html:
            plusminus = '&plusmn;' # a one character version of +/-
        else:
            plusminus = '+/-'
        if self.hi == self.lo:
            return '%s%g%%' % (plusminus, self.hi)
        else:
            return '+%g%%/-%g%%' % (self.hi, self.lo)

    def __hash__(self):
        return hash((self.lo, self.hi))

    def is_symmetric(self):
        """Return true if the high and low magnitudes are the same."""
        return self.hi == self.lo

add_getters(Tolerance)