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

# Class Float_

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

Known Subclasses:
  - Distance_
  - , Epoch
  - , FIx
  - , Meter2
  - , Meter3
  - , Meter_
  - , Radians2
  - , Radius_
  - , Scalar_

Named `float` with optional `low` and `high` limit.

Instance Methods
Inherited from `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`: `_DOT_`, `attrs`, `classof`, `copy`, `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='', Error=<class 'pygeodesy.errors.UnitError'>, low=2.22044604925e-16, high=None, **name_arg) New named `float` instance with limits. |

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

Method Details

### __new__ (cls, arg=None, name='', Error=<class 'pygeodesy.errors.UnitError'>, low=2.22044604925e-16, high=None, **name_arg) Static Method |
New named `float` instance with limits. 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__