Package pygeodesy :: Module units :: Class Scalar_ |
[frames] | no frames]

# Class Scalar_

              object --+
                       |
                   float --+
                           |
          object --+       |
                   |       |
        named._Named --+   |
                       |   |
    unitsBase._NamedUnit --+
                           |
             unitsBase.Float --+
                               |
                          Float_ --+
                                   |
                                  Scalar_

Named `float` with optional `low` and `high` limits representing a factor, fraction, scale, etc.

Instance Methods
Inherited from `unitsBase.Float`: `__repr__`, `__str__`, `toRepr`, `toStr` Inherited from `float`: `__abs__`, `__add__`, `__coerce__`, `__div__`, `__divmod__`, `__eq__`, `__float__`, `__floordiv__`, `__format__`, `__ge__`, `__getattribute__`, `__getformat__`, `__getnewargs__`, `__gt__`, `__hash__`, `__int__`, `__le__`, `__long__`, `__lt__`, `__mod__`, `__mul__`, `__ne__`, `__neg__`, `__nonzero__`, `__pos__`, `__pow__`, `__radd__`, `__rdiv__`, `__rdivmod__`, `__rfloordiv__`, `__rmod__`, `__rmul__`, `__rpow__`, `__rsub__`, `__rtruediv__`, `__setformat__`, `__sub__`, `__truediv__`, `__trunc__`, `as_integer_ratio`, `conjugate`, `fromhex`, `hex`, `is_integer` Inherited from `named._Named`: `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `methodname`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Static Methods
a new object with type S, a subtype of T |
__new__(cls, arg=None, name=`'``scalar``'`, low=0.0, **high_Error_name_arg) New Scalar_ instance, see Scalar and Float_. |

Properties
Inherited from `float`: `imag`, `real` Inherited from `unitsBase._NamedUnit`: `std_repr`, `units` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof` Inherited from `object`: `__class__`

Method Details

### __new__ (cls, arg=None, name=`'``scalar``'`, low=0.0, **high_Error_name_arg) Static Method |
New Scalar_ instance, see Scalar and Float_. Arguments: `cls` - This class (`Float_` or sub-class). `arg` - The value (any `type` convertable to `float`). `name` - Optional instance name (`str`). `Error` - Optional error to raise, overriding the default UnitError. `low` - Optional lower `arg` limit (`float` or `None`). `high` - Optional upper `arg` limit (`float` or `None`). `name_arg` - Optional `name=arg` keyword argument, inlieu of `name` and `arg`. Returns: a new object with type S, a subtype of T A `Float_` instance. Raises: `Error` - Invalid `arg` or `arg` below `low` or above `high`. Overrides: object.__new__