"""
A class containing the "interface" for creation of intervals*, (not 'sets').
Like for the IntervalSetGenericUtils, the actual class to instantiate
is set per-instance, so this serves as a generic class template.
"""
from clothesline.interval_peg import IntervalPeg
from clothesline.algebra.symbols import PlusInf, MinusInf
from clothesline.exceptions import (
UnparseableDictError,
UnserializableItemError,
UnsupportedVersionDictError,
)
[docs]class IntervalGenericUtils:
"""
An "interval utils" class. Instances of this, properly initialized
with the name of the interval class to create, are able to produce several
'standard' intervals such as "all", "open set" and so on.
"""
def __init__(self, interval_class):
"""
When creating an utils instance, which can create intervals*,
the interval_class that must be passed is a function (a constructor)
that makes its two arguments (peg0, peg1) into an interval of the
desired type.
"""
self.interval_class = interval_class
self.value_decoder = self.interval_class.value_decoder
self.serializing_class = self.interval_class.serializing_class
self.serializing_version = self.interval_class.serializing_version
[docs] def from_dict(self, input_dict):
"""
Using the information in the interval class, convert a dict
(supposedly generate from an interval of this same type)
back into an interval.
This function takes care of injecting decoders to the lower-level
(i.e. peg-level) from_dict function invocations.
"""
if not self.value_decoder:
raise UnserializableItemError
if input_dict.get("class") != self.serializing_class:
raise UnparseableDictError
# Here, in the future, version upgrade logic will be injected
if input_dict.get("version", 0) > self.serializing_version:
raise UnsupportedVersionDictError
if input_dict.get("version") != self.serializing_version:
raise UnparseableDictError
return self.interval_class(
IntervalPeg.from_dict(
input_dict["pegs"][0],
v_decoder=self.value_decoder,
),
IntervalPeg.from_dict(
input_dict["pegs"][1],
v_decoder=self.value_decoder,
),
)
[docs] def open(self, value_begin, value_end):
"""
Create an open interval with finite boundaries.
"""
return self.interval(
value_begin,
False,
value_end,
False,
)
[docs] def closed(self, value_begin, value_end):
"""
Create a closed interval with finite boundaries.
"""
return self.interval(
value_begin,
True,
value_end,
True,
)
[docs] def point(self, value):
"""
Create a zero-length degenerate [x, x] point-line 'interval'.
"""
return self.closed(value, value)
[docs] def low_slice(self, value_end, included=False):
"""
Create an interval from -inf to a certain value.
"""
return self.interval(
MinusInf,
False,
value_end,
included,
)
[docs] def high_slice(self, value_begin, included=False):
"""
Create an interval from a value up to +inf.
"""
return self.interval(
value_begin,
included,
PlusInf,
False,
)
[docs] def all(self):
"""
Return the "whole of it" interval.
"""
return self.interval(
MinusInf,
False,
PlusInf,
False,
)
[docs] def interval(self, value_begin, begin_included, value_end, end_included):
"""
Directly create an interval from the values and the open/closed specs.
"""
return self.interval_class(
IntervalPeg(value_begin, begin_included),
IntervalPeg(value_end, end_included),
)