Quantity

class sycomore.Quantity

Quantity in the SI system.

__abs__(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Return a quantity with the absolute value of the magnitude

__add__(*args, **kwargs)

Overloaded function.

1. __add__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

Addition of compatible quantities

2. __add__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

Addition of compatible quantities

__ceil__(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Quantity with the smallest integer magnitude not less than the magnitude

__divmod__(self: object, arg0: object) → object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> bool

Test whether magnitudes and dimensions are equal

2. __eq__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Test whether magnitudes and dimensions are equal

3. __eq__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Test whether magnitudes and dimensions are equal

__float__(self: sycomore._sycomore.Quantity) → float

Convert to a scalar

__floor__(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Quantity with the largest integer magnitude not greater than the magnitude

__floordiv__(*args, **kwargs)

Overloaded function.

1. __floordiv__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

2. __floordiv__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

__ge__(*args, **kwargs)

Overloaded function.

1. __ge__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> bool

Compare the magnitude of two compatible quantities

2. __ge__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Compare the magnitude of two compatible quantities

3. __ge__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Compare the magnitude of two compatible quantities

__gt__(*args, **kwargs)

Overloaded function.

1. __gt__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> bool

Compare the magnitude of two compatible quantities

2. __gt__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Compare the magnitude of two compatible quantities

3. __gt__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Compare the magnitude of two compatible quantities

__hash__(self: sycomore._sycomore.Quantity) → int

__iadd__(*args, **kwargs)

Overloaded function.

1. __iadd__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

In-place addition of a compatible quantity

2. __iadd__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

In-place addition of a compatible quantity

__imod__(*args, **kwargs)

Overloaded function.

1. __imod__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

In-place floating-point modulo

2. __imod__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

In-place floating-point modulo

__imul__(*args, **kwargs)

Overloaded function.

1. __imul__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

In-place multiplication

2. __imul__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

In-place multiplication

__init__(self: sycomore._sycomore.Quantity, arg0: float, arg1: sycomore._sycomore.Dimensions) → None

__int__(self: sycomore._sycomore.Quantity) → int

__isub__(*args, **kwargs)

Overloaded function.

1. __isub__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

In-place subtraction of a compatible quantity

2. __isub__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

In-place subtraction of a compatible quantity

__itruediv__(*args, **kwargs)

Overloaded function.

1. __itruediv__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

In-place division

2. __itruediv__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

In-place division

__le__(*args, **kwargs)

Overloaded function.

1. __le__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Compare the magnitude of two compatible quantities

2. __le__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> bool

Compare the magnitude of two compatible quantities

3. __le__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Compare the magnitude of two compatible quantities

__lt__(*args, **kwargs)

Overloaded function.

1. __lt__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Compare the magnitude of two compatible quantities

2. __lt__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> bool

Compare the magnitude of two compatible quantities

3. __lt__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Compare the magnitude of two compatible quantities

__mod__(*args, **kwargs)

Overloaded function.

1. __mod__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

Floating-point modulo

2. __mod__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

Floating-point modulo

__mul__(*args, **kwargs)

Overloaded function.

1. __mul__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

Multiplication

2. __mul__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

Multiplication

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> bool

Test whether magnitudes or dimensions differ

2. __ne__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Test whether magnitudes or dimensions differ

3. __ne__(self: sycomore._sycomore.Quantity, arg0: float) -> bool

Test whether magnitudes or dimensions differ

__neg__(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Return a quantity with the opposite magnitude

__pos__(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Identity operator

__pow__(self: sycomore._sycomore.Quantity, arg0: float) → sycomore._sycomore.Quantity

Raise a quantity to a power

__radd__(self: sycomore._sycomore.Quantity, arg0: float) → sycomore._sycomore.Quantity

Addition of compatible quantities

__repr__(self: sycomore._sycomore.Quantity) → str

String representation of a quantity

__rfloordiv__(self: sycomore._sycomore.Quantity, arg0: float) → sycomore._sycomore.Quantity

__rmul__(self: sycomore._sycomore.Quantity, arg0: float) → sycomore._sycomore.Quantity

Multiplication

__round__(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Round the magnitude of a quantity

__rsub__(self: sycomore._sycomore.Quantity, arg0: float) → sycomore._sycomore.Quantity

Subtraction of compatible quantities

__rtruediv__(self: sycomore._sycomore.Quantity, arg0: float) → sycomore._sycomore.Quantity

Division

__sub__(*args, **kwargs)

Overloaded function.

1. __sub__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

Subtraction of compatible quantities

2. __sub__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

Subtraction of compatible quantities

__truediv__(*args, **kwargs)

Overloaded function.

1. __truediv__(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

Division

2. __truediv__(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

Division

__trunc__(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Truncate the magnitude of a quantity

arccos(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

arccosh(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

arcsin(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

arcsinh(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

arctan(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

arctan2(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

arctanh(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

cbrt(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

ceil(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Quantity with the smallest integer magnitude not less than the magnitude

convert_to(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) → float

Return the scalar value of the quantity converted to the given unit.

cos(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

cosh(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

property dimensions

Dimensions of the quantity

exp(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

exp2(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

expm1(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

fabs(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Return a quantity with the absolute value of the magnitude

floor(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Quantity with the largest integer magnitude not greater than the magnitude

fmod(*args, **kwargs)

Overloaded function.

1. fmod(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) -> sycomore._sycomore.Quantity

Floating-point modulo

2. fmod(self: sycomore._sycomore.Quantity, arg0: float) -> sycomore._sycomore.Quantity

Floating-point modulo

hypot(self: sycomore._sycomore.Quantity, arg0: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

log(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

log10(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

log1p(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

log2(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

property magnitude

The magnitude of the quantity, in SI units.

rint(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Round the magnitude of a quantity

sin(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

sinh(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

sqrt(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

tan(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

tanh(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

trunc(self: sycomore._sycomore.Quantity) → sycomore._sycomore.Quantity

Truncate the magnitude of a quantity