1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
---|
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
---|
3 | <title>mixpp: sqmat Class Reference</title> |
---|
4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
---|
5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
---|
6 | </head><body> |
---|
7 | <!-- Generated by Doxygen 1.5.3 --> |
---|
8 | <div class="tabs"> |
---|
9 | <ul> |
---|
10 | <li><a href="index.html"><span>Main Page</span></a></li> |
---|
11 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
---|
12 | <li><a href="files.html"><span>Files</span></a></li> |
---|
13 | </ul> |
---|
14 | </div> |
---|
15 | <div class="tabs"> |
---|
16 | <ul> |
---|
17 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
18 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
19 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
20 | </ul> |
---|
21 | </div> |
---|
22 | <h1>sqmat Class Reference</h1><!-- doxytag: class="sqmat" -->Virtual class for representation of double symmetric matrices in square-root form. |
---|
23 | <a href="#_details">More...</a> |
---|
24 | <p> |
---|
25 | <code>#include <<a class="el" href="libDC_8h-source.html">libDC.h</a>></code> |
---|
26 | <p> |
---|
27 | <div class="dynheader"> |
---|
28 | Inheritance diagram for sqmat:</div> |
---|
29 | <div class="dynsection"> |
---|
30 | |
---|
31 | <p><center><img src="classsqmat.png" usemap="#sqmat_map" border="0" alt=""></center> |
---|
32 | <map name="sqmat_map"> |
---|
33 | <area href="classfsqmat.html" alt="fsqmat" shape="rect" coords="0,56,47,80"> |
---|
34 | </map> |
---|
35 | </div> |
---|
36 | |
---|
37 | <p> |
---|
38 | <a href="classsqmat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
39 | <tr><td></td></tr> |
---|
40 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
41 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#b223484796661f2dadb5607a86ce0581">opupdt</a> (const vec &v, double w)=0</td></tr> |
---|
42 | |
---|
43 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a5b6fddfeb42339e1dc9b978a2590fc"></a><!-- doxytag: member="sqmat::to_mat" ref="9a5b6fddfeb42339e1dc9b978a2590fc" args="()=0" --> |
---|
44 | virtual mat </td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#9a5b6fddfeb42339e1dc9b978a2590fc">to_mat</a> ()=0</td></tr> |
---|
45 | |
---|
46 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Conversion to full matrix. <br></td></tr> |
---|
47 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#faa3bc90be142adde9cf74f573c70157">mult_sym</a> (const mat &C, bool trans=true)=0</td></tr> |
---|
48 | |
---|
49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Inplace symmetric multiplication by a SQUARE matrix $C$, i.e. $V = C*V*C'$. <a href="#faa3bc90be142adde9cf74f573c70157"></a><br></td></tr> |
---|
50 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5c852819589f74cdaefbd648c0ce8547"></a><!-- doxytag: member="sqmat::logdet" ref="5c852819589f74cdaefbd648c0ce8547" args="()=0" --> |
---|
51 | virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#5c852819589f74cdaefbd648c0ce8547">logdet</a> ()=0</td></tr> |
---|
52 | |
---|
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Logarithm of a determinant. <br></td></tr> |
---|
54 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44e079468bc8bfccf634dc85b32ba6be"></a><!-- doxytag: member="sqmat::qform" ref="44e079468bc8bfccf634dc85b32ba6be" args="(vec &v)=0" --> |
---|
55 | virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#44e079468bc8bfccf634dc85b32ba6be">qform</a> (vec &v)=0</td></tr> |
---|
56 | |
---|
57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Evaluates quadratic form $x= v'*V*v$;. <br></td></tr> |
---|
58 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fca246f9eabbdeb8cac03030e826b5e"></a><!-- doxytag: member="sqmat::clear" ref="6fca246f9eabbdeb8cac03030e826b5e" args="()=0" --> |
---|
59 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#6fca246f9eabbdeb8cac03030e826b5e">clear</a> ()=0</td></tr> |
---|
60 | |
---|
61 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br></td></tr> |
---|
62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="743d3799d9e73403230c54e14ecf09ed"></a><!-- doxytag: member="sqmat::cols" ref="743d3799d9e73403230c54e14ecf09ed" args="()=0" --> |
---|
63 | virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#743d3799d9e73403230c54e14ecf09ed">cols</a> ()=0</td></tr> |
---|
64 | |
---|
65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classsqmat.html#743d3799d9e73403230c54e14ecf09ed" title="Reimplementing common functions of mat: cols().">cols()</a>. <br></td></tr> |
---|
66 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f59664a4be09450f8c6ce3f5e5ab2dc7"></a><!-- doxytag: member="sqmat::rows" ref="f59664a4be09450f8c6ce3f5e5ab2dc7" args="()=0" --> |
---|
67 | virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#f59664a4be09450f8c6ce3f5e5ab2dc7">rows</a> ()=0</td></tr> |
---|
68 | |
---|
69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classsqmat.html#743d3799d9e73403230c54e14ecf09ed" title="Reimplementing common functions of mat: cols().">cols()</a>. <br></td></tr> |
---|
70 | <tr><td colspan="2"><br><h2>Friends</h2></td></tr> |
---|
71 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9eb5aa871432ddb9c5a45ddbbb19eab"></a><!-- doxytag: member="sqmat::operator<<" ref="c9eb5aa871432ddb9c5a45ddbbb19eab" args="(std::ostream &os, sqmat &sq)" --> |
---|
72 | std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &os, <a class="el" href="classsqmat.html">sqmat</a> &sq)</td></tr> |
---|
73 | |
---|
74 | </table> |
---|
75 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
76 | Virtual class for representation of double symmetric matrices in square-root form. |
---|
77 | <p> |
---|
78 | All operations defined on this class should be optimized for the chosed decomposition. <hr><h2>Member Function Documentation</h2> |
---|
79 | <a class="anchor" name="b223484796661f2dadb5607a86ce0581"></a><!-- doxytag: member="sqmat::opupdt" ref="b223484796661f2dadb5607a86ce0581" args="(const vec &v, double w)=0" --> |
---|
80 | <div class="memitem"> |
---|
81 | <div class="memproto"> |
---|
82 | <table class="memname"> |
---|
83 | <tr> |
---|
84 | <td class="memname">virtual void sqmat::opupdt </td> |
---|
85 | <td>(</td> |
---|
86 | <td class="paramtype">const vec & </td> |
---|
87 | <td class="paramname"> <em>v</em>, </td> |
---|
88 | </tr> |
---|
89 | <tr> |
---|
90 | <td class="paramkey"></td> |
---|
91 | <td></td> |
---|
92 | <td class="paramtype">double </td> |
---|
93 | <td class="paramname"> <em>w</em></td><td> </td> |
---|
94 | </tr> |
---|
95 | <tr> |
---|
96 | <td></td> |
---|
97 | <td>)</td> |
---|
98 | <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> |
---|
99 | </tr> |
---|
100 | </table> |
---|
101 | </div> |
---|
102 | <div class="memdoc"> |
---|
103 | |
---|
104 | <p> |
---|
105 | Perfroms a rank-1 update by outer product of vectors: $V = V + w v v'$. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
106 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
107 | <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>Vector forming the outer product to be added </td></tr> |
---|
108 | <tr><td valign="top"></td><td valign="top"><em>w</em> </td><td>weight of updating; can be negative</td></tr> |
---|
109 | </table> |
---|
110 | </dl> |
---|
111 | BLAS-2b operation. |
---|
112 | </div> |
---|
113 | </div><p> |
---|
114 | <a class="anchor" name="faa3bc90be142adde9cf74f573c70157"></a><!-- doxytag: member="sqmat::mult_sym" ref="faa3bc90be142adde9cf74f573c70157" args="(const mat &C, bool trans=true)=0" --> |
---|
115 | <div class="memitem"> |
---|
116 | <div class="memproto"> |
---|
117 | <table class="memname"> |
---|
118 | <tr> |
---|
119 | <td class="memname">virtual void sqmat::mult_sym </td> |
---|
120 | <td>(</td> |
---|
121 | <td class="paramtype">const mat & </td> |
---|
122 | <td class="paramname"> <em>C</em>, </td> |
---|
123 | </tr> |
---|
124 | <tr> |
---|
125 | <td class="paramkey"></td> |
---|
126 | <td></td> |
---|
127 | <td class="paramtype">bool </td> |
---|
128 | <td class="paramname"> <em>trans</em> = <code>true</code></td><td> </td> |
---|
129 | </tr> |
---|
130 | <tr> |
---|
131 | <td></td> |
---|
132 | <td>)</td> |
---|
133 | <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> |
---|
134 | </tr> |
---|
135 | </table> |
---|
136 | </div> |
---|
137 | <div class="memdoc"> |
---|
138 | |
---|
139 | <p> |
---|
140 | Inplace symmetric multiplication by a SQUARE matrix $C$, i.e. $V = C*V*C'$. |
---|
141 | <p> |
---|
142 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
143 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
144 | <tr><td valign="top"></td><td valign="top"><em>C</em> </td><td>multiplying matrix, </td></tr> |
---|
145 | <tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>if true, product $V = C'*V*C$ will be computed instead; </td></tr> |
---|
146 | </table> |
---|
147 | </dl> |
---|
148 | |
---|
149 | </div> |
---|
150 | </div><p> |
---|
151 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
152 | <li>work/mixpp/<a class="el" href="libDC_8h-source.html">libDC.h</a></ul> |
---|
153 | <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jan 23 11:30:12 2008 for mixpp by |
---|
154 | <a href="http://www.doxygen.org/index.html"> |
---|
155 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
---|
156 | </body> |
---|
157 | </html> |
---|