1[/
2
3THIS FILE IS AUTOMATICALLY GENERATED, PLEASE DO NOT EDIT!
4
5]
6
7[section sytrd]
8
9[heading Prototype]
10There is one prototype of `sytrd` available, please see below.
11``
12sytrd( MatrixA& a, VectorD& d, VectorE& e, VectorTAU& tau );
13``
14
15
16[heading Description]
17
18`sytrd` (short for $FRIENDLY_NAME) provides a C++
19interface to LAPACK routines SSYTRD and DSYTRD.
20`sytrd` reduces a real symmetric matrix A to real symmetric
21tridiagonal form T by an orthogonal similarity transformation:
22Q**T * A * Q = T.
23
24The selection of the LAPACK routine is done during compile-time,
25and is determined by the type of values contained in type `MatrixA`.
26The type of values is obtained through the `value_type` meta-function
27 `typename value_type<MatrixA>::type`.
28The dispatching table below illustrates to which specific routine
29the code path will be generated.
30
31[table Dispatching of sytrd
32[  [ Value type of MatrixA ] [LAPACK routine] ]
33[  [`float`][SSYTRD] ]
34[  [`double`][DSYTRD] ]
35
36]
37
38
39[heading Definition]
40Defined in header [headerref boost/numeric/bindings/lapack/computational/sytrd.hpp].
41
42
43[heading Parameters or Requirements on Types]
44
45[variablelist Parameters
46    [[MatrixA] [The definition of term 1]]
47    [[MatrixB] [The definition of term 2]]
48    [[MatrixC] [
49    The definition of term 3.
50
51    Definitions may contain paragraphs.
52    ]]
53]
54
55
56[heading Complexity]
57
58
59[heading Example]
60``
61#include <boost/numeric/bindings/lapack/computational/sytrd.hpp>
62using namespace boost::numeric::bindings;
63
64lapack::sytrd( x, y, z );
65
66``
67
68this will output
69
70``
71[5] 0 1 2 3 4 5
72``
73
74
75
76[heading Notes]
77
78
79[heading See Also]
80
81* Originating Fortran source files [@http://www.netlib.org/lapack/single/ssytrd.f ssytrd.f] and [@http://www.netlib.org/lapack/double/dsytrd.f dsytrd.f] at Netlib.
82
83[endsect]
84