electronics.electric_power
==========================

.. py:module:: electronics.electric_power


Classes
-------

.. autoapisummary::

   electronics.electric_power.Result


Functions
---------

.. autoapisummary::

   electronics.electric_power.electric_power


Module Contents
---------------

.. py:class:: Result

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: value
      :type:  float


.. py:function:: electric_power(voltage: float, current: float, power: float) -> tuple

   This function can calculate any one of the three (voltage, current, power),
   fundamental value of electrical system.
   examples are below:
   >>> electric_power(voltage=0, current=2, power=5)
   Result(name='voltage', value=2.5)
   >>> electric_power(voltage=2, current=2, power=0)
   Result(name='power', value=4.0)
   >>> electric_power(voltage=-2, current=3, power=0)
   Result(name='power', value=6.0)
   >>> electric_power(voltage=2, current=4, power=2)
   Traceback (most recent call last):
       ...
   ValueError: Exactly one argument must be 0
   >>> electric_power(voltage=0, current=0, power=2)
   Traceback (most recent call last):
       ...
   ValueError: Exactly one argument must be 0
   >>> electric_power(voltage=0, current=2, power=-4)
   Traceback (most recent call last):
       ...
   ValueError: Power cannot be negative in any electrical/electronics system
   >>> electric_power(voltage=2.2, current=2.2, power=0)
   Result(name='power', value=4.84)
   >>> electric_power(current=0, power=6, voltage=2)
   Result(name='current', value=3.0)