Interval

class baybe.utils.interval.Interval

Bases: SerialMixin

Intervals on the real number line.

Public methods

__init__([lower, upper])	Method generated by attrs for class Interval.
clamp([min, max])	Clamp the interval to a specified range.
contains(number)	Check whether the interval contains a given number.
create(value)	Create an interval from various input types.
from_dict(dictionary)	Create an object from its dictionary representation.
from_json(source, /)	Create an object from its JSON representation.
to_dict()	Create an object's dictionary representation.
to_json([sink, overwrite])	Create an object's JSON representation.
to_ndarray()	Transform the interval to a numpy.ndarray.
to_tensor()	Transform the interval to a torch.Tensor.
to_tuple()	Transform the interval to a tuple.

Public attributes and properties

lower	The lower end of the interval.
upper	The upper end of the interval.
center	The center of the interval, or nan if the interval is unbounded.
is_bounded	Check if the interval is bounded.
is_degenerate	Check if the interval is degenerate (i.e., contains only a single number).
is_fully_unbounded	Check if the interval represents the entire real number line.
is_half_bounded	Check if the interval is half-bounded.
is_left_bounded	Check if the interval is left-bounded.
is_right_bounded	Check if the interval is right-bounded.

__init__(lower=-inf, upper=inf)

Method generated by attrs for class Interval.

For details on the parameters, see Public attributes and properties.

clamp(min: float = -inf, max: float = inf)

Clamp the interval to a specified range.

Return type:

Interval

contains(number: float)

Check whether the interval contains a given number.

Parameters:

number (float) – The number that should be checked.

Return type:

bool

Returns:

Whether the interval contains the number.

classmethod create(value: Interval | Iterable[float] | None)

Create an interval from various input types.

Return type:

Interval

classmethod from_dict(dictionary: dict)

Create an object from its dictionary representation.

Parameters:

dictionary (dict) – The dictionary representation.

Return type:

TypeVar(_T, bound= SerialMixin)

Returns:

The reconstructed object.

classmethod from_json(source: str | Path | SupportsRead[str], /)

Create an object from its JSON representation.

Parameters:

source (str | Path | SupportsRead[str]) –

The JSON source. Can be:

• A string containing JSON content.

• A file path or Path object pointing to a JSON file.

• A file-like object with a read() method.

Raises:

ValueError – If source is not one of the allowed types.

Return type:

_T

Returns:

The reconstructed object.

to_dict()

Create an object’s dictionary representation.

Return type:

dict

Returns:

The dictionary representation of the object.

to_json(sink: str | Path | SupportsWrite[str] | None = None, /, *, overwrite: bool = False, **kwargs: Any)

Create an object’s JSON representation.

Parameters:

• sink (str | Path | SupportsWrite[str] | None) –

  The JSON sink. Can be:

  • None (only returns the JSON string).

  • A file path or Path object pointing to a location where to write the JSON content.

  • A file-like object with a write() method.

• overwrite (bool) – Boolean flag indicating if to overwrite the file if it already exists. Only relevant if sink is a file path or Path object.

• **kwargs (Any) – Additional keyword arguments to pass to json.dumps().

Raises:

FileExistsError – If sink points to an already existing file but overwrite is False.

Return type:

str

Returns:

The JSON representation as a string.

to_ndarray()

Transform the interval to a numpy.ndarray.

Return type:

ndarray

to_tensor()

Transform the interval to a torch.Tensor.

Return type:

Tensor

to_tuple()

Transform the interval to a tuple.

Return type:

tuple[float, float]

property center: float

The center of the interval, or nan if the interval is unbounded.

property is_bounded: bool

Check if the interval is bounded.

property is_degenerate: bool

Check if the interval is degenerate (i.e., contains only a single number).

property is_fully_unbounded: bool

Check if the interval represents the entire real number line.

property is_half_bounded: bool

Check if the interval is half-bounded.

property is_left_bounded: bool

Check if the interval is left-bounded.

property is_right_bounded: bool

Check if the interval is right-bounded.

lower: float

The lower end of the interval.

upper: float

The upper end of the interval.