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

# Class Radians

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

Known Subclasses:
  - Bearing_
  - , Lam
  - , Phi
  - , Radians_

Named `float` representing a coordinate in `radians`, optionally clipped.

Instance Methods
toRepr(self, prec=8, fmt=`'``f``'`, ints=False, std=False) Return a representation of this `Float`. |
toStr(self, prec=8, fmt=`'``f``'`, ints=False) Format this `Float` as `str`. |
Inherited from `Float`: `__repr__`, `__str__` 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_`, `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `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=`'``radians``'`, Error=<class 'pygeodesy.errors.UnitError'>, suffix=`'``NSEW``'`, clip=0, **name_arg) New named `Radians` instance. |

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=`'``radians``'`, Error=<class 'pygeodesy.errors.UnitError'>, suffix=`'``NSEW``'`, clip=0, **name_arg) Static Method |
New named `Radians` instance. Arguments: `cls` - This class (`Radians` or sub-class). `arg` - The value (any `type` convertable to `float` or parsable by pygeodesy.parseRad). `name` - Optional instance name (`str`). `Error` - Optional error to raise, overriding the default UnitError. `suffix` - Optional, valid compass direction suffixes (`NSEW`). `clip` - Optional `arg` range `-clip..+clip` (`radians` or `0` or `None` for unclipped). `name_arg` - Optional `name=arg` keyword argument, inlieu of `name` and `arg`. Returns: a new object with type S, a subtype of T A `Radians` instance. Raises: `Error` - Invalid `arg` or `abs(arg)` below `low` or above `high`. Overrides: object.__new__

### toRepr (self, prec=8, fmt=`'``f``'`, ints=False, std=False) |
Return a representation of this `Float`. Arguments: `std` - Use the standard `repr` or the named representation (`bool`). Overrides: named._Named.toRepr (inherited documentation)

### toStr (self, prec=8, fmt=`'``f``'`, ints=False) |
Format this `Float` as `str`. Overrides: named._Named.toStr (inherited documentation)