| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"/> |
| <meta content="IE=edge" http-equiv="X-UA-Compatible"/> |
| <meta content="width=device-width, initial-scale=1" name="viewport"/> |
| <meta content="Linear Algebra NDArray API" property="og:title"> |
| <meta content="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/og-logo.png" property="og:image"> |
| <meta content="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/og-logo.png" property="og:image:secure_url"> |
| <meta content="Linear Algebra NDArray API" property="og:description"/> |
| <title>Linear Algebra NDArray API — mxnet documentation</title> |
| <link crossorigin="anonymous" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" rel="stylesheet"/> |
| <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet"/> |
| <link href="../../../_static/basic.css" rel="stylesheet" type="text/css"> |
| <link href="../../../_static/pygments.css" rel="stylesheet" type="text/css"> |
| <link href="../../../_static/mxnet.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: '../../../', |
| VERSION: '', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script src="https://code.jquery.com/jquery-1.11.1.min.js" type="text/javascript"></script> |
| <script src="../../../_static/underscore.js" type="text/javascript"></script> |
| <script src="../../../_static/searchtools_custom.js" type="text/javascript"></script> |
| <script src="../../../_static/doctools.js" type="text/javascript"></script> |
| <script src="../../../_static/selectlang.js" type="text/javascript"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script> |
| <script type="text/javascript"> jQuery(function() { Search.loadIndex("/versions/1.5.0/searchindex.js"); Search.init();}); </script> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../../_static/jquery.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../../_static/underscore.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../../_static/doctools.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> --> |
| <!-- --> |
| <link href="../../../genindex.html" rel="index" title="Index"> |
| <link href="../../../search.html" rel="search" title="Search"/> |
| <link href="../index.html" rel="up" title="MXNet - Python API"/> |
| <link href="sparse.html" rel="next" title="Sparse NDArray API"/> |
| <link href="random.html" rel="prev" title="Random Distribution Generator NDArray API"/> |
| <link href="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-icon.png" rel="icon" type="image/png"/> |
| </link></link></link></meta></meta></meta></head> |
| <body background="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-background-compressed.jpeg" role="document"> |
| <div class="content-block"><div class="navbar navbar-fixed-top"> |
| <div class="container" id="navContainer"> |
| <div class="innder" id="header-inner"> |
| <h1 id="logo-wrap"> |
| <a href="../../../" id="logo"><img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet_logo.png"/></a> |
| </h1> |
| <nav class="nav-bar" id="main-nav"> |
| <a class="main-nav-link" href="/versions/1.5.0/install/index.html">Install</a> |
| <span id="dropdown-menu-position-anchor"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Gluon <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu"> |
| <li><a class="main-nav-link" href="/versions/1.5.0/tutorials/gluon/gluon.html">About</a></li> |
| <li><a class="main-nav-link" href="https://www.d2l.ai/">Dive into Deep Learning</a></li> |
| <li><a class="main-nav-link" href="https://gluon-cv.mxnet.io">GluonCV Toolkit</a></li> |
| <li><a class="main-nav-link" href="https://gluon-nlp.mxnet.io/">GluonNLP Toolkit</a></li> |
| </ul> |
| </span> |
| <span id="dropdown-menu-position-anchor"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">API <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu"> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/python/index.html">Python</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/c++/index.html">C++</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/clojure/index.html">Clojure</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/java/index.html">Java</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/julia/index.html">Julia</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/perl/index.html">Perl</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/r/index.html">R</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/scala/index.html">Scala</a></li> |
| </ul> |
| </span> |
| <span id="dropdown-menu-position-anchor-docs"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Docs <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu-docs"> |
| <li><a class="main-nav-link" href="/versions/1.5.0/faq/index.html">FAQ</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/tutorials/index.html">Tutorials</a> |
| <li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/1.5.0/example">Examples</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/architecture/index.html">Architecture</a></li> |
| <li><a class="main-nav-link" href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/model_zoo/index.html">Model Zoo</a></li> |
| <li><a class="main-nav-link" href="https://github.com/onnx/onnx-mxnet">ONNX</a></li> |
| </li></ul> |
| </span> |
| <span id="dropdown-menu-position-anchor-community"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Community <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu-community"> |
| <li><a class="main-nav-link" href="http://discuss.mxnet.io">Forum</a></li> |
| <li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/1.5.0">Github</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/community/contribute.html">Contribute</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/community/ecosystem.html">Ecosystem</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/community/powered_by.html">Powered By</a></li> |
| </ul> |
| </span> |
| <span id="dropdown-menu-position-anchor-version" style="position: relative"><a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">1.5.0<span class="caret"></span></a><ul id="package-dropdown-menu" class="dropdown-menu"><li><a href="/">master</a></li><li><a href="/versions/1.7.0/">1.7.0</a></li><li><a href=/versions/1.6.0/>1.6.0</a></li><li><a href=/versions/1.5.0/>1.5.0</a></li><li><a href=/versions/1.4.1/>1.4.1</a></li><li><a href=/versions/1.3.1/>1.3.1</a></li><li><a href=/versions/1.2.1/>1.2.1</a></li><li><a href=/versions/1.1.0/>1.1.0</a></li><li><a href=/versions/1.0.0/>1.0.0</a></li><li><a href=/versions/0.12.1/>0.12.1</a></li><li><a href=/versions/0.11.0/>0.11.0</a></li></ul></span></nav> |
| <script> function getRootPath(){ return "../../../" } </script> |
| <div class="burgerIcon dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button">☰</a> |
| <ul class="dropdown-menu" id="burgerMenu"> |
| <li><a href="/versions/1.5.0/install/index.html">Install</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/tutorials/index.html">Tutorials</a></li> |
| <li class="dropdown-submenu dropdown"> |
| <a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">Gluon</a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu"> |
| <li><a class="main-nav-link" href="/versions/1.5.0/tutorials/gluon/gluon.html">About</a></li> |
| <li><a class="main-nav-link" href="http://gluon.mxnet.io">The Straight Dope (Tutorials)</a></li> |
| <li><a class="main-nav-link" href="https://gluon-cv.mxnet.io">GluonCV Toolkit</a></li> |
| <li><a class="main-nav-link" href="https://gluon-nlp.mxnet.io/">GluonNLP Toolkit</a></li> |
| </ul> |
| </li> |
| <li class="dropdown-submenu"> |
| <a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">API</a> |
| <ul class="dropdown-menu"> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/python/index.html">Python</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/c++/index.html">C++</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/clojure/index.html">Clojure</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/java/index.html">Java</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/julia/index.html">Julia</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/perl/index.html">Perl</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/r/index.html">R</a></li> |
| <li><a class="main-nav-link" href="/versions/1.5.0/api/scala/index.html">Scala</a></li> |
| </ul> |
| </li> |
| <li class="dropdown-submenu"> |
| <a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">Docs</a> |
| <ul class="dropdown-menu"> |
| <li><a href="/versions/1.5.0/faq/index.html" tabindex="-1">FAQ</a></li> |
| <li><a href="/versions/1.5.0/tutorials/index.html" tabindex="-1">Tutorials</a></li> |
| <li><a href="https://github.com/apache/incubator-mxnet/tree/1.5.0/example" tabindex="-1">Examples</a></li> |
| <li><a href="/versions/1.5.0/architecture/index.html" tabindex="-1">Architecture</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home" tabindex="-1">Developer Wiki</a></li> |
| <li><a href="/versions/1.5.0/model_zoo/index.html" tabindex="-1">Gluon Model Zoo</a></li> |
| <li><a href="https://github.com/onnx/onnx-mxnet" tabindex="-1">ONNX</a></li> |
| </ul> |
| </li> |
| <li class="dropdown-submenu dropdown"> |
| <a aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" role="button" tabindex="-1">Community</a> |
| <ul class="dropdown-menu"> |
| <li><a href="http://discuss.mxnet.io" tabindex="-1">Forum</a></li> |
| <li><a href="https://github.com/apache/incubator-mxnet/tree/1.5.0" tabindex="-1">Github</a></li> |
| <li><a href="/versions/1.5.0/community/contribute.html" tabindex="-1">Contribute</a></li> |
| <li><a href="/versions/1.5.0/community/ecosystem.html" tabindex="-1">Ecosystem</a></li> |
| <li><a href="/versions/1.5.0/community/powered_by.html" tabindex="-1">Powered By</a></li> |
| </ul> |
| </li> |
| <li id="dropdown-menu-position-anchor-version-mobile" class="dropdown-submenu" style="position: relative"><a href="#" tabindex="-1">1.5.0</a><ul class="dropdown-menu"><li><a tabindex="-1" href=/>master</a></li><li><a tabindex="-1" href=/versions/1.6.0/>1.6.0</a></li><li><a tabindex="-1" href=/versions/1.5.0/>1.5.0</a></li><li><a tabindex="-1" href=/versions/1.4.1/>1.4.1</a></li><li><a tabindex="-1" href=/versions/1.3.1/>1.3.1</a></li><li><a tabindex="-1" href=/versions/1.2.1/>1.2.1</a></li><li><a tabindex="-1" href=/versions/1.1.0/>1.1.0</a></li><li><a tabindex="-1" href=/versions/1.0.0/>1.0.0</a></li><li><a tabindex="-1" href=/versions/0.12.1/>0.12.1</a></li><li><a tabindex="-1" href=/versions/0.11.0/>0.11.0</a></li></ul></li></ul> |
| </div> |
| <div class="plusIcon dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button"><span aria-hidden="true" class="glyphicon glyphicon-plus"></span></a> |
| <ul class="dropdown-menu dropdown-menu-right" id="plusMenu"></ul> |
| </div> |
| <div id="search-input-wrap"> |
| <form action="../../../search.html" autocomplete="off" class="" method="get" role="search"> |
| <div class="form-group inner-addon left-addon"> |
| <i class="glyphicon glyphicon-search"></i> |
| <input class="form-control" name="q" placeholder="Search" type="text"/> |
| </div> |
| <input name="check_keywords" type="hidden" value="yes"> |
| <input name="area" type="hidden" value="default"/> |
| </input></form> |
| <div id="search-preview"></div> |
| </div> |
| <div id="searchIcon"> |
| <span aria-hidden="true" class="glyphicon glyphicon-search"></span> |
| </div> |
| <!-- <div id="lang-select-wrap"> --> |
| <!-- <label id="lang-select-label"> --> |
| <!-- <\!-- <i class="fa fa-globe"></i> -\-> --> |
| <!-- <span></span> --> |
| <!-- </label> --> |
| <!-- <select id="lang-select"> --> |
| <!-- <option value="en">Eng</option> --> |
| <!-- <option value="zh">中文</option> --> |
| <!-- </select> --> |
| <!-- </div> --> |
| <!-- <a id="mobile-nav-toggle"> |
| <span class="mobile-nav-toggle-bar"></span> |
| <span class="mobile-nav-toggle-bar"></span> |
| <span class="mobile-nav-toggle-bar"></span> |
| </a> --> |
| </div> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $('body').css('background', 'white'); |
| </script> |
| <div class="container"> |
| <div class="row"> |
| <div aria-label="main navigation" class="sphinxsidebar leftsidebar" role="navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../index.html">MXNet APIs</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../architecture/index.html">MXNet Architecture</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../community/index.html">MXNet Community</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">MXNet FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../gluon/index.html">About Gluon</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../install/index.html">Installing MXNet</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../install/index.html#nvidia-jetson-tx-family">Nvidia Jetson TX family</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../install/index.html#source-download">Source Download</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../model_zoo/index.html">MXNet Model Zoo</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorials/index.html">Tutorials</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="content"> |
| <div class="page-tracker"></div> |
| <!--- Licensed to the Apache Software Foundation (ASF) under one --> |
| <!--- or more contributor license agreements. See the NOTICE file --> |
| <!--- distributed with this work for additional information --> |
| <!--- regarding copyright ownership. The ASF licenses this file --> |
| <!--- to you under the Apache License, Version 2.0 (the --> |
| <!--- "License"); you may not use this file except in compliance --> |
| <!--- with the License. You may obtain a copy of the License at --><!--- http://www.apache.org/licenses/LICENSE-2.0 --><!--- Unless required by applicable law or agreed to in writing, --> |
| <!--- software distributed under the License is distributed on an --> |
| <!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --> |
| <!--- KIND, either express or implied. See the License for the --> |
| <!--- specific language governing permissions and limitations --> |
| <!--- under the License. --><div class="section" id="linear-algebra-ndarray-api"> |
| <span id="linear-algebra-ndarray-api"></span><h1>Linear Algebra NDArray API<a class="headerlink" href="#linear-algebra-ndarray-api" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="overview"> |
| <span id="overview"></span><h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2> |
| <p>This document lists the linear algebra routines of the <em>n</em>-dimensional array package:</p> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%"/> |
| <col width="90%"/> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#module-mxnet.ndarray.linalg" title="mxnet.ndarray.linalg"><code class="xref py py-obj docutils literal"><span class="pre">mxnet.ndarray.linalg</span></code></a></td> |
| <td>Linear Algebra NDArray API of MXNet.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The <code class="docutils literal"><span class="pre">Linear</span> <span class="pre">Algebra</span> <span class="pre">NDArray</span></code> API, defined in the <code class="docutils literal"><span class="pre">ndarray.linalg</span></code> package, provides |
| imperative linear algebra tensor operations on CPU/GPU.</p> |
| <p>In the rest of this document, we list routines provided by the <code class="docutils literal"><span class="pre">ndarray.linalg</span></code> package.</p> |
| </div> |
| <div class="section" id="linear-algebra"> |
| <span id="linear-algebra"></span><h2>Linear Algebra<a class="headerlink" href="#linear-algebra" title="Permalink to this headline">¶</a></h2> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%"/> |
| <col width="90%"/> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.ndarray.linalg.gemm" title="mxnet.ndarray.linalg.gemm"><code class="xref py py-obj docutils literal"><span class="pre">gemm</span></code></a></td> |
| <td>Performs general matrix multiplication and accumulation.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.ndarray.linalg.gemm2" title="mxnet.ndarray.linalg.gemm2"><code class="xref py py-obj docutils literal"><span class="pre">gemm2</span></code></a></td> |
| <td>Performs general matrix multiplication.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.ndarray.linalg.potrf" title="mxnet.ndarray.linalg.potrf"><code class="xref py py-obj docutils literal"><span class="pre">potrf</span></code></a></td> |
| <td>Performs Cholesky factorization of a symmetric positive-definite matrix.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.ndarray.linalg.potri" title="mxnet.ndarray.linalg.potri"><code class="xref py py-obj docutils literal"><span class="pre">potri</span></code></a></td> |
| <td>Performs matrix inversion from a Cholesky factorization.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.ndarray.linalg.trmm" title="mxnet.ndarray.linalg.trmm"><code class="xref py py-obj docutils literal"><span class="pre">trmm</span></code></a></td> |
| <td>Performs multiplication with a lower triangular matrix.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.ndarray.linalg.trsm" title="mxnet.ndarray.linalg.trsm"><code class="xref py py-obj docutils literal"><span class="pre">trsm</span></code></a></td> |
| <td>Solves matrix equation involving a lower triangular matrix.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.ndarray.linalg.syrk" title="mxnet.ndarray.linalg.syrk"><code class="xref py py-obj docutils literal"><span class="pre">syrk</span></code></a></td> |
| <td>Multiplication of matrix with its transpose.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.ndarray.linalg.gelqf" title="mxnet.ndarray.linalg.gelqf"><code class="xref py py-obj docutils literal"><span class="pre">gelqf</span></code></a></td> |
| <td>LQ factorization for general matrix.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.ndarray.linalg.syevd" title="mxnet.ndarray.linalg.syevd"><code class="xref py py-obj docutils literal"><span class="pre">syevd</span></code></a></td> |
| <td>Eigendecomposition for symmetric matrix.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.ndarray.linalg.sumlogdiag" title="mxnet.ndarray.linalg.sumlogdiag"><code class="xref py py-obj docutils literal"><span class="pre">sumlogdiag</span></code></a></td> |
| <td>Computes the sum of the logarithms of the diagonal elements of a square matrix.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.ndarray.linalg.extractdiag" title="mxnet.ndarray.linalg.extractdiag"><code class="xref py py-obj docutils literal"><span class="pre">extractdiag</span></code></a></td> |
| <td>Extracts the diagonal entries of a square matrix.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.ndarray.linalg.makediag" title="mxnet.ndarray.linalg.makediag"><code class="xref py py-obj docutils literal"><span class="pre">makediag</span></code></a></td> |
| <td>Constructs a square matrix with the input as diagonal.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.ndarray.linalg.extracttrian" title="mxnet.ndarray.linalg.extracttrian"><code class="xref py py-obj docutils literal"><span class="pre">extracttrian</span></code></a></td> |
| <td>Extracts a triangular sub-matrix from a square matrix.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.ndarray.linalg.maketrian" title="mxnet.ndarray.linalg.maketrian"><code class="xref py py-obj docutils literal"><span class="pre">maketrian</span></code></a></td> |
| <td>Constructs a square matrix with the input representing a specific triangular sub-matrix.</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="api-reference"> |
| <span id="api-reference"></span><h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2> |
| <script src="../../../_static/js/auto_module_index.js" type="text/javascript"></script><span class="target" id="module-mxnet.ndarray.linalg"></span><p>Linear Algebra NDArray API of MXNet.</p> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.extractdiag"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">extractdiag</code><span class="sig-paren">(</span><em>A=None</em>, <em>offset=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.extractdiag" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Extracts the diagonal entries of a square matrix. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, then <em>A</em> represents a single square matrix which diagonal elements get extracted as a 1-dimensional tensor.</p> |
| <p>If <em>n>2</em>, then <em>A</em> represents a batch of square matrices on the trailing two dimensions. The extracted diagonals are returned as an <em>n-1</em>-dimensional tensor.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">diagonal</span> <span class="n">extraction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]</span> |
| |
| <span class="n">extractdiag</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]</span> |
| |
| <span class="n">extractdiag</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="o">=</span> <span class="p">[</span><span class="mf">2.0</span><span class="p">]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">diagonal</span> <span class="n">extraction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">5.0</span><span class="p">,</span> <span class="mf">6.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">7.0</span><span class="p">,</span> <span class="mf">8.0</span><span class="p">]]]</span> |
| |
| <span class="n">extractdiag</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">5.0</span><span class="p">,</span> <span class="mf">8.0</span><span class="p">]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L495</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of square matrices</li> |
| <li><strong>offset</strong> (<em>int</em><em>, </em><em>optional</em><em>, </em><em>default='0'</em>) – Offset of the diagonal versus the main diagonal. 0 corresponds to the main diagonal, a negative/positive value to diagonals below/above the main diagonal.</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.extracttrian"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">extracttrian</code><span class="sig-paren">(</span><em>A=None</em>, <em>offset=_Null</em>, <em>lower=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.extracttrian" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Extracts a triangular sub-matrix from a square matrix. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, then <em>A</em> represents a single square matrix from which a triangular sub-matrix is extracted as a 1-dimensional tensor.</p> |
| <p>If <em>n>2</em>, then <em>A</em> represents a batch of square matrices on the trailing two dimensions. The extracted triangular sub-matrices are returned as an <em>n-1</em>-dimensional tensor.</p> |
| <p>The <em>offset</em> and <em>lower</em> parameters determine the triangle to be extracted:</p> |
| <ul class="simple"> |
| <li>When <em>offset = 0</em> either the lower or upper triangle with respect to the main diagonal is extracted depending on the value of parameter <em>lower</em>.</li> |
| <li>When <em>offset = k > 0</em> the upper triangle with respect to the k-th diagonal above the main diagonal is extracted.</li> |
| <li>When <em>offset = k < 0</em> the lower triangle with respect to the k-th diagonal below the main diagonal is extracted.</li> |
| </ul> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">triagonal</span> <span class="n">extraction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]</span> |
| |
| <span class="n">extracttrian</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]</span> |
| <span class="n">extracttrian</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">lower</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]</span> |
| <span class="n">extracttrian</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="o">=</span> <span class="p">[</span><span class="mf">2.0</span><span class="p">]</span> |
| <span class="n">extracttrian</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="o">=</span> <span class="p">[</span><span class="mf">3.0</span><span class="p">]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">triagonal</span> <span class="n">extraction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">5.0</span><span class="p">,</span> <span class="mf">6.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">7.0</span><span class="p">,</span> <span class="mf">8.0</span><span class="p">]]]</span> |
| |
| <span class="n">extracttrian</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">5.0</span><span class="p">,</span> <span class="mf">7.0</span><span class="p">,</span> <span class="mf">8.0</span><span class="p">]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L605</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of square matrices</li> |
| <li><strong>offset</strong> (<em>int</em><em>, </em><em>optional</em><em>, </em><em>default='0'</em>) – Offset of the diagonal versus the main diagonal. 0 corresponds to the main diagonal, a negative/positive value to diagonals below/above the main diagonal.</li> |
| <li><strong>lower</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – Refer to the lower triangular matrix if lower=true, refer to the upper otherwise. Only relevant when offset=0</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.gelqf"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">gelqf</code><span class="sig-paren">(</span><em>A=None</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.gelqf" title="Permalink to this definition">¶</a></dt> |
| <dd><p>LQ factorization for general matrix. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, we compute the LQ factorization (LAPACK <em>gelqf</em>, followed by <em>orglq</em>). <em>A</em> |
| must have shape <em>(x, y)</em> with <em>x <= y</em>, and must have full rank <em>=x</em>. The LQ |
| factorization consists of <em>L</em> with shape <em>(x, x)</em> and <em>Q</em> with shape <em>(x, y)</em>, so |
| that:</p> |
| <blockquote> |
| <div><em>A</em> = <em>L</em> * <em>Q</em></div></blockquote> |
| <p>Here, <em>L</em> is lower triangular (upper triangle equal to zero) with nonzero diagonal, |
| and <em>Q</em> is row-orthonormal, meaning that</p> |
| <blockquote> |
| <div><em>Q</em> * <em>Q</em><sup>T</sup></div></blockquote> |
| <p>is equal to the identity matrix of shape <em>(x, x)</em>.</p> |
| <p>If <em>n>2</em>, <em>gelqf</em> is performed separately on the trailing two dimensions for all |
| inputs (batch mode).</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">LQ</span> <span class="n">factorization</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">,</span> <span class="mf">3.</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.</span><span class="p">,</span> <span class="mf">5.</span><span class="p">,</span> <span class="mf">6.</span><span class="p">]]</span> |
| <span class="n">Q</span><span class="p">,</span> <span class="n">L</span> <span class="o">=</span> <span class="n">gelqf</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> |
| <span class="n">Q</span> <span class="o">=</span> <span class="p">[[</span><span class="o">-</span><span class="mf">0.26726124</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.53452248</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.80178373</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.87287156</span><span class="p">,</span> <span class="mf">0.21821789</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.43643578</span><span class="p">]]</span> |
| <span class="n">L</span> <span class="o">=</span> <span class="p">[[</span><span class="o">-</span><span class="mf">3.74165739</span><span class="p">,</span> <span class="mf">0.</span><span class="p">],</span> |
| <span class="p">[</span><span class="o">-</span><span class="mf">8.55235974</span><span class="p">,</span> <span class="mf">1.96396101</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">LQ</span> <span class="n">factorization</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">,</span> <span class="mf">3.</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.</span><span class="p">,</span> <span class="mf">5.</span><span class="p">,</span> <span class="mf">6.</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">7.</span><span class="p">,</span> <span class="mf">8.</span><span class="p">,</span> <span class="mf">9.</span><span class="p">],</span> <span class="p">[</span><span class="mf">10.</span><span class="p">,</span> <span class="mf">11.</span><span class="p">,</span> <span class="mf">12.</span><span class="p">]]]</span> |
| <span class="n">Q</span><span class="p">,</span> <span class="n">L</span> <span class="o">=</span> <span class="n">gelqf</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> |
| <span class="n">Q</span> <span class="o">=</span> <span class="p">[[[</span><span class="o">-</span><span class="mf">0.26726124</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.53452248</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.80178373</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.87287156</span><span class="p">,</span> <span class="mf">0.21821789</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.43643578</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="o">-</span><span class="mf">0.50257071</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.57436653</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.64616234</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.7620735</span><span class="p">,</span> <span class="mf">0.05862104</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.64483142</span><span class="p">]]]</span> |
| <span class="n">L</span> <span class="o">=</span> <span class="p">[[[</span><span class="o">-</span><span class="mf">3.74165739</span><span class="p">,</span> <span class="mf">0.</span><span class="p">],</span> |
| <span class="p">[</span><span class="o">-</span><span class="mf">8.55235974</span><span class="p">,</span> <span class="mf">1.96396101</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="o">-</span><span class="mf">13.92838828</span><span class="p">,</span> <span class="mf">0.</span><span class="p">],</span> |
| <span class="p">[</span><span class="o">-</span><span class="mf">19.09768702</span><span class="p">,</span> <span class="mf">0.52758934</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L798</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices to be factorized</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.gemm"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">gemm</code><span class="sig-paren">(</span><em>A=None</em>, <em>B=None</em>, <em>C=None</em>, <em>transpose_a=_Null</em>, <em>transpose_b=_Null</em>, <em>alpha=_Null</em>, <em>beta=_Null</em>, <em>axis=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.gemm" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Performs general matrix multiplication and accumulation. |
| Input are tensors <em>A</em>, <em>B</em>, <em>C</em>, each of dimension <em>n >= 2</em> and having the same shape |
| on the leading <em>n-2</em> dimensions.</p> |
| <p>If <em>n=2</em>, the BLAS3 function <em>gemm</em> is performed:</p> |
| <blockquote> |
| <div><em>out</em> = <em>alpha</em> * <em>op</em>(<em>A</em>) * <em>op</em>(<em>B</em>) + <em>beta</em> * <em>C</em></div></blockquote> |
| <p>Here, <em>alpha</em> and <em>beta</em> are scalar parameters, and <em>op()</em> is either the identity or |
| matrix transposition (depending on <em>transpose_a</em>, <em>transpose_b</em>).</p> |
| <p>If <em>n>2</em>, <em>gemm</em> is performed separately for a batch of matrices. The column indices of the matrices |
| are given by the last dimensions of the tensors, the row indices by the axis specified with the <em>axis</em> |
| parameter. By default, the trailing two dimensions will be used for matrix encoding.</p> |
| <p>For a non-default axis parameter, the operation performed is equivalent to a series of swapaxes/gemm/swapaxes |
| calls. For example let <em>A</em>, <em>B</em>, <em>C</em> be 5 dimensional tensors. Then gemm(<em>A</em>, <em>B</em>, <em>C</em>, axis=1) is equivalent |
| to the following without the overhead of the additional swapaxis operations:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">A1</span> <span class="o">=</span> <span class="n">swapaxes</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dim2</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| <span class="n">B1</span> <span class="o">=</span> <span class="n">swapaxes</span><span class="p">(</span><span class="n">B</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dim2</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| <span class="n">C</span> <span class="o">=</span> <span class="n">swapaxes</span><span class="p">(</span><span class="n">C</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dim2</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| <span class="n">C</span> <span class="o">=</span> <span class="n">gemm</span><span class="p">(</span><span class="n">A1</span><span class="p">,</span> <span class="n">B1</span><span class="p">,</span> <span class="n">C</span><span class="p">)</span> |
| <span class="n">C</span> <span class="o">=</span> <span class="n">swapaxis</span><span class="p">(</span><span class="n">C</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dim2</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>When the input data is of type float32 and the environment variables MXNET_CUDA_ALLOW_TENSOR_CORE |
| and MXNET_CUDA_TENSOR_OP_MATH_ALLOW_CONVERSION are set to 1, this operator will try to use |
| pseudo-float16 precision (float32 math with float16 I/O) precision in order to use |
| Tensor Cores on suitable NVIDIA GPUs. This can sometimes give significant speedups.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">multiply</span><span class="o">-</span><span class="n">add</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| <span class="n">B</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| <span class="n">C</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| <span class="n">gemm</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">C</span><span class="p">,</span> <span class="n">transpose_b</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">beta</span><span class="o">=</span><span class="mf">10.0</span><span class="p">)</span> |
| <span class="o">=</span> <span class="p">[[</span><span class="mf">14.0</span><span class="p">,</span> <span class="mf">14.0</span><span class="p">,</span> <span class="mf">14.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">14.0</span><span class="p">,</span> <span class="mf">14.0</span><span class="p">,</span> <span class="mf">14.0</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">multiply</span><span class="o">-</span><span class="n">add</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">]]]</span> |
| <span class="n">B</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">]]]</span> |
| <span class="n">C</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">10.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.01</span><span class="p">]]]</span> |
| <span class="n">gemm</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">C</span><span class="p">,</span> <span class="n">transpose_b</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">2.0</span> <span class="p">,</span> <span class="n">beta</span><span class="o">=</span><span class="mf">10.0</span><span class="p">)</span> |
| <span class="o">=</span> <span class="p">[[[</span><span class="mf">104.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.14</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L89</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices</li> |
| <li><strong>B</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices</li> |
| <li><strong>C</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices</li> |
| <li><strong>transpose_a</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Multiply with transposed of first input (A).</li> |
| <li><strong>transpose_b</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Multiply with transposed of second input (B).</li> |
| <li><strong>alpha</strong> (<em>double</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – Scalar factor multiplied with A*B.</li> |
| <li><strong>beta</strong> (<em>double</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – Scalar factor multiplied with C.</li> |
| <li><strong>axis</strong> (<em>int</em><em>, </em><em>optional</em><em>, </em><em>default='-2'</em>) – Axis corresponding to the matrix rows.</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.gemm2"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">gemm2</code><span class="sig-paren">(</span><em>A=None</em>, <em>B=None</em>, <em>transpose_a=_Null</em>, <em>transpose_b=_Null</em>, <em>alpha=_Null</em>, <em>axis=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.gemm2" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Performs general matrix multiplication. |
| Input are tensors <em>A</em>, <em>B</em>, each of dimension <em>n >= 2</em> and having the same shape |
| on the leading <em>n-2</em> dimensions.</p> |
| <p>If <em>n=2</em>, the BLAS3 function <em>gemm</em> is performed:</p> |
| <blockquote> |
| <div><em>out</em> = <em>alpha</em> * <em>op</em>(<em>A</em>) * <em>op</em>(<em>B</em>)</div></blockquote> |
| <p>Here <em>alpha</em> is a scalar parameter and <em>op()</em> is either the identity or the matrix |
| transposition (depending on <em>transpose_a</em>, <em>transpose_b</em>).</p> |
| <p>If <em>n>2</em>, <em>gemm</em> is performed separately for a batch of matrices. The column indices of the matrices |
| are given by the last dimensions of the tensors, the row indices by the axis specified with the <em>axis</em> |
| parameter. By default, the trailing two dimensions will be used for matrix encoding.</p> |
| <p>For a non-default axis parameter, the operation performed is equivalent to a series of swapaxes/gemm/swapaxes |
| calls. For example let <em>A</em>, <em>B</em> be 5 dimensional tensors. Then gemm(<em>A</em>, <em>B</em>, axis=1) is equivalent to |
| the following without the overhead of the additional swapaxis operations:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">A1</span> <span class="o">=</span> <span class="n">swapaxes</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dim2</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| <span class="n">B1</span> <span class="o">=</span> <span class="n">swapaxes</span><span class="p">(</span><span class="n">B</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dim2</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| <span class="n">C</span> <span class="o">=</span> <span class="n">gemm2</span><span class="p">(</span><span class="n">A1</span><span class="p">,</span> <span class="n">B1</span><span class="p">)</span> |
| <span class="n">C</span> <span class="o">=</span> <span class="n">swapaxis</span><span class="p">(</span><span class="n">C</span><span class="p">,</span> <span class="n">dim1</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">dim2</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>When the input data is of type float32 and the environment variables MXNET_CUDA_ALLOW_TENSOR_CORE |
| and MXNET_CUDA_TENSOR_OP_MATH_ALLOW_CONVERSION are set to 1, this operator will try to use |
| pseudo-float16 precision (float32 math with float16 I/O) precision in order to use |
| Tensor Cores on suitable NVIDIA GPUs. This can sometimes give significant speedups.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">multiply</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| <span class="n">B</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| <span class="n">gemm2</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">transpose_b</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">2.0</span><span class="p">)</span> |
| <span class="o">=</span> <span class="p">[[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">multiply</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">]]]</span> |
| <span class="n">B</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">]]]</span> |
| <span class="n">gemm2</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">transpose_b</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">2.0</span><span class="p">)</span> |
| <span class="o">=</span> <span class="p">[[[</span><span class="mf">4.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.04</span> <span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L163</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices</li> |
| <li><strong>B</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices</li> |
| <li><strong>transpose_a</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Multiply with transposed of first input (A).</li> |
| <li><strong>transpose_b</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Multiply with transposed of second input (B).</li> |
| <li><strong>alpha</strong> (<em>double</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – Scalar factor multiplied with A*B.</li> |
| <li><strong>axis</strong> (<em>int</em><em>, </em><em>optional</em><em>, </em><em>default='-2'</em>) – Axis corresponding to the matrix row indices.</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.inverse"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">inverse</code><span class="sig-paren">(</span><em>A=None</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.inverse" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Compute the inverse of a matrix. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, <em>A</em> is a square matrix. We compute:</p> |
| <blockquote> |
| <div><em>out</em> = <em>A</em><sup>-1</sup></div></blockquote> |
| <p>If <em>n>2</em>, <em>inverse</em> is performed separately on the trailing two dimensions |
| for all inputs (batch mode).</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">inversion</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">4.</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">3.</span><span class="p">]]</span> |
| <span class="n">inverse</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="o">-</span><span class="mf">0.6</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.2</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">inversion</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">4.</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">3.</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">3.</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">4.</span><span class="p">]]]</span> |
| <span class="n">inverse</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="o">-</span><span class="mf">0.6</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.4</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.2</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="o">-</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">1.5</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.5</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L917</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of square matrix</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.makediag"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">makediag</code><span class="sig-paren">(</span><em>A=None</em>, <em>offset=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.makediag" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Constructs a square matrix with the input as diagonal. |
| Input is a tensor <em>A</em> of dimension <em>n >= 1</em>.</p> |
| <p>If <em>n=1</em>, then <em>A</em> represents the diagonal entries of a single square matrix. This matrix will be returned as a 2-dimensional tensor. |
| If <em>n>1</em>, then <em>A</em> represents a batch of diagonals of square matrices. The batch of diagonal matrices will be returned as an <em>n+1</em>-dimensional tensor.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">diagonal</span> <span class="n">matrix</span> <span class="n">construction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]</span> |
| |
| <span class="n">makediag</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]]</span> |
| |
| <span class="n">makediag</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">diagonal</span> <span class="n">matrix</span> <span class="n">construction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]</span> |
| |
| <span class="n">makediag</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">3.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L547</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of diagonal entries</li> |
| <li><strong>offset</strong> (<em>int</em><em>, </em><em>optional</em><em>, </em><em>default='0'</em>) – Offset of the diagonal versus the main diagonal. 0 corresponds to the main diagonal, a negative/positive value to diagonals below/above the main diagonal.</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.maketrian"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">maketrian</code><span class="sig-paren">(</span><em>A=None</em>, <em>offset=_Null</em>, <em>lower=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.maketrian" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Constructs a square matrix with the input representing a specific triangular sub-matrix. |
| This is basically the inverse of <em>linalg.extracttrian</em>. Input is a tensor <em>A</em> of dimension <em>n >= 1</em>.</p> |
| <p>If <em>n=1</em>, then <em>A</em> represents the entries of a triangular matrix which is lower triangular if <em>offset<0</em> or <em>offset=0</em>, <em>lower=true</em>. The resulting matrix is derived by first constructing the square |
| matrix with the entries outside the triangle set to zero and then adding <em>offset</em>-times an additional |
| diagonal with zero entries to the square matrix.</p> |
| <p>If <em>n>1</em>, then <em>A</em> represents a batch of triangular sub-matrices. The batch of corresponding square matrices is returned as an <em>n+1</em>-dimensional tensor.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">construction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">]</span> |
| |
| <span class="n">maketrian</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">]]</span> |
| |
| <span class="n">maketrian</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">lower</span><span class="o">=</span><span class="n">false</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">]]</span> |
| |
| <span class="n">maketrian</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]]</span> |
| <span class="n">maketrian</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">offset</span><span class="o">=-</span><span class="mi">1</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">construction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">5.0</span><span class="p">,</span> <span class="mf">6.0</span><span class="p">]]</span> |
| |
| <span class="n">maketrian</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">5.0</span><span class="p">,</span> <span class="mf">6.0</span><span class="p">]]]</span> |
| |
| <span class="n">maketrian</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">5.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">6.0</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L673</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of triangular matrices stored as vectors</li> |
| <li><strong>offset</strong> (<em>int</em><em>, </em><em>optional</em><em>, </em><em>default='0'</em>) – Offset of the diagonal versus the main diagonal. 0 corresponds to the main diagonal, a negative/positive value to diagonals below/above the main diagonal.</li> |
| <li><strong>lower</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – Refer to the lower triangular matrix if lower=true, refer to the upper otherwise. Only relevant when offset=0</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.potrf"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">potrf</code><span class="sig-paren">(</span><em>A=None</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.potrf" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Performs Cholesky factorization of a symmetric positive-definite matrix. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, the Cholesky factor <em>B</em> of the symmetric, positive definite matrix <em>A</em> is |
| computed. <em>B</em> is triangular (entries of upper or lower triangle are all zero), has |
| positive diagonal entries, and:</p> |
| <blockquote> |
| <div><em>A</em> = <em>B</em> * <em>B</em><sup>T</sup> if <em>lower</em> = <em>true</em> |
| <em>A</em> = <em>B</em><sup>T</sup> * <em>B</em> if <em>lower</em> = <em>false</em></div></blockquote> |
| <p>If <em>n>2</em>, <em>potrf</em> is performed separately on the trailing two dimensions for all inputs |
| (batch mode).</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">factorization</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">4.25</span><span class="p">]]</span> |
| <span class="n">potrf</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">factorization</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">4.25</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">16.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">17.0</span><span class="p">]]]</span> |
| <span class="n">potrf</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L214</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices to be decomposed</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.potri"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">potri</code><span class="sig-paren">(</span><em>A=None</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.potri" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Performs matrix inversion from a Cholesky factorization. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, <em>A</em> is a triangular matrix (entries of upper or lower triangle are all zero) |
| with positive diagonal. We compute:</p> |
| <blockquote> |
| <div><em>out</em> = <em>A</em><sup>-T</sup> * <em>A</em><sup>-1</sup> if <em>lower</em> = <em>true</em> |
| <em>out</em> = <em>A</em><sup>-1</sup> * <em>A</em><sup>-T</sup> if <em>lower</em> = <em>false</em></div></blockquote> |
| <p>In other words, if <em>A</em> is the Cholesky factor of a symmetric positive definite matrix |
| <em>B</em> (obtained by <em>potrf</em>), then</p> |
| <blockquote> |
| <div><em>out</em> = <em>B</em><sup>-1</sup></div></blockquote> |
| <p>If <em>n>2</em>, <em>potri</em> is performed separately on the trailing two dimensions for all inputs |
| (batch mode).</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">Use this operator only if you are certain you need the inverse of <em>B</em>, and |
| cannot use the Cholesky factor <em>A</em> (<em>potrf</em>), together with backsubstitution |
| (<em>trsm</em>). The latter is numerically much safer, and also cheaper.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">inverse</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]]</span> |
| <span class="n">potri</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">0.26563</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.0625</span><span class="p">],</span> <span class="p">[</span><span class="o">-</span><span class="mf">0.0625</span><span class="p">,</span> <span class="mf">0.25</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">inverse</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]]</span> |
| <span class="n">potri</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">0.26563</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.0625</span><span class="p">],</span> <span class="p">[</span><span class="o">-</span><span class="mf">0.0625</span><span class="p">,</span> <span class="mf">0.25</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">0.06641</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.01562</span><span class="p">],</span> <span class="p">[</span><span class="o">-</span><span class="mf">0.01562</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span><span class="mi">0625</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L275</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of lower triangular matrices</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.sumlogdiag"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">sumlogdiag</code><span class="sig-paren">(</span><em>A=None</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.sumlogdiag" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Computes the sum of the logarithms of the diagonal elements of a square matrix. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, <em>A</em> must be square with positive diagonal entries. We sum the natural |
| logarithms of the diagonal elements, the result has shape (1,).</p> |
| <p>If <em>n>2</em>, <em>sumlogdiag</em> is performed separately on the trailing two dimensions for all |
| inputs (batch mode).</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">reduction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">7.0</span><span class="p">]]</span> |
| <span class="n">sumlogdiag</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.9459</span><span class="p">]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">reduction</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">7.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">3.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mf">17.0</span><span class="p">]]]</span> |
| <span class="n">sumlogdiag</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.9459</span><span class="p">,</span> <span class="mf">3.9318</span><span class="p">]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L445</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of square matrices</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.syevd"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">syevd</code><span class="sig-paren">(</span><em>A=None</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.syevd" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Eigendecomposition for symmetric matrix. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, <em>A</em> must be symmetric, of shape <em>(x, x)</em>. We compute the eigendecomposition, |
| resulting in the orthonormal matrix <em>U</em> of eigenvectors, shape <em>(x, x)</em>, and the |
| vector <em>L</em> of eigenvalues, shape <em>(x,)</em>, so that:</p> |
| <blockquote> |
| <div><em>U</em> * <em>A</em> = <em>diag(L)</em> * <em>U</em></div></blockquote> |
| <p>Here:</p> |
| <blockquote> |
| <div><em>U</em> * <em>U</em><sup>T</sup> = <em>U</em><sup>T</sup> * <em>U</em> = <em>I</em></div></blockquote> |
| <p>where <em>I</em> is the identity matrix. Also, <em>L(0) <= L(1) <= L(2) <= ...</em> (ascending order).</p> |
| <p>If <em>n>2</em>, <em>syevd</em> is performed separately on the trailing two dimensions of <em>A</em> (batch |
| mode). In this case, <em>U</em> has <em>n</em> dimensions like <em>A</em>, and <em>L</em> has <em>n-1</em> dimensions.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">Derivatives for this operator are defined only if <em>A</em> is such that all its |
| eigenvalues are distinct, and the eigengaps are not too small. If you need |
| gradients, do not apply this operator to matrices with multiple eigenvalues.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">symmetric</span> <span class="n">eigendecomposition</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">4.</span><span class="p">]]</span> |
| <span class="n">U</span><span class="p">,</span> <span class="n">L</span> <span class="o">=</span> <span class="n">syevd</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> |
| <span class="n">U</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">0.89442719</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.4472136</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.4472136</span><span class="p">,</span> <span class="mf">0.89442719</span><span class="p">]]</span> |
| <span class="n">L</span> <span class="o">=</span> <span class="p">[</span><span class="mf">0.</span><span class="p">,</span> <span class="mf">5.</span><span class="p">]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">symmetric</span> <span class="n">eigendecomposition</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">4.</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">5.</span><span class="p">]]]</span> |
| <span class="n">U</span><span class="p">,</span> <span class="n">L</span> <span class="o">=</span> <span class="n">syevd</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> |
| <span class="n">U</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">0.89442719</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.4472136</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.4472136</span><span class="p">,</span> <span class="mf">0.89442719</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">0.92387953</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.38268343</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.38268343</span><span class="p">,</span> <span class="mf">0.92387953</span><span class="p">]]]</span> |
| <span class="n">L</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">0.</span><span class="p">,</span> <span class="mf">5.</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">0.17157288</span><span class="p">,</span> <span class="mf">5.82842712</span><span class="p">]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L867</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices to be factorized</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.syrk"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">syrk</code><span class="sig-paren">(</span><em>A=None</em>, <em>transpose=_Null</em>, <em>alpha=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.syrk" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Multiplication of matrix with its transpose. |
| Input is a tensor <em>A</em> of dimension <em>n >= 2</em>.</p> |
| <p>If <em>n=2</em>, the operator performs the BLAS3 function <em>syrk</em>:</p> |
| <blockquote> |
| <div><em>out</em> = <em>alpha</em> * <em>A</em> * <em>A</em><sup>T</sup></div></blockquote> |
| <p>if <em>transpose=False</em>, or</p> |
| <blockquote> |
| <div><em>out</em> = <em>alpha</em> * <em>A</em><sup>T</sup> * <em>A</em></div></blockquote> |
| <p>if <em>transpose=True</em>.</p> |
| <p>If <em>n>2</em>, <em>syrk</em> is performed separately on the trailing two dimensions for all |
| inputs (batch mode).</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">multiply</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">2.</span><span class="p">,</span> <span class="mf">3.</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.</span><span class="p">,</span> <span class="mf">5.</span><span class="p">,</span> <span class="mf">6.</span><span class="p">]]</span> |
| <span class="n">syrk</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">1.</span><span class="p">,</span> <span class="n">transpose</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| <span class="o">=</span> <span class="p">[[</span><span class="mf">14.</span><span class="p">,</span> <span class="mf">32.</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">32.</span><span class="p">,</span> <span class="mf">77.</span><span class="p">]]</span> |
| <span class="n">syrk</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">1.</span><span class="p">,</span> <span class="n">transpose</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="o">=</span> <span class="p">[[</span><span class="mf">17.</span><span class="p">,</span> <span class="mf">22.</span><span class="p">,</span> <span class="mf">27.</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">22.</span><span class="p">,</span> <span class="mf">29.</span><span class="p">,</span> <span class="mf">36.</span><span class="p">],</span> |
| <span class="p">[</span><span class="mf">27.</span><span class="p">,</span> <span class="mf">36.</span><span class="p">,</span> <span class="mf">45.</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">multiply</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">]]]</span> |
| <span class="n">syrk</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">2.</span><span class="p">,</span> <span class="n">transpose</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">4.</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.04</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L730</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of input matrices</li> |
| <li><strong>transpose</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Use transpose of input matrix.</li> |
| <li><strong>alpha</strong> (<em>double</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – Scalar factor to be applied to the result.</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.trmm"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">trmm</code><span class="sig-paren">(</span><em>A=None</em>, <em>B=None</em>, <em>transpose=_Null</em>, <em>rightside=_Null</em>, <em>lower=_Null</em>, <em>alpha=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.trmm" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Performs multiplication with a lower triangular matrix. |
| Input are tensors <em>A</em>, <em>B</em>, each of dimension <em>n >= 2</em> and having the same shape |
| on the leading <em>n-2</em> dimensions.</p> |
| <p>If <em>n=2</em>, <em>A</em> must be triangular. The operator performs the BLAS3 function |
| <em>trmm</em>:</p> |
| <blockquote> |
| <div><em>out</em> = <em>alpha</em> * <em>op</em>(<em>A</em>) * <em>B</em></div></blockquote> |
| <p>if <em>rightside=False</em>, or</p> |
| <blockquote> |
| <div><em>out</em> = <em>alpha</em> * <em>B</em> * <em>op</em>(<em>A</em>)</div></blockquote> |
| <p>if <em>rightside=True</em>. Here, <em>alpha</em> is a scalar parameter, and <em>op()</em> is either the |
| identity or the matrix transposition (depending on <em>transpose</em>).</p> |
| <p>If <em>n>2</em>, <em>trmm</em> is performed separately on the trailing two dimensions for all inputs |
| (batch mode).</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">triangular</span> <span class="n">matrix</span> <span class="n">multiply</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| <span class="n">B</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| <span class="n">trmm</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">2.0</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">triangular</span> <span class="n">matrix</span> <span class="n">multiply</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]]</span> |
| <span class="n">B</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">]]]</span> |
| <span class="n">trmm</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">2.0</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L333</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of lower triangular matrices</li> |
| <li><strong>B</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of matrices</li> |
| <li><strong>transpose</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Use transposed of the triangular matrix</li> |
| <li><strong>rightside</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Multiply triangular matrix from the right to non-triangular one.</li> |
| <li><strong>lower</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – True if the triangular matrix is lower triangular, false if it is upper triangular.</li> |
| <li><strong>alpha</strong> (<em>double</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – Scalar factor to be applied to the result.</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="function"> |
| <dt id="mxnet.ndarray.linalg.trsm"> |
| <code class="descclassname">mxnet.ndarray.linalg.</code><code class="descname">trsm</code><span class="sig-paren">(</span><em>A=None</em>, <em>B=None</em>, <em>transpose=_Null</em>, <em>rightside=_Null</em>, <em>lower=_Null</em>, <em>alpha=_Null</em>, <em>out=None</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mxnet.ndarray.linalg.trsm" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Solves matrix equation involving a lower triangular matrix. |
| Input are tensors <em>A</em>, <em>B</em>, each of dimension <em>n >= 2</em> and having the same shape |
| on the leading <em>n-2</em> dimensions.</p> |
| <p>If <em>n=2</em>, <em>A</em> must be triangular. The operator performs the BLAS3 function |
| <em>trsm</em>, solving for <em>out</em> in:</p> |
| <blockquote> |
| <div><em>op</em>(<em>A</em>) * <em>out</em> = <em>alpha</em> * <em>B</em></div></blockquote> |
| <p>if <em>rightside=False</em>, or</p> |
| <blockquote> |
| <div><em>out</em> * <em>op</em>(<em>A</em>) = <em>alpha</em> * <em>B</em></div></blockquote> |
| <p>if <em>rightside=True</em>. Here, <em>alpha</em> is a scalar parameter, and <em>op()</em> is either the |
| identity or the matrix transposition (depending on <em>transpose</em>).</p> |
| <p>If <em>n>2</em>, <em>trsm</em> is performed separately on the trailing two dimensions for all inputs |
| (batch mode).</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The operator supports float32 and float64 data types only.</p> |
| </div> |
| <p>Examples:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Single</span> <span class="n">matrix</span> <span class="n">solve</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| <span class="n">B</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]]</span> |
| <span class="n">trsm</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]</span> |
| |
| <span class="o">//</span> <span class="n">Batch</span> <span class="n">matrix</span> <span class="n">solve</span> |
| <span class="n">A</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]],</span> <span class="p">[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]]]</span> |
| <span class="n">B</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">8.0</span><span class="p">,</span> <span class="mf">8.0</span><span class="p">,</span> <span class="mf">8.0</span><span class="p">]]]</span> |
| <span class="n">trsm</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span> <span class="o">=</span> <span class="p">[[[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">]],</span> |
| <span class="p">[[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]]]</span> |
| </pre></div> |
| </div> |
| <p>Defined in src/operator/tensor/la_op.cc:L396</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| <li><strong>A</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of lower triangular matrices</li> |
| <li><strong>B</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a>) – Tensor of matrices</li> |
| <li><strong>transpose</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Use transposed of the triangular matrix</li> |
| <li><strong>rightside</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=0</em>) – Multiply triangular matrix from the right to non-triangular one.</li> |
| <li><strong>lower</strong> (<em>boolean</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – True if the triangular matrix is lower triangular, false if it is upper triangular.</li> |
| <li><strong>alpha</strong> (<em>double</em><em>, </em><em>optional</em><em>, </em><em>default=1</em>) – Scalar factor to be applied to the result.</li> |
| <li><strong>out</strong> (<a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray"><em>NDArray</em></a><em>, </em><em>optional</em>) – The output NDArray to hold the result.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> – The output of this function.</p> |
| </td> |
| </tr> |
| <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="ndarray.html#mxnet.ndarray.NDArray" title="mxnet.ndarray.NDArray">NDArray</a> or list of NDArrays</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <script>auto_index("api-reference");</script></div> |
| </div> |
| </div> |
| </div> |
| <div aria-label="main navigation" class="sphinxsidebar rightsidebar" role="navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <h3><a href="../../../index.html">Table Of Contents</a></h3> |
| <ul> |
| <li><a class="reference internal" href="#">Linear Algebra NDArray API</a><ul> |
| <li><a class="reference internal" href="#overview">Overview</a></li> |
| <li><a class="reference internal" href="#linear-algebra">Linear Algebra</a></li> |
| <li><a class="reference internal" href="#api-reference">API Reference</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div><div class="footer"> |
| <div class="section-disclaimer"> |
| <div class="container"> |
| <div> |
| <img height="60" src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/apache_incubator_logo.png"/> |
| <p> |
| Apache MXNet is an effort undergoing incubation at The Apache Software Foundation (ASF), <strong>sponsored by the <i>Apache Incubator</i></strong>. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. |
| </p> |
| <p> |
| "Copyright © 2017-2018, The Apache Software Foundation |
| Apache MXNet, MXNet, Apache, the Apache feather, and the Apache MXNet project logo are either registered trademarks or trademarks of the Apache Software Foundation." |
| </p> |
| </div> |
| </div> |
| </div> |
| </div> <!-- pagename != index --> |
| </div> |
| <script crossorigin="anonymous" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script> |
| <script src="../../../_static/js/sidebar.js" type="text/javascript"></script> |
| <script src="../../../_static/js/search.js" type="text/javascript"></script> |
| <script src="../../../_static/js/navbar.js" type="text/javascript"></script> |
| <script src="../../../_static/js/clipboard.min.js" type="text/javascript"></script> |
| <script src="../../../_static/js/copycode.js" type="text/javascript"></script> |
| <script src="../../../_static/js/page.js" type="text/javascript"></script> |
| <script src="../../../_static/js/docversion.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $('body').ready(function () { |
| $('body').css('visibility', 'visible'); |
| }); |
| </script> |
| </body> |
| </html> |
