Package schrodinger :: Package application :: Package desmond :: Package packages :: Module united :: Class quantity

Class quantity

 object --+    
          |    
??.instance --+
              |
             quantity

wrapped united symbolic quantity.

Instance Methods

[hide private]

__abs__(...)
__abs__( (quantity)arg1) -> quantity : Same as self.abs()

__add__(...)
__add__( (quantity)arg1, (quantity)arg2) -> quantity :

__div__(...)
__div__( (quantity)arg1, (quantity)arg2) -> object :

__eq__(...)
__eq__( (quantity)arg1, (quantity)arg2) -> bool :

__float__(...)
__float__( (quantity)arg1) -> float : Pure numbers convert to float.

__ge__(...)
__ge__( (quantity)arg1, (quantity)arg2) -> bool :

__gt__(...)
__gt__( (quantity)arg1, (quantity)arg2) -> bool :

__iadd__(...)
__iadd__( (object)arg1, (quantity)arg2) -> object :

__idiv__(...)
__idiv__( (object)arg1, (quantity)arg2) -> object :

__imul__(...)
__imul__( (object)arg1, (quantity)arg2) -> object :

__init__(...)
__init__( (object)arg1) -> None :

__isub__(...)
__isub__( (object)arg1, (quantity)arg2) -> object :

__le__(...)
__le__( (quantity)arg1, (quantity)arg2) -> bool :

__lt__(...)
__lt__( (quantity)arg1, (quantity)arg2) -> bool :

__mul__(...)
__mul__( (quantity)arg1, (quantity)arg2) -> object :

__ne__(...)
__ne__( (quantity)arg1, (quantity)arg2) -> bool :

__neg__(...)
__neg__( (quantity)arg1) -> quantity :

__pos__(...)
__pos__( (quantity)arg1) -> quantity :

__pow__(...)
__pow__( (quantity)arg1, (int)arg2) -> quantity : x**i for integer exponents only.

__radd__(...)
__radd__( (quantity)arg1, (quantity)arg2) -> quantity :

__rdiv__(...)
__rdiv__( (quantity)arg1, (float)arg2) -> object :

__reduce__(...)
__reduce__( (object)arg1) -> object : is pickle-able

__repr__(...)
__repr__( (quantity)arg1) -> str :

__rmul__(...)
__rmul__( (quantity)arg1, (float)arg2) -> object :

__rsub__(...)
__rsub__( (quantity)arg1, (quantity)arg2) -> quantity :

__sub__(...)
__sub__( (quantity)arg1, (quantity)arg2) -> quantity :

abs(...)
abs( (quantity)arg1) -> quantity : Absolute value of the quantity

dim(...)
dim( (quantity)arg1) -> dimension : The dimensions of the quantity.

num(...)
num( (quantity)arg1) -> float : The numerical encoding piece of the quantity.

sqrt(...)
sqrt( (quantity)arg1) -> quantity : The sqrt of the quantity, error if dims not even.

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

__instance_size__ = 48

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

abs(...)


__abs__( (quantity)arg1) -> quantity :
    Same as self.abs()

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> __abs__(desres::united::squantity<double, desres::united::PEAK::system>)

add(...)
(Addition operator)


__add__( (quantity)arg1, (quantity)arg2) -> quantity :

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> __add__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

div(...)


__div__( (quantity)arg1, (quantity)arg2) -> object :

    C++ signature :
        _object* __div__(desres::united::squantity<double, desres::united::PEAK::system> {lvalue},desres::united::squantity<double, desres::united::PEAK::system>)

__div__( (quantity)arg1, (float)arg2) -> object :

    C++ signature :
        _object* __div__(desres::united::squantity<double, desres::united::PEAK::system> {lvalue},double)

eq(...)
(Equality operator)


__eq__( (quantity)arg1, (quantity)arg2) -> bool :

    C++ signature :
        bool __eq__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

float(...)


__float__( (quantity)arg1) -> float :
    Pure numbers convert to float.  Others give a runtime error.

    C++ signature :
        double __float__(desres::united::squantity<double, desres::united::PEAK::system>)

ge(...)
(Greater-than-or-equals operator)


__ge__( (quantity)arg1, (quantity)arg2) -> bool :

    C++ signature :
        bool __ge__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

gt(...)
(Greater-than operator)


__gt__( (quantity)arg1, (quantity)arg2) -> bool :

    C++ signature :
        bool __gt__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

iadd(...)


__iadd__( (object)arg1, (quantity)arg2) -> object :

    C++ signature :
        _object* __iadd__(boost::python::back_reference<desres::united::squantity<double, desres::united::PEAK::system>&>,desres::united::squantity<double, desres::united::PEAK::system>)

idiv(...)


__idiv__( (object)arg1, (quantity)arg2) -> object :

    C++ signature :
        _object* __idiv__(boost::python::back_reference<desres::united::squantity<double, desres::united::PEAK::system>&>,desres::united::squantity<double, desres::united::PEAK::system>)

__idiv__( (object)arg1, (float)arg2) -> object :

    C++ signature :
        _object* __idiv__(boost::python::back_reference<desres::united::squantity<double, desres::united::PEAK::system>&>,double)

imul(...)


__imul__( (object)arg1, (quantity)arg2) -> object :

    C++ signature :
        _object* __imul__(boost::python::back_reference<desres::united::squantity<double, desres::united::PEAK::system>&>,desres::united::squantity<double, desres::united::PEAK::system>)

__imul__( (object)arg1, (float)arg2) -> object :

    C++ signature :
        _object* __imul__(boost::python::back_reference<desres::united::squantity<double, desres::united::PEAK::system>&>,double)

init(...)
(Constructor)


__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(_object*)

__init__( (object)arg1, (dimension)dim, (float)num) -> None :
    attaches dimensions to a float value unconditionally.

    C++ signature :
        void __init__(_object*,desres::united::sdimension,double)

__init__( (object)arg1, (float)num) -> None :
    initialization as a pure number.

    C++ signature :
        void __init__(_object*,double)

Overrides: object.__init__

isub(...)


__isub__( (object)arg1, (quantity)arg2) -> object :

    C++ signature :
        _object* __isub__(boost::python::back_reference<desres::united::squantity<double, desres::united::PEAK::system>&>,desres::united::squantity<double, desres::united::PEAK::system>)

le(...)
(Less-than-or-equals operator)


__le__( (quantity)arg1, (quantity)arg2) -> bool :

    C++ signature :
        bool __le__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

lt(...)
(Less-than operator)


__lt__( (quantity)arg1, (quantity)arg2) -> bool :

    C++ signature :
        bool __lt__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

mul(...)


__mul__( (quantity)arg1, (quantity)arg2) -> object :

    C++ signature :
        _object* __mul__(desres::united::squantity<double, desres::united::PEAK::system> {lvalue},desres::united::squantity<double, desres::united::PEAK::system>)

__mul__( (quantity)arg1, (float)arg2) -> object :

    C++ signature :
        _object* __mul__(desres::united::squantity<double, desres::united::PEAK::system> {lvalue},double)

ne(...)


__ne__( (quantity)arg1, (quantity)arg2) -> bool :

    C++ signature :
        bool __ne__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

neg(...)


__neg__( (quantity)arg1) -> quantity :

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> __neg__(desres::united::squantity<double, desres::united::PEAK::system>)

pos(...)


__pos__( (quantity)arg1) -> quantity :

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> __pos__(desres::united::squantity<double, desres::united::PEAK::system>)

pow(...)


__pow__( (quantity)arg1, (int)arg2) -> quantity :
    x**i for integer exponents only.

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> __pow__(desres::united::squantity<double, desres::united::PEAK::system>,int)

radd(...)
(Right-side addition operator)


__radd__( (quantity)arg1, (quantity)arg2) -> quantity :

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> __radd__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

rdiv(...)


__rdiv__( (quantity)arg1, (float)arg2) -> object :

    C++ signature :
        _object* __rdiv__(desres::united::squantity<double, desres::united::PEAK::system> {lvalue},double)

reduce(...)


__reduce__( (object)arg1) -> object :
    is pickle-able

    C++ signature :
        boost::python::api::object __reduce__(boost::python::api::object {lvalue})

Overrides: object.__reduce__

repr(...)
(Representation operator)


__repr__( (quantity)arg1) -> str :

    C++ signature :
        std::string __repr__(desres::united::squantity<double, desres::united::PEAK::system>)

Overrides: object.__repr__

rmul(...)


__rmul__( (quantity)arg1, (float)arg2) -> object :

    C++ signature :
        _object* __rmul__(desres::united::squantity<double, desres::united::PEAK::system> {lvalue},double)

rsub(...)


__rsub__( (quantity)arg1, (quantity)arg2) -> quantity :

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> __rsub__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

sub(...)
(Subtraction operator)


__sub__( (quantity)arg1, (quantity)arg2) -> quantity :

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> __sub__(desres::united::squantity<double, desres::united::PEAK::system>,desres::united::squantity<double, desres::united::PEAK::system>)

abs(...)


abs( (quantity)arg1) -> quantity :
    Absolute value of the quantity

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> abs(desres::united::squantity<double, desres::united::PEAK::system>)

dim(...)


dim( (quantity)arg1) -> dimension :
    The dimensions of the quantity.

    C++ signature :
        desres::united::sdimension dim(desres::united::squantity<double, desres::united::PEAK::system>)

num(...)


num( (quantity)arg1) -> float :
    The numerical encoding piece of the quantity.

    C++ signature :
        double num(desres::united::squantity<double, desres::united::PEAK::system>)

sqrt(...)


sqrt( (quantity)arg1) -> quantity :
    The sqrt of the quantity, error if dims not even.

    C++ signature :
        desres::united::squantity<double, desres::united::PEAK::system> sqrt(desres::united::squantity<double, desres::united::PEAK::system>)

Class quantity

__abs__(...)

__add__(...) (Addition operator)

__div__(...)

__eq__(...) (Equality operator)

__float__(...)

__ge__(...) (Greater-than-or-equals operator)

__gt__(...) (Greater-than operator)

__iadd__(...)

__idiv__(...)

__imul__(...)

__init__(...) (Constructor)

__isub__(...)

__le__(...) (Less-than-or-equals operator)

__lt__(...) (Less-than operator)

__mul__(...)

__ne__(...)

__neg__(...)

__pos__(...)

__pow__(...)

__radd__(...) (Right-side addition operator)

__rdiv__(...)

__reduce__(...)

__repr__(...) (Representation operator)

__rmul__(...)

__rsub__(...)

__sub__(...) (Subtraction operator)

abs(...)

dim(...)

num(...)

sqrt(...)

abs(...)

add(...)
(Addition operator)

div(...)

eq(...)
(Equality operator)

float(...)

ge(...)
(Greater-than-or-equals operator)

gt(...)
(Greater-than operator)

iadd(...)

idiv(...)

imul(...)

init(...)
(Constructor)

isub(...)

le(...)
(Less-than-or-equals operator)

lt(...)
(Less-than operator)

mul(...)

ne(...)

neg(...)

pos(...)

pow(...)

radd(...)
(Right-side addition operator)

rdiv(...)

reduce(...)

repr(...)
(Representation operator)

rmul(...)

rsub(...)

sub(...)
(Subtraction operator)