unitelabs.labware.math.vector

Attributes

Name
Number
Type
Value
= typing.Union[str, int, float, tuple[int, collections.abc.Sequence[int], int], decimal.Decimal]
Description

Classes

Vector
Represents coordinates in a Cartesian coordinate system. In the context of robotics, imagine to face the machine's front: the system's origin is the bottom left corner next to you. ``` z ↑ y | ↗ └ - → x ```
Decorators
dataclasses.dataclass
Methods
- __init__(self, x : Decimal, y : Decimal, z : Decimal) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    x
    Type
    Decimal
    Default
    Description
    The x coordinate.
  - Name
    y
    Type
    Decimal
    Default
    Description
    The y coordinate.
  - Name
    z
    Type
    Decimal
    Default
    Description
    The z coordinate.
- copy(self) -> Vector
  Returns a new Vector that is a copy of the current Vector.
  Response
  Type
  Vector
  Description
  A new Vector with the same x, y, and z values as the original Vector.
- update(self, x : typing.Optional[Number], y : typing.Optional[Number], z : typing.Optional[Number]) -> Vector
  Returns a new Vector with the provided coordinate updates.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    x
    Type
    typing.Optional[Number]
    Default
    = None
    Description
  - Name
    y
    Type
    typing.Optional[Number]
    Default
    = None
    Description
  - Name
    z
    Type
    typing.Optional[Number]
    Default
    = None
    Description
  Response
  Type
  Vector
  Description
  A new Vector with the updated or same x, y, and z values as the
- __add__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __radd__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __iadd__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __sub__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __rsub__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __isub__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __mul__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __rmul__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __imul__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __truediv__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __rtruediv__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __itruediv__(self, other : typing.Union[Number, Vector]) -> Vector
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Number, Vector]
    Default
    Description
  Response
  Type
  Vector
  Description
- __bool__(self) -> bool
  Response
  Type
  bool
  Description
Attributes
- Name
  x
  Type
  Decimal
  Value
  = dataclasses.field(metadata={'marshmallow_field': DecimalField()}, default=Decimal(default=0))
  Description
- Name
  y
  Type
  Decimal
  Value
  = dataclasses.field(metadata={'marshmallow_field': DecimalField()}, default=Decimal(default=0))
  Description
- Name
  z
  Type
  Decimal
  Value
  = dataclasses.field(metadata={'marshmallow_field': DecimalField()}, default=Decimal(default=0))
  Description

unitelabs.labware.math.vector

Attributes

Classes

Vector

Methods

__init__(self, x : Decimal, y : Decimal, z : Decimal) -> None

Parameters

copy(self) -> Vector

Response

update(self, x : typing.Optional[Number], y : typing.Optional[Number], z : typing.Optional[Number]) -> Vector

Parameters

Response

__add__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__radd__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__iadd__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__sub__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__rsub__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__isub__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__mul__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__rmul__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__imul__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__truediv__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__rtruediv__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__itruediv__(self, other : typing.Union[Number, Vector]) -> Vector

Parameters

Response

__bool__(self) -> bool

Response

Attributes

init(self, x : Decimal, y : Decimal, z : Decimal) -> None

add(self, other : typing.Union[Number, Vector]) -> Vector

radd(self, other : typing.Union[Number, Vector]) -> Vector

iadd(self, other : typing.Union[Number, Vector]) -> Vector

sub(self, other : typing.Union[Number, Vector]) -> Vector

rsub(self, other : typing.Union[Number, Vector]) -> Vector

isub(self, other : typing.Union[Number, Vector]) -> Vector

mul(self, other : typing.Union[Number, Vector]) -> Vector

rmul(self, other : typing.Union[Number, Vector]) -> Vector

imul(self, other : typing.Union[Number, Vector]) -> Vector

truediv(self, other : typing.Union[Number, Vector]) -> Vector

rtruediv(self, other : typing.Union[Number, Vector]) -> Vector

itruediv(self, other : typing.Union[Number, Vector]) -> Vector

bool(self) -> bool