package_name_to_import_with.calculator_sub_package.basics.assumptions.inverses_module module#

Define additive and multiplicative identities and inverses.

class IdentityElements(value)[source]#

Bases: float, enum.Enum

Define assumed identity elements.

ADDITIVE_IDENTITY = 0.0#
MULTIPLICATIVE_IDENTITY = 1.0#
class InverseElements(value)[source]#

Bases: float, enum.Enum

Define supported inverse elements.

ADDITIVE_INVERSE = -1.0#
MULTIPLICATIVE_INVERSE = 1.0#
get_negative(input_number)[source]#

Get additive inverse of a real number.

Parameters:

input_number (float) -- number for which additive inverse is required

Returns:

negative of input_number

Return type:

float

Examples

>>> from package_name_to_import_with.calculator_sub_package import get_negative
>>> get_negative(1)
-1.0
>>> get_negative(-1)
1.0
get_reciprocal(input_number)[source]#

Get multiplicative inverse of a real number.

Parameters:

input_number (float) -- number for which multiplicative inverse is required

Returns:

reciprocal of input_number

Return type:

float

Raises:

ValueError -- if input_number is additive identity, viz. zero

Examples

>>> from package_name_to_import_with.calculator_sub_package import get_reciprocal
>>> get_reciprocal(2)
0.5
>>> get_reciprocal(0.5)
2.0