# [−][src]Crate matrixmultiply

General matrix multiplication for f32, f64 matrices. Operates on matrices with general layout (they can use arbitrary row and column stride).

This crate uses the same macro/microkernel approach to matrix multiplication as the BLIS project.

We presently provide a few good microkernels, portable and for x86-64, and only one operation: the general matrix-matrix multiplication (“gemm”).

## Matrix Representation

matrixmultiply supports matrices with general stride, so a matrix is passed using a pointer and four integers:

- `a: *const f32`, pointer to the first element in the matrix
- `m: usize`, number of rows
- `k: usize`, number of columns
- `rsa: isize`, row stride
- `csa: isize`, column stride

In this example, A is a m by k matrix. `a` is a pointer to the element at index 0, 0.

The row stride is the pointer offset (in number of elements) to the element on the next row. It’s the distance from element i, j to i + 1, j.

The column stride is the pointer offset (in number of elements) to the element in the next column. It’s the distance from element i, j to i, j + 1.

For example for a contiguous matrix, row major strides are rsa=k, csa=1 and column major strides are rsa=1, csa=m.

Stides can be negative or even zero, but for a mutable matrix elements may not alias each other.

## Portability and Performance

- The default kernels are written in portable Rust and available on all targets. These may depend on autovectorization to perform well.

- x86 and x86-64 features can be detected at runtime by default or compile time (if enabled), and the crate following kernel variants are implemented:

  - `fma`
  - `avx`
  - `sse2`

## Other Notes

The functions in this crate are thread safe, as long as the destination matrix is distinct.

## Functions

dgemm⚠ | General matrix multiplication (f64)
sgemm⚠ | General matrix multiplication (f32)

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)