| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="General matrix multiplication for f32, f64 matrices."><meta name="keywords" content="rust, rustlang, rust-lang, matrixmultiply"><title>matrixmultiply - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../matrixmultiply/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../matrixmultiply/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate matrixmultiply</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.15</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">matrixmultiply</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/matrixmultiply/lib.rs.html#8-65">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>General matrix multiplication for f32, f64 matrices.</p> |
| <p>Allows arbitrary row, column strided matrices.</p> |
| <p>Uses the same microkernel algorithm as <a href="https://github.com/flame/blis">BLIS</a>, but in a much simpler |
| and less featureful implementation. |
| See their <a href="https://github.com/flame/blis/wiki/Multithreading">multithreading</a> page for a very good diagram over how |
| the algorithm partitions the matrix (<em>Note:</em> this crate does not implement |
| multithreading).</p> |
| <h3 id="matrix-representation"><a href="#matrix-representation">Matrix Representation</a></h3> |
| <p><strong>matrixmultiply</strong> supports matrices with general stride, so a matrix |
| is passed using a pointer and four integers:</p> |
| <ul> |
| <li><code>a: *const f32</code>, pointer to the first element in the matrix</li> |
| <li><code>m: usize</code>, number of rows</li> |
| <li><code>k: usize</code>, number of columns</li> |
| <li><code>rsa: isize</code>, row stride</li> |
| <li><code>csa: isize</code>, column stride</li> |
| </ul> |
| <p>In this example, A is a m by k matrix. <code>a</code> is a pointer to the element at |
| index <em>0, 0</em>.</p> |
| <p>The <em>row stride</em> is the pointer offset (in number of elements) to the |
| element on the next row. It’s the distance from element <em>i, j</em> to <em>i + 1, |
| j</em>.</p> |
| <p>The <em>column stride</em> is the pointer offset (in number of elements) to the |
| element in the next column. It’s the distance from element <em>i, j</em> to <em>i, |
| j + 1</em>.</p> |
| <p>For example for a contiguous matrix, row major strides are <em>rsa=k, |
| csa=1</em> and column major strides are <em>rsa=1, csa=m</em>.</p> |
| <p>Stides can be negative or even zero, but for a mutable matrix elements |
| may not alias each other.</p> |
| </div></details><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dgemm.html" title="matrixmultiply::dgemm fn">dgemm</a><sup title="unsafe function">⚠</sup></div><div class="item-right docblock-short">General matrix multiplication (f64)</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sgemm.html" title="matrixmultiply::sgemm fn">sgemm</a><sup title="unsafe function">⚠</sup></div><div class="item-right docblock-short">General matrix multiplication (f32)</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="matrixmultiply" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
