hikari.utility.interval

Classes

Interval

A class handling [A, B] line segments and numpy operations on them.

Module Contents

class hikari.utility.interval.Interval(left, right)

A class handling [A, B] line segments and numpy operations on them. The following magic methods have been implemented for Interval:

• creation using Interval(A, B) syntax (if A == B, represents a point)

• comparison operations with numbers (True if holds for the whole Interval)

• arithmetic operations, which act element-wise for left and right edge

• access methods: A == Interval(A, B)[0] == Interval(A, B).left

• container methods: 5 and 6.2 are in Interval(5, 7), but 7. might not be

left

right

__eq__(other)

__lt__(other)

__gt__(other)

__le__(other)

__ge__(other)

__pos__()

__neg__()

__add__(other)

__sub__(other)

__mul__(other)

__truediv__(other)

__str__()

__repr__()

__iter__()

__getitem__(key)

__setitem__(key, value)

__contains__(item)

__len__()

static _min(item)

Recursively returns minimum of args if possible, otherwise args

static _max(item)

Recursively returns maximum of args if possible, otherwise args

arange(step=1)

Return a 1D-list of values from left to right every step :param step: spacing between adjacent values, default 1. :type step: int or float :return: array of values from left to right (including right) every step :rtype: np.array

comb_with(*others, step=1)

Return combinations of self.arange(step) with every other.arange(step) :param others: interval or iterable of intervals to comb self with :type others: Interval or tuple or list :param step: spacing between adjacent values, default 1. :type step: int or float :return: array of all combinations found in numpy.meshgrid every step :rtype: np.array

mesh_with(*others, step=1)

Return a numpy.mesh of self.arange(step) with every other.arange(step) :param others: interval or iterable of intervals to mesh self with :type others: Interval or tuple or list :param step: spacing between adjacent values, default 1. :type step: int or float :return: array of values meshed by numpy.meshgrid every step :rtype: np.array