File: reference.rst

package info (click to toggle)
xtensor-blas 0.21.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,068 kB
  • sloc: cpp: 97,896; makefile: 202; perl: 178; python: 153
file content (119 lines) | stat: -rw-r--r-- 2,962 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
.. Copyright (c) 2017, Wolf Vollprecht, Johan Mabille and Sylvain Corlay

   Distributed under the terms of the BSD 3-Clause License.

   The full license is in the file LICENSE, distributed with this software.


Reference
=========

Defined in ``xtensor-blas/xlinalg.hpp``

The functions here are closely modeled after NumPy's linalg package.

Matrix, vector and tensor products
--------------------------

.. doxygenfunction:: xt::linalg::dot
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::vdot
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::outer
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::matrix_power
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::kron
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::tensordot(const xexpression<T>&, const xexpression<O>&, std::size_t)
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::tensordot(const xexpression<T>&, const xexpression<O>&, const std::vector<std::size_t>&, const std::vector<std::size_t>&)
    :project: xtensor-blas

Decompositions
--------------

.. doxygenfunction:: xt::linalg::cholesky
    :project: xtensor-blas

.. doxygenenum:: xt::linalg::qrmode
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::qr
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::svd
    :project: xtensor-blas

Matrix eigenvalues
------------------

.. doxygenfunction:: xt::linalg::eig
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::eigvals
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::eigh(const xexpression<E>&, char)
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::eigh(const xexpression<E>&, const xexpression<E>&, const char)
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::eigvalsh
    :project: xtensor-blas


Norms and other numbers
-----------------------

.. doxygenenum:: xt::linalg::normorder
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::norm(const xexpression<E>&, int)
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::norm(const xexpression<E>&, normorder)
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::norm(const xexpression<E>&)
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::det(const xexpression<E>&)
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::slogdet(const xexpression<E>&)
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::matrix_rank
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::trace
    :project: xtensor-blas

Solving equations and inverting matrices
----------------------------------------

.. doxygenfunction:: xt::linalg::solve
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::lstsq
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::inv
    :project: xtensor-blas

.. doxygenfunction:: xt::linalg::pinv
    :project: xtensor-blas

Other
-----

.. doxygenfunction:: xt::linalg::cross
    :project: xtensor-blas