common module

The common module contains common functions and classes used by the other modules.

calculate_average(sequence)

Calculate the average value of a sequence.

Parameters:

Name	Type	Description	Default
sequence	list or tuple	The sequence of numbers.	required

Returns:

Type	Description
float	The average value of the sequence.

Source code in uzgeo/common.py

def calculate_average(sequence):
    """
    Calculate the average value of a sequence.

    Args:
        sequence (list or tuple): The sequence of numbers.

    Returns:
        float: The average value of the sequence.
    """
    if not sequence:
        return None  # Return None for empty sequence

    total = sum(sequence)
    average = total / len(sequence)
    return average

forecast_sequence(sequence, forecast_periods=5, lag=1)

Forecast the next values in a sequence using a simple autoregressive model.

Parameters:

Name	Type	Description	Default
sequence	array-like	Sequence of numbers.	required
forecast_periods	int	Number of periods to forecast.	5
lag	int	Lag order for the autoregressive model.	1

Returns:

Type	Description
np.ndarray	Forecasted values.

Source code in uzgeo/common.py

def forecast_sequence(sequence, forecast_periods=5, lag=1):
    """
    Forecast the next values in a sequence using a simple autoregressive model.

    Args:
        sequence (array-like): Sequence of numbers.
        forecast_periods (int): Number of periods to forecast.
        lag (int): Lag order for the autoregressive model.

    Returns:
        np.ndarray: Forecasted values.
    """
    # Convert the sequence to numpy array
    sequence = np.array(sequence)

    # Initialize the forecasted values list with the original sequence
    forecasted_values = sequence.tolist()

    # Fit autoregressive model
    for i in range(forecast_periods):
        # Slice the sequence for the lag order
        X = sequence[-lag:]

        # Calculate the next value using the mean of the last 'lag' values
        next_value = np.mean(X)

        # Append the next value to the forecasted values
        forecasted_values.append(next_value)

        # Update the sequence by appending the next value
        sequence = np.append(sequence, next_value)

    return np.array(forecasted_values)

generate_random_points(num_points, min_lat, max_lat, min_long, max_long)

Generate random points on a map within the specified latitude and longitude range.

• num_points (int): The number of random points to generate.
• min_lat (float): The minimum latitude.
• max_lat (float): The maximum latitude.
• min_long (float): The minimum longitude.
• max_long (float): The maximum longitude.

• List of tuples: Each tuple contains the latitude and longitude of a random point.

Source code in uzgeo/common.py

def generate_random_points(num_points, min_lat, max_lat, min_long, max_long):
    """
    Generate random points on a map within the specified latitude and longitude range.

    Args:
    - num_points (int): The number of random points to generate.
    - min_lat (float): The minimum latitude.
    - max_lat (float): The maximum latitude.
    - min_long (float): The minimum longitude.
    - max_long (float): The maximum longitude.

    Returns:
    - List of tuples: Each tuple contains the latitude and longitude of a random point.
    """
    random_points = []
    for _ in range(num_points):
        lat = random.uniform(min_lat, max_lat)
        long = random.uniform(min_long, max_long)
        random_points.append((lat, long))
    return random_points

hello_world()

Prints "Hello World!" to the console.

Source code in uzgeo/common.py

def hello_world():
    """Prints "Hello World!" to the console.
    """
    print("Hello World!")

solve_linear_equation(a, b)

Solve a linear equation of the form ax + b = 0.

Parameters:

Name	Type	Description	Default
a	float	Coefficient of the variable.	required
b	float	Constant term.	required

Returns:

Type	Description
float	The solution for the variable x.

Source code in uzgeo/common.py

def solve_linear_equation(a, b):
    """
    Solve a linear equation of the form ax + b = 0.

    Args:
        a (float): Coefficient of the variable.
        b (float): Constant term.

    Returns:
        float: The solution for the variable x.
    """
    if a == 0:
        raise ValueError("Coefficient 'a' cannot be zero for a linear equation.")

    return -b / a

sum_of_sequence(sequence)

Calculate the sum of a sequence.

sequence (list): A list of numbers.

Source code in uzgeo/common.py

def sum_of_sequence(sequence):
    """
    Calculate the sum of a sequence.

    Args:
    sequence (list): A list of numbers.

    Returns:
    float: The sum of the numbers in the sequence.
    """
    total = 0
    for num in sequence:
        total += num
    return total