Changeset 22 for doc/latex/classfsqmat.tex

Timestamp:

02/18/08 17:50:37 (16 years ago)

Author:

smidl

Message:

upravy Kalmana

Files:

• doc/latex/classfsqmat.tex (modified) (2 diffs)

doc/latex/classfsqmat.tex

@@ -20 +20 @@
 \end{center}
 \end{figure}
+\subsection*{Public Member Functions}
+\begin{CompactItemize}
+\item 
+void {\bf opupdt} (const vec \&v, double w)
+\item 
+mat {\bf to\_\-mat} ()\label{classfsqmat_cedf4f048309056f4262c930914dfda8}
+
+\begin{CompactList}\small\item\em Conversion to full matrix. \item\end{CompactList}\item 
+void {\bf mult\_\-sym} (const mat \&C, bool trans=false)
+\begin{CompactList}\small\item\em Inplace symmetric multiplication by a SQUARE matrix \$C\$, i.e. \$V = C$\ast$V$\ast$C'\$. \item\end{CompactList}\item 
+void \textbf{mult\_\-sym} (const mat \&C, {\bf fsqmat} \&U, bool trans=false)\label{classfsqmat_ccf5ad8fb038f82e9d2201c0606b65fa}
+
+\item 
+void \textbf{inv} ({\bf fsqmat} \&Inv)\label{classfsqmat_9fa853e1ca28f2a1a1c43377e798ecb1}
+
+\item 
+void {\bf clear} ()\label{classfsqmat_cfa4c359483d2322f32d1d50050f8ac4}
+
+\begin{CompactList}\small\item\em Clearing matrix so that it corresponds to zeros. \item\end{CompactList}\item 
+{\bf fsqmat} (const mat \&M)\label{classfsqmat_1929fbc9fe375f1d67f979d0d302336f}
+
+\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
+virtual void {\bf inv} ({\bf fsqmat} $\ast$Inv)
+\begin{CompactList}\small\item\em Matrix inversion preserving the chosen form. \item\end{CompactList}\item 
+double {\bf logdet} ()\label{classfsqmat_bf212272ec195ad2706e2bf4d8e7c9b3}
+
+\begin{CompactList}\small\item\em Logarithm of a determinant. \item\end{CompactList}\item 
+double {\bf qform} (vec \&v)\label{classfsqmat_6d047b9f7a27dfc093303a13cc9b1fba}
+
+\begin{CompactList}\small\item\em Evaluates quadratic form \$x= v'$\ast$V$\ast$v\$;. \item\end{CompactList}\item 
+vec {\bf sqrt\_\-mult} (vec \&v)
+\begin{CompactList}\small\item\em Multiplies square root of \$V\$ by vector \$x\$. \item\end{CompactList}\item 
+{\bf fsqmat} \& \textbf{operator+=} (const {\bf fsqmat} \&A)\label{classfsqmat_514d1fdd8a382dbd6a774f2cf1ebd3de}
+
+\item 
+{\bf fsqmat} \& \textbf{operator-=} (const {\bf fsqmat} \&A)\label{classfsqmat_e976bc9d899961e1d2087b0630ed33b7}
+
+\item 
+{\bf fsqmat} \& \textbf{operator $\ast$=} (double x)\label{classfsqmat_8f7ce97628a50e06641281096b2af9b7}
+
+\end{CompactItemize}
+\subsection*{Protected Attributes}
+\begin{CompactItemize}
+\item 
+mat \textbf{M}\label{classfsqmat_a7a1fcb9aae19d1e4daddfc9c22ce453}
+
+\end{CompactItemize}
 
 
@@ -27 +74 @@
 This class can be used to compare performance of algorithms using decomposed matrices with perormance of the same algorithms using full matrices; 
 
+\subsection{Member Function Documentation}
+\index{fsqmat@{fsqmat}!opupdt@{opupdt}}
+\index{opupdt@{opupdt}!fsqmat@{fsqmat}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void fsqmat::opupdt (const vec \& {\em v}, double {\em w})\hspace{0.3cm}{\tt  [virtual]}}\label{classfsqmat_b36530e155667fe9f1bd58394e50c65a}
+
+
+Perfroms a rank-1 update by outer product of vectors: \$V = V + w v v'\$. \begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em v}]Vector forming the outer product to be added \item[{\em w}]weight of updating; can be negative\end{description}
+\end{Desc}
+BLAS-2b operation. 
+
+Implements {\bf sqmat} \doxyref{}{p.}{classsqmat_b223484796661f2dadb5607a86ce0581}.\index{fsqmat@{fsqmat}!mult_sym@{mult\_\-sym}}
+\index{mult_sym@{mult\_\-sym}!fsqmat@{fsqmat}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void fsqmat::mult\_\-sym (const mat \& {\em C}, bool {\em trans} = {\tt false})\hspace{0.3cm}{\tt  [virtual]}}\label{classfsqmat_acc5d2d0a243f1de6d0106065f01f518}
+
+
+Inplace symmetric multiplication by a SQUARE matrix \$C\$, i.e. \$V = C$\ast$V$\ast$C'\$. 
+
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em C}]multiplying matrix, \item[{\em trans}]if true, product \$V = C'$\ast$V$\ast$C\$ will be computed instead; \end{description}
+\end{Desc}
+
+
+Implements {\bf sqmat} \doxyref{}{p.}{classsqmat_faa3bc90be142adde9cf74f573c70157}.\index{fsqmat@{fsqmat}!inv@{inv}}
+\index{inv@{inv}!fsqmat@{fsqmat}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void fsqmat::inv ({\bf fsqmat} $\ast$ {\em Inv})\hspace{0.3cm}{\tt  [virtual]}}\label{classfsqmat_788423cc2679620dd6da8d2fca2e3e4d}
+
+
+Matrix inversion preserving the chosen form. 
+
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em Inv}]a space where the inverse is stored. \end{description}
+\end{Desc}
+\index{fsqmat@{fsqmat}!sqrt_mult@{sqrt\_\-mult}}
+\index{sqrt_mult@{sqrt\_\-mult}!fsqmat@{fsqmat}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}vec fsqmat::sqrt\_\-mult (vec \& {\em v})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classfsqmat_6648dd4291b809cce14e8497d0433ad3}
+
+
+Multiplies square root of \$V\$ by vector \$x\$. 
+
+Used e.g. in generating normal samples. 
+
+Implements {\bf sqmat} \doxyref{}{p.}{classsqmat_b5236c8a050199e1a9d338b0da1a08d2}.
+
 The documentation for this class was generated from the following file:\begin{CompactItemize}
 \item