SUAVE.Plugins.pint.quantity._Quantity Class Reference

Inheritance diagram for SUAVE.Plugins.pint.quantity._Quantity:

Public Member Functions
def	__reduce__ (self)
def	__new__ (cls, value, units=None)
def	__copy__ (self)
def	__str__ (self)
def	__repr__ (self)
def	__format__ (self, spec)
def	magnitude (self)
def	units (self)
def	unitless (self)
def	dimensionless (self)
def	dimensionality (self)
def	ito (self, other=None, *contexts, **ctx_kwargs)
def	to (self, other=None, *contexts, **ctx_kwargs)
def	ito_base_units (self)
def	to_base_units (self)
def	__float__ (self)
def	__complex__ (self)
def	iadd_sub (self, other, op)
def	add_sub (self, other, op)
def	__iadd__ (self, other)
def	__add__ (self, other)
def	__isub__ (self, other)
def	__sub__ (self, other)
def	__rsub__ (self, other)
def	__imul__ (self, other)
def	__mul__ (self, other)
def	__itruediv__ (self, other)
def	__truediv__ (self, other)
def	__rtruediv__ (self, other)
def	__ifloordiv__ (self, other)
def	__floordiv__ (self, other)
def	__rfloordiv__ (self, other)
def	__ipow__ (self, other)
def	__pow__ (self, other)
def	__abs__ (self)
def	__round__ (self, ndigits=0)
def	__pos__ (self)
def	__neg__ (self)
def	__eq__ (self, other)
def	__ne__ (self, other)
def	compare (self, other, op)
def	__bool__ (self)
def	clip (self, first=None, second=None, out=None, **kwargs)
def	fill (self, value)
def	put (self, indices, values, mode='raise')
def	searchsorted (self, v, side='left')
def	__len__ (self)
def	__iter__ (self)
def	__getattr__ (self, item)
def	__getitem__ (self, key)
def	__setitem__ (self, key, value)
def	tolist (self)
def	__array_prepare__ (self, obj, context=None)
def	__array_wrap__ (self, obj, context=None)
def	plus_minus (self, error, relative=False)

Public Attributes
	dimensionality
	units

Static Public Attributes
string	default_format = ''

Detailed Description

Implements a class to describe a physical quantities:
the product of a numerical value and a unit of measurement.

:param value: value of the physical quantity to be created.
:type value: str, Quantity or any numeric type.
:param units: units of the physical quantity to be created.
:type units: UnitsContainer, str or Quantity.

Member Function Documentation

dimensionality()

def SUAVE.Plugins.pint.quantity._Quantity.dimensionality

(

self

)

Quantity's dimensionality (e.g. {length: 1, time: -1})

dimensionless()

def SUAVE.Plugins.pint.quantity._Quantity.dimensionless

(

self

)

Return true if the quantity is dimensionless.

ito()

def SUAVE.Plugins.pint.quantity._Quantity.ito	(		self,
			other = None,
		*	contexts,
		**	ctx_kwargs
	)

Inplace rescale to different units.

:param other: destination units.
:type other: Quantity, str or dict

ito_base_units()

def SUAVE.Plugins.pint.quantity._Quantity.ito_base_units

(

self

)

Return Quantity rescaled to base units

magnitude()

def SUAVE.Plugins.pint.quantity._Quantity.magnitude

(

self

)

Quantity's magnitude.

to()

def SUAVE.Plugins.pint.quantity._Quantity.to	(		self,
			other = None,
		*	contexts,
		**	ctx_kwargs
	)

Return Quantity rescaled to different units.

:param other: destination units.
:type other: Quantity, str or dict

to_base_units()

def SUAVE.Plugins.pint.quantity._Quantity.to_base_units

(

self

)

Return Quantity rescaled to base units

unitless()

def SUAVE.Plugins.pint.quantity._Quantity.unitless

(

self

)

Return true if the quantity does not have units.

units()

def SUAVE.Plugins.pint.quantity._Quantity.units

(

self

)

Quantity's units.

:rtype: UnitContainer

---

The documentation for this class was generated from the following file:

• /Users/emiliobotero/Dropbox/SUAVE/SUAVE/trunk/SUAVE/Plugins/pint/quantity.py