interval¶

class samson.DataModel.Type.interval(*args, **kwargs)¶

Bases: pybind11_builtins.pybind11_object

This class represents physical intervals.

SAMSON API: SBDTypePhysicalInterval

Overloaded function.

__init__(self: samson.DataModel.Type.interval) -> None

The default constructor initializes all components to zero

__init__(self: samson.DataModel.Type.interval, x: samson.DataModel.Quantity.unitsSI) -> None

Constructs a physical interval [x, x]

__init__(self: samson.DataModel.Type.interval, x: samson.DataModel.Quantity.unitsSI, y: samson.DataModel.Quantity.unitsSI) -> None

Constructs the physical vector [x, y]

__init__(self: samson.DataModel.Type.interval, uvec2: List[samson.DataModel.Quantity.unitsSI]) -> None

Constructs a physical interval [uvec2[0] uvec2[1]]

__add__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) → samson.DataModel.Type.interval¶

__eq__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) → bool¶

__iadd__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) → samson.DataModel.Type.interval¶

__imul__(*args, **kwargs)¶

Overloaded function.

__imul__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) -> samson.DataModel.Type.interval
__imul__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.interval
__imul__(self: samson.DataModel.Type.interval, arg0: float) -> samson.DataModel.Type.interval

__isub__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) → samson.DataModel.Type.interval¶

__itruediv__(*args, **kwargs)¶

Overloaded function.

__itruediv__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) -> samson.DataModel.Type.interval
__itruediv__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.interval
__itruediv__(self: samson.DataModel.Type.interval, arg0: float) -> samson.DataModel.Type.interval

__mul__(*args, **kwargs)¶

Overloaded function.

__mul__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) -> samson.DataModel.Type.interval
__mul__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.interval
__mul__(self: samson.DataModel.Type.interval, arg0: float) -> samson.DataModel.Type.interval

__ne__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) → bool¶

__neg__(self: samson.DataModel.Type.interval) → samson.DataModel.Type.interval¶

__rmul__(*args, **kwargs)¶

Overloaded function.

__rmul__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.interval
__rmul__(self: samson.DataModel.Type.interval, arg0: float) -> samson.DataModel.Type.interval

__sub__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Type.interval) → samson.DataModel.Type.interval¶

__truediv__(*args, **kwargs)¶

Overloaded function.

__truediv__(self: samson.DataModel.Type.interval, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.interval
__truediv__(self: samson.DataModel.Type.interval, arg0: float) -> samson.DataModel.Type.interval

bound(*args, **kwargs)¶

Overloaded function.

bound(self: samson.DataModel.Type.interval, v: samson.DataModel.Quantity.unitsSI) -> None

Enlarges this physical interval to contain v

bound(self: samson.DataModel.Type.interval, j: samson.DataModel.Type.interval) -> None

Enlarges this physical interval to contain the physical interval j

center(self: samson.DataModel.Type.interval) → samson.DataModel.Quantity.unitsSI¶: Returns the center 0.5*(i[0]+i[1]) of the physical interval

contains(self: samson.DataModel.Type.interval, v: samson.DataModel.Quantity.unitsSI) → bool¶: Returns true when this physical interval contains v

diameter(self: samson.DataModel.Type.interval) → samson.DataModel.Quantity.unitsSI¶: Returns the diameter i[1]-i[0] of the physical interval

expand(self: samson.DataModel.Type.interval, r: samson.DataModel.Quantity.unitsSI) → None¶: Expands this physical interval by offset r.

This function expands this physical interval by offset r: [a, b] becomes [a-r, b+r].

getAbsLower(self: samson.DataModel.Type.interval) → samson.DataModel.Quantity.unitsSI¶: Returns the lower bound of the absolute value of this physical interval

getAbsUpper(self: samson.DataModel.Type.interval) → samson.DataModel.Quantity.unitsSI¶: Returns the upper bound of the absolute value of this physical interval

isEmpty(self: samson.DataModel.Type.interval, l: samson.DataModel.Quantity.unitsSI, r: samson.DataModel.Quantity.unitsSI) → bool¶: Determines whether the intersection between this physical interval and the physical interval [l, r] is empty

setZero(self: samson.DataModel.Type.interval) → None¶: Sets the physical interval to [0,0]

shrink(self: samson.DataModel.Type.interval, r: samson.DataModel.Quantity.unitsSI) → None¶: Shrinks this physical interval by offset r.

This function shrinks this physical interval by offset r: [a, b] becomes [a+r, b-r]. When the offset r is larger than the half-size of the physical interval, the interval becomes [m, m], where m is the center of the interval.

str(self: samson.DataModel.Type.interval, fullName: bool = False) → str¶: Converts the physical interval to a string (with a full unit name when fullName is true)

property value¶