Skip to content

sample

add 

add(a, b)

A function that adds two numbers.

Parameters:

  • a (float) –

    First number to add.

  • b (float) –

    Second number to add.

Returns:

  • float –

    The sum of a and b.

Source code in template/examples/sample.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def add(a: float, b: float) -> float:
    """
    A function that adds two numbers.

    Parameters
    ----------
    a
        First number to add.
    b
        Second number to add.

    Returns
    -------
    float
        The sum of a and b.
    """
    return a + b

divide 

divide(a, b)

A function that divides two numbers, i.e. a/b.

Parameters:

  • a (float) –

    The numerator

  • b (float) –

    The denominator

Returns:

  • float –

    The value for a/b

Source code in template/examples/sample.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def divide(a: float, b: float) -> float:
    """
    A function that divides two numbers, i.e. a/b.

    Parameters
    ----------
    a
        The numerator
    b
        The denominator

    Returns
    -------
    float
        The value for a/b
    """
    if b == 0:
        raise ValueError("Uh oh! The value for b should not be 0.")

    return a / b

make_array 

make_array(val, length=3)

A function to transform a number into a numpy array.

Parameters:

  • val (float) –

    Number to turn into an array.

  • length (int, default: 3 ) –

    The length of the array.

Returns:

  • NDArray –

    An array composed of val.

Source code in template/examples/sample.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def make_array(val: float, length: int = 3) -> NDArray:
    """
    A function to transform a number into a numpy array.

    Parameters
    ----------
    val
        Number to turn into an array.
    length
        The length of the array.

    Returns
    -------
    NDArray
        An array composed of `val`.
    """
    return np.array([val] * length)