Skip to content

blas 🔗

Blas operations.

BlasMixin 🔗

Mixin providing Blas operations for a Session.

This mixin is intended to be used in combination with BaseSession and should not be instantiated on its own.

Intended usage

class Session(BaseSession, BlasMixin): ...

sgemm 🔗

sgemm(
    m: int,
    n: int,
    k: int,
    alpha: float,
    a: list[float],
    lda: int,
    b: list[float],
    ldb: int,
    beta: float,
    ldc: int,
) -> list[float]

Performs the SGEMM operation.

Wraps the vaccel_sgemm() C operation.

Parameters:

Name Type Description Default

m 🔗

 int

The number of rows in matrix A and matrix C.

 required

n 🔗

 int

The number of columns in matrix B and matrix C.

 required

k 🔗

 int

The number of columns in matrix A and rows in matrix B.

 required

alpha 🔗

 float

Scalar multiplier for the matrix product A * B.

 required

a 🔗

 list[float]

The matrix A in row-major order with shape (m, k).

 required

lda 🔗

 int

The leading dimension of matrix A (usually m).

 required

b 🔗

 list[float]

The matrix B in row-major order with shape (k, n).

 required

ldb 🔗

 int

The leading dimension of matrix B (usually k).

 required

beta 🔗

 float

Scalar multiplier for matrix C.

 required

ldc 🔗

 int

The leading dimension of matrix C (usually m).

 required

Returns:

Type Description
list[float]

The resulting matrix C in row-major order with shape (m, n).

Raises:

Type Description
RuntimeError

If the Session is uninitialized.
FFIError

If the C operation fails.
Source code in vaccel/ops/blas.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def sgemm(
    self,
    m: int,
    n: int,
    k: int,
    alpha: float,
    a: list[float],
    lda: int,
    b: list[float],
    ldb: int,
    beta: float,
    ldc: int,
) -> list[float]:
    """Performs the SGEMM operation.

    Wraps the `vaccel_sgemm()` C operation.

    Args:
        m: The number of rows in matrix A and matrix C.
        n: The number of columns in matrix B and matrix C.
        k: The number of columns in matrix A and rows in matrix B.
        alpha: Scalar multiplier for the matrix product A * B.
        a: The matrix A in row-major order with shape (m, k).
        lda: The leading dimension of matrix A (usually m).
        b: The matrix B in row-major order with shape (k, n).
        ldb: The leading dimension of matrix B (usually k).
        beta: Scalar multiplier for matrix C.
        ldc: The leading dimension of matrix C (usually m).

    Returns:
        The resulting matrix C in row-major order with shape (m, n).

    Raises:
        RuntimeError: If the `Session` is uninitialized.
        FFIError: If the C operation fails.
    """
    if not self._c_ptr:
        msg = "Uninitialized session"
        raise RuntimeError(msg)

    c_a = CList(a)
    c_b = CList(b)
    c_c = CList([float(0)] * m * n)

    ret = lib.vaccel_sgemm(
        self._c_ptr,
        m,
        n,
        k,
        alpha,
        c_a._c_ptr,
        lda,
        c_b._c_ptr,
        ldb,
        beta,
        c_c._c_ptr,
        ldc,
    )
    if ret != 0:
        raise FFIError(ret, "SGEMM failed")

    return c_c.value