Calculates the cosine similarity of a pair of 1D lists.

1d_cosine_similarity.py

from numpy import float64, inner
from numpy.linalg import norm
from numpy.typing import NDArray


def calculate_1d_cosine_similarity(a: NDArray[float64], b: NDArray[float64]) -> float:
    """
    Summary
    -------
    calculate the cosine similarity of two 1D vectors

    Parameters
    ----------
    a (NDArray[float64]): 1D array of arbitrary values
    b (NDArray[float64]): 1D array of arbitrary values

    Returns
    -------
    similarity (float): normalised similarity of a and b
    """
    return inner(a, b) / (norm(a)*norm(b))