Skip to content

Calculator Module

src.core.calculator

The core calculator library with basic arithmetic operations.

add(a, b)

Return the sum of two numbers.

The add function is a simple utility designed to perform the addition of two floating-point numbers. It takes two arguments, a and b, both of which are expected to be of type float. The function returns their sum, also as a float.

PARAMETER DESCRIPTION
a

The first number.

TYPE: float

b

The second number.

TYPE: float

RETURNS DESCRIPTION
float

The sum of the two numbers.

Examples:

>>> add(2, 3)
5

>>> add(-1, 1)
0
Source code in src/core/calculator.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def add(a: float, b: float) -> float:
    """
    Return the sum of two numbers.

    The `add` function is a simple utility designed to perform the addition of
    two floating-point numbers. It takes two arguments, `a` and `b`, both of
    which are expected to be of type `float`. The function returns their sum,
    also as a `float`.

    Args:
        a: The first number.
        b: The second number.

    Returns:
        The sum of the two numbers.

    Examples:
        >>> add(2, 3)
        5

        >>> add(-1, 1)
        0
    """
    return a + b

subtract(a, b)

Return the difference of two numbers.

PARAMETER DESCRIPTION
a

The first number.

TYPE: float

b

The second number.

TYPE: float

RETURNS DESCRIPTION
float

The difference of the two numbers.

Examples:

>>> subtract(5, 3)
2

>>> subtract(2, 5)
-3
Source code in src/core/calculator.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def subtract(a: float, b: float) -> float:
    """
    Return the difference of two numbers.

    Args:
        a: The first number.
        b: The second number.

    Returns:
        The difference of the two numbers.

    Examples:
        >>> subtract(5, 3)
        2

        >>> subtract(2, 5)
        -3
    """
    return a - b

multiply(a, b)

Return the product of two numbers.

PARAMETER DESCRIPTION
a

The first number.

TYPE: float

b

The second number.

TYPE: float

RETURNS DESCRIPTION
float

The product of the two numbers.

Examples:

>>> multiply(2, 3)
6

>>> multiply(-1, 4)
-4
Source code in src/core/calculator.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def multiply(a: float, b: float) -> float:
    """
    Return the product of two numbers.

    Args:
        a: The first number.
        b: The second number.

    Returns:
        The product of the two numbers.

    Examples:
        >>> multiply(2, 3)
        6

        >>> multiply(-1, 4)
        -4
    """
    return a * b

divide(a, b)

Return the division of two numbers. Raise an error if dividing by zero.

PARAMETER DESCRIPTION
a

The numerator.

TYPE: float

b

The denominator.

TYPE: float

RETURNS DESCRIPTION
float

The result of the division.
RAISES DESCRIPTION
ValueError

If the denominator is zero.

Examples:

>>> divide(6, 3)
2.0

>>> divide(5, 2)
2.5
Source code in src/core/calculator.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def divide(a: float, b: float) -> float:
    """
    Return the division of two numbers. Raise an error if dividing by zero.

    Args:
        a: The numerator.
        b: The denominator.

    Returns:
        The result of the division.

    Raises:
        ValueError: If the denominator is zero.

    Examples:
        >>> divide(6, 3)
        2.0

        >>> divide(5, 2)
        2.5
    """
    if b == 0:
        raise ValueError("Cannot divide by zero.")
    return a / b