2024-10-15 23:12:17 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
2025-02-07 04:16:29 +08:00
< meta name = "generator" content = "Doxygen 1.13.2" / >
2024-10-15 23:12:17 +08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2025-02-07 04:16:29 +08:00
< title > MLX: mlx/backend/cpu/lapack.h Source File< / title >
2024-10-15 23:12:17 +08:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< script type = "text/javascript" src = "clipboard.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
2024-10-15 23:12:17 +08:00
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "cookie.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
< / script >
2024-10-15 23:12:17 +08:00
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr id = "projectrow" >
< td id = "projectalign" >
< div id = "projectname" > MLX
< / div >
< / td >
2025-01-10 05:56:20 +08:00
< td > < div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< span id = "MSearchSelect" onmouseover = "return searchBox.OnSearchSelectShow()" onmouseout = "return searchBox.OnSearchSelectHide()" >   < / span >
< input type = "text" id = "MSearchField" value = "" placeholder = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.svg" alt = "" / > < / a >
< / span >
< / div >
< / td >
2024-10-15 23:12:17 +08:00
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2025-02-07 04:16:29 +08:00
<!-- Generated by Doxygen 1.13.2 -->
2024-10-15 23:12:17 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
2024-10-15 23:12:17 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2025-01-10 05:56:20 +08:00
$(function(){initNavTree('lapack_8h_source.html',''); initResizable(true); });
2024-10-15 23:12:17 +08:00
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< div id = "doc-content" >
2024-10-15 23:12:17 +08:00
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "header" >
2024-10-26 04:23:45 +08:00
< div class = "headertitle" > < div class = "title" > lapack.h< / div > < / div >
2024-10-15 23:12:17 +08:00
< / div > <!-- header -->
< div class = "contents" >
2024-10-26 04:23:45 +08:00
< a href = "lapack_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a id = "l00001" name = "l00001" > < / a > < span class = "lineno" > 1< / span > < span class = "comment" > // Copyright © 2023-2024 Apple Inc.< / span > < / div >
2024-10-15 23:12:17 +08:00
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < / div >
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < span class = "preprocessor" > #pragma once< / span > < / div >
< div class = "line" > < a id = "l00004" name = "l00004" > < / a > < span class = "lineno" > 4< / span > < / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00005" name = "l00005" > < / a > < span class = "lineno" > 5< / span > < span class = "comment" > // Required for Visual Studio.< / span > < / div >
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < span class = "comment" > // https://github.com/OpenMathLib/OpenBLAS/blob/develop/docs/install.md< / span > < / div >
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < span class = "preprocessor" > #ifdef _MSC_VER< / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < span class = "preprocessor" > #include < complex> < / span > < / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < span class = "preprocessor" > #define LAPACK_COMPLEX_CUSTOM< / span > < / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < span class = "preprocessor" > #define lapack_complex_float std::complex< float> < / span > < / div >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > 11< / span > < span class = "preprocessor" > #define lapack_complex_double std::complex< double> < / span > < / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > 12< / span > < span class = "preprocessor" > #endif< / span > < / div >
2024-10-26 04:23:45 +08:00
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < / div >
2025-02-07 04:16:29 +08:00
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > 14< / span > < span class = "preprocessor" > #ifdef MLX_USE_ACCELERATE< / span > < / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < span class = "preprocessor" > #include < Accelerate/Accelerate.h> < / span > < / div >
< div class = "line" > < a id = "l00016" name = "l00016" > < / a > < span class = "lineno" > 16< / span > < span class = "preprocessor" > #else< / span > < / div >
< div class = "line" > < a id = "l00017" name = "l00017" > < / a > < span class = "lineno" > 17< / span > < span class = "preprocessor" > #include < cblas.h> < / span > < / div >
< div class = "line" > < a id = "l00018" name = "l00018" > < / a > < span class = "lineno" > 18< / span > < span class = "preprocessor" > #include < < a class = "code" href = "lapack_8h.html" > lapack.h< / a > > < / span > < / div >
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > 19< / span > < span class = "preprocessor" > #endif< / span > < / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "preprocessor" > #if defined(LAPACK_GLOBAL) || defined(LAPACK_NAME)< / span > < / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > < span class = "comment" > // This is to work around a change in the function signatures of lapack > = 3.9.1< / span > < / div >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < span class = "comment" > // where functions taking char* also include a strlen argument, see a similar< / span > < / div >
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > 25< / span > < span class = "comment" > // change in OpenCV:< / span > < / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < span class = "comment" > // https://github.com/opencv/opencv/blob/1eb061f89de0fb85c4c75a2deeb0f61a961a63ad/cmake/OpenCVFindLAPACK.cmake#L57< / span > < / div >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > 27< / span > < span class = "preprocessor" > #define MLX_LAPACK_FUNC(f) LAPACK_##f< / span > < / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > < / div >
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > 29< / span > < span class = "preprocessor" > #else< / span > < / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > 30< / span > < / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#ae22db9704827bf013a0a61f21a47464b" > 31< / a > < / span > < span class = "preprocessor" > #define MLX_LAPACK_FUNC(f) f##_< / span > < / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > 32< / span > < / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < span class = "preprocessor" > #endif< / span > < / div >
2025-03-06 05:30:09 +08:00
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < / div >
< div class = "foldopen" id = "foldopen00035" data-start = "" data-end = "" >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > 35< / a > < / span > < span class = "preprocessor" > #define INSTANTIATE_LAPACK_TYPES(FUNC) \< / span > < / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > < span class = "preprocessor" > template < typename T, typename... Args> \< / span > < / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > < span class = "preprocessor" > void FUNC(Args... args) { \< / span > < / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > 38< / span > < span class = "preprocessor" > if constexpr (std::is_same_v< T, float> ) { \< / span > < / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > < span class = "preprocessor" > MLX_LAPACK_FUNC(s##FUNC)(std::forward< Args> (args)...); \< / span > < / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > 40< / span > < span class = "preprocessor" > } else if constexpr (std::is_same_v< T, double> ) { \< / span > < / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > < span class = "preprocessor" > MLX_LAPACK_FUNC(d##FUNC)(std::forward< Args> (args)...); \< / span > < / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > 42< / span > < span class = "preprocessor" > } \< / span > < / div >
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > 43< / span > < span class = "preprocessor" > }< / span > < / div >
< / div >
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > 44< / span > < / div >
< div class = "line" > < a id = "l00045" name = "l00045" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#aeaf627909edbceee7bc57639c7b27124" > 45< / a > < / span > < a class = "code hl_define" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > (< a class = "code hl_function" href = "lapack_8h.html#aeaf627909edbceee7bc57639c7b27124" > geqrf< / a > )< / div >
< div class = "line" > < a id = "l00046" name = "l00046" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#aca4bf4d46eed1729128dc88d39c128c2" > 46< / a > < / span > < a class = "code hl_define" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > (< a class = "code hl_function" href = "lapack_8h.html#aca4bf4d46eed1729128dc88d39c128c2" > orgqr< / a > )< / div >
< div class = "line" > < a id = "l00047" name = "l00047" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#a07b8fcda68eb0c861d282757b5381148" > 47< / a > < / span > < a class = "code hl_define" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > (< a class = "code hl_function" href = "lapack_8h.html#a07b8fcda68eb0c861d282757b5381148" > syevd< / a > )< / div >
< div class = "line" > < a id = "l00048" name = "l00048" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#aafb37bcf77b8dacf75c9e8feed325757" > 48< / a > < / span > < a class = "code hl_define" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > (< a class = "code hl_function" href = "lapack_8h.html#aafb37bcf77b8dacf75c9e8feed325757" > potrf< / a > )< / div >
< div class = "line" > < a id = "l00049" name = "l00049" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#afa6b9dd8d9110ff8f41d32edf1912e44" > 49< / a > < / span > < a class = "code hl_define" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > (< a class = "code hl_function" href = "lapack_8h.html#afa6b9dd8d9110ff8f41d32edf1912e44" > gesvdx< / a > )< / div >
< div class = "line" > < a id = "l00050" name = "l00050" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#a6b0df109467651763a6e2b88f792a569" > 50< / a > < / span > < a class = "code hl_define" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > (< a class = "code hl_function" href = "lapack_8h.html#a6b0df109467651763a6e2b88f792a569" > getrf< / a > )< / div >
< div class = "line" > < a id = "l00051" name = "l00051" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#a54238f99f06c0843601cabe1cb6a2637" > 51< / a > < / span > < a class = "code hl_define" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > (< a class = "code hl_function" href = "lapack_8h.html#a54238f99f06c0843601cabe1cb6a2637" > getri< / a > )< / div >
< div class = "line" > < a id = "l00052" name = "l00052" > < / a > < span class = "lineno" > < a class = "line" href = "lapack_8h.html#a9eb1ec7983c0404d7055edd2e9edeb79" > 52< / a > < / span > < a class = "code hl_define" href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > (< a class = "code hl_function" href = "lapack_8h.html#a9eb1ec7983c0404d7055edd2e9edeb79" > trtri< / a > )< / div >
2024-10-26 04:23:45 +08:00
< div class = "ttc" id = "alapack_8h_html" > < div class = "ttname" > < a href = "lapack_8h.html" > lapack.h< / a > < / div > < / div >
2025-03-06 05:30:09 +08:00
< div class = "ttc" id = "alapack_8h_html_a07b8fcda68eb0c861d282757b5381148" > < div class = "ttname" > < a href = "lapack_8h.html#a07b8fcda68eb0c861d282757b5381148" > syevd< / a > < / div > < div class = "ttdeci" > void syevd(Args... args)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:47< / div > < / div >
< div class = "ttc" id = "alapack_8h_html_a54238f99f06c0843601cabe1cb6a2637" > < div class = "ttname" > < a href = "lapack_8h.html#a54238f99f06c0843601cabe1cb6a2637" > getri< / a > < / div > < div class = "ttdeci" > void getri(Args... args)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:51< / div > < / div >
< div class = "ttc" id = "alapack_8h_html_a6b0df109467651763a6e2b88f792a569" > < div class = "ttname" > < a href = "lapack_8h.html#a6b0df109467651763a6e2b88f792a569" > getrf< / a > < / div > < div class = "ttdeci" > void getrf(Args... args)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:50< / div > < / div >
< div class = "ttc" id = "alapack_8h_html_a9eb1ec7983c0404d7055edd2e9edeb79" > < div class = "ttname" > < a href = "lapack_8h.html#a9eb1ec7983c0404d7055edd2e9edeb79" > trtri< / a > < / div > < div class = "ttdeci" > void trtri(Args... args)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:52< / div > < / div >
< div class = "ttc" id = "alapack_8h_html_aa356d7affbe00e6a5a700225dc6a774e" > < div class = "ttname" > < a href = "lapack_8h.html#aa356d7affbe00e6a5a700225dc6a774e" > INSTANTIATE_LAPACK_TYPES< / a > < / div > < div class = "ttdeci" > #define INSTANTIATE_LAPACK_TYPES(FUNC)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:35< / div > < / div >
< div class = "ttc" id = "alapack_8h_html_aafb37bcf77b8dacf75c9e8feed325757" > < div class = "ttname" > < a href = "lapack_8h.html#aafb37bcf77b8dacf75c9e8feed325757" > potrf< / a > < / div > < div class = "ttdeci" > void potrf(Args... args)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:48< / div > < / div >
< div class = "ttc" id = "alapack_8h_html_aca4bf4d46eed1729128dc88d39c128c2" > < div class = "ttname" > < a href = "lapack_8h.html#aca4bf4d46eed1729128dc88d39c128c2" > orgqr< / a > < / div > < div class = "ttdeci" > void orgqr(Args... args)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:46< / div > < / div >
< div class = "ttc" id = "alapack_8h_html_aeaf627909edbceee7bc57639c7b27124" > < div class = "ttname" > < a href = "lapack_8h.html#aeaf627909edbceee7bc57639c7b27124" > geqrf< / a > < / div > < div class = "ttdeci" > void geqrf(Args... args)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:45< / div > < / div >
< div class = "ttc" id = "alapack_8h_html_afa6b9dd8d9110ff8f41d32edf1912e44" > < div class = "ttname" > < a href = "lapack_8h.html#afa6b9dd8d9110ff8f41d32edf1912e44" > gesvdx< / a > < / div > < div class = "ttdeci" > void gesvdx(Args... args)< / div > < div class = "ttdef" > < b > Definition< / b > lapack.h:49< / div > < / div >
2024-10-15 23:12:17 +08:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2025-01-10 05:56:20 +08:00
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2025-02-07 04:16:29 +08:00
< li class = "navelem" > < a class = "el" href = "dir_938ab0ecf10b8b860ff766c820f665fd.html" > mlx< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_1d446c9bd3c99228254c9484e0bc5c06.html" > backend< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_48c8bf40aae7e42226b4fe31ea48af19.html" > cpu< / a > < / li > < li class = "navelem" > < a class = "el" href = "lapack_8h.html" > lapack.h< / a > < / li >
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.13.2 < / li >
2025-01-10 05:56:20 +08:00
< / ul >
< / div >
2024-10-15 23:12:17 +08:00
< / body >
< / html >
