<!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="Source of the Rust file `/home/sangenya/.cargo/registry/src/github.com-1ecc6299db9ec823/matrixmultiply-0.1.15/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../matrixmultiply/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
</pre><pre class="rust">
<span class="comment">// Copyright 2016 bluss</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span>
<span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! General matrix multiplication for f32, f64 matrices.</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! Allows arbitrary row, column strided matrices.</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! Uses the same microkernel algorithm as [BLIS][bl], but in a much simpler</span>
<span class="doccomment">//! and less featureful implementation.</span>
<span class="doccomment">//! See their [multithreading][mt] page for a very good diagram over how</span>
<span class="doccomment">//! the algorithm partitions the matrix (*Note:* this crate does not implement</span>
<span class="doccomment">//! multithreading).</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! [bl]: https://github.com/flame/blis</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! [mt]: https://github.com/flame/blis/wiki/Multithreading</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Matrix Representation</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! **matrixmultiply** supports matrices with general stride, so a matrix</span>
<span class="doccomment">//! is passed using a pointer and four integers:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - `a: *const f32`, pointer to the first element in the matrix</span>
<span class="doccomment">//! - `m: usize`, number of rows</span>
<span class="doccomment">//! - `k: usize`, number of columns</span>
<span class="doccomment">//! - `rsa: isize`, row stride</span>
<span class="doccomment">//! - `csa: isize`, column stride</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! In this example, A is a m by k matrix. `a` is a pointer to the element at</span>
<span class="doccomment">//! index *0, 0*.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The *row stride* is the pointer offset (in number of elements) to the</span>
<span class="doccomment">//! element on the next row. It’s the distance from element *i, j* to *i + 1,</span>
<span class="doccomment">//! j*.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The *column stride* is the pointer offset (in number of elements) to the</span>
<span class="doccomment">//! element in the next column. It’s the distance from element *i, j* to *i,</span>
<span class="doccomment">//! j + 1*.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! For example for a contiguous matrix, row major strides are *rsa=k,</span>
<span class="doccomment">//! csa=1* and column major strides are *rsa=1, csa=m*.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Stides can be negative or even zero, but for a mutable matrix elements</span>
<span class="doccomment">//! may not alias each other.</span>
<span class="attribute">#![<span class="ident">doc</span>(<span class="ident">html_root_url</span> <span class="op">=</span> <span class="string">"https://docs.rs/matrixmultiply/0.1/"</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rawpointer</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">mod</span> <span class="ident">debugmacros</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">mod</span> <span class="ident">loopmacros</span>;
<span class="kw">mod</span> <span class="ident">archparam</span>;
<span class="kw">mod</span> <span class="ident">kernel</span>;
<span class="kw">mod</span> <span class="ident">gemm</span>;
<span class="kw">mod</span> <span class="ident">sgemm_kernel</span>;
<span class="kw">mod</span> <span class="ident">dgemm_kernel</span>;
<span class="kw">mod</span> <span class="ident">util</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">gemm::sgemm</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">gemm::dgemm</span>;
</pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="matrixmultiply" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>