package_name_to_import_with.calculator_sub_package.basics package

Subpackages

• package_name_to_import_with.calculator_sub_package.basics.assumptions package
  • Submodules
    • package_name_to_import_with.calculator_sub_package.basics.assumptions.inverses_module module
    • package_name_to_import_with.calculator_sub_package.basics.assumptions.operations_module module
  • Module contents
    • IdentityElements
    • InverseElements
    • add_numbers
    • get_negative
    • get_reciprocal
    • multiply_numbers

Submodules

• package_name_to_import_with.calculator_sub_package.basics.utility_module module
  • divide_numbers
  • subtract_numbers

Module contents

Expose standard functionalities.

class IdentityElements(value)

Bases: float, enum.Enum

Define assumed identity elements.

ADDITIVE_IDENTITY = 0.0

MULTIPLICATIVE_IDENTITY = 1.0

class InverseElements(value)

Bases: float, enum.Enum

Define supported inverse elements.

ADDITIVE_INVERSE = -1.0

MULTIPLICATIVE_INVERSE = 1.0

add_numbers(left_addend, right_addend)

Perform addition of two real numbers.

Parameters:

• left_addend (float) -- first number to be added

• right_addend (float) -- second number to be added

Returns:

sum of left_addend and right_addend

Return type:

float

Examples

>>> from package_name_to_import_with.calculator_sub_package import add_numbers
>>> add_numbers(1, 2)
3.0
>>> add_numbers(1, -2)
-1.0
>>> add_numbers(-1, 2)
1.0
>>> add_numbers(-1, -2)
-3.0

divide_numbers(dividend, divisor)

Perform division of two real numbers.

Parameters:

• dividend (float) -- number which is divided

• divisor (float) -- number which divides

Returns:

quotient of dividend by divisor

Return type:

float

Examples

>>> from package_name_to_import_with.calculator_sub_package import divide_numbers
>>> divide_numbers(1, 2)
0.5
>>> divide_numbers(1, -2)
-0.5
>>> divide_numbers(-1, 2)
-0.5
>>> divide_numbers(-1, -2)
0.5

get_negative(input_number)

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)

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

multiply_numbers(left_multiplicand, right_multiplicand)

Perform multiplication of two real numbers.

Parameters:

• left_multiplicand (float) -- first number to be multiplied

• right_multiplicand (float) -- second number to be multiplied

Returns:

product of two left_multiplicand and right_multiplicand

Return type:

float

Examples

>>> from package_name_to_import_with.calculator_sub_package import multiply_numbers
>>> multiply_numbers(1, 2)
2.0
>>> multiply_numbers(1, -2)
-2.0
>>> multiply_numbers(-1, 2)
-2.0
>>> multiply_numbers(-1, -2)
2.0

subtract_numbers(minuend, subtrahend)

Perform subtraction of two real numbers.

Parameters:

• minuend (float) -- number which is subtracted from

• subtrahend (float) -- number which is subtracted

Returns:

difference of minuend from subtrahend

Return type:

float

Examples

>>> from package_name_to_import_with.calculator_sub_package import subtract_numbers
>>> subtract_numbers(1, 2)
-1.0
>>> subtract_numbers(1, -2)
3.0
>>> subtract_numbers(-1, 2)
-3.0
>>> subtract_numbers(-1, -2)
1.0