module1.py

Intro docs for module 1

A

Simple class containing a variable

Source code in module/module1.py

class A:
    """Simple class containing a variable
    """

    def __init__(self, x):
        self.x = x

    def __mul__(self, other):
        """For if both objects are of type A
        """
        return self.x * other.x

    def power(self, pow: int = 2):
        """raise to power store, and return.
        Args:
            pow (int)

        Returns:
            (float): self.x ** pow
        """
        self.x *= self.x
        return self.x

__mul__(self, other) special

For if both objects are of type A

Source code in module/module1.py

def __mul__(self, other):
    """For if both objects are of type A
    """
    return self.x * other.x

power(self, pow=2)

raise to power store, and return.

Returns:

Type	Description
(float)	self.x ** pow

Source code in module/module1.py

def power(self, pow: int = 2):
    """raise to power store, and return.
    Args:
        pow (int)

    Returns:
        (float): self.x ** pow
    """
    self.x *= self.x
    return self.x

mult_A(a1, a2)

Multiplication for A objects. computes: \(\(x_{a1}*x_{a2}\)\)

Parameters:

Name	Type	Description	Default
a1	A	instance of A class	required
a2	A	instance of A class	required

Returns:

Type	Description
float	a1.x * a2.x

Note

programatically this does:

a1.x * a2.x

Source code in module/module1.py

def mult_A(a1: A, a2: A):
    """Multiplication for A objects.
    computes: 
        $$x_{a1}*x_{a2}$$

    Args:
        a1 (A): instance of `A` class
        a2 (A): instance of `A` class

    Returns:
        float: a1.x * a2.x

    Note:
        programatically this does:
        ```
        a1.x * a2.x
        ```
    """
    return a1.x * a2.x