root/doc/latex/classsqmat.tex @ 21

\section{sqmat Class Reference}
\label{classsqmat}\index{sqmat@{sqmat}}
Virtual class for representation of double symmetric matrices in square-root form.  


{\tt \#include $<$libDC.h$>$}

Inheritance diagram for sqmat:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=78pt]{classsqmat__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf opupdt} (const vec \&v, double w)=0
\item 
virtual mat {\bf to\_\-mat} ()=0\label{classsqmat_9a5b6fddfeb42339e1dc9b978a2590fc}

\begin{CompactList}\small\item\em Conversion to full matrix. \item\end{CompactList}\item 
virtual void {\bf mult\_\-sym} (const mat \&C, bool trans=true)=0
\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 
virtual double {\bf logdet} ()=0\label{classsqmat_5c852819589f74cdaefbd648c0ce8547}

\begin{CompactList}\small\item\em Logarithm of a determinant. \item\end{CompactList}\item 
virtual vec {\bf sqrt\_\-mult} (vec \&v)=0
\begin{CompactList}\small\item\em Multiplies square root of \$V\$ by vector \$x\$. \item\end{CompactList}\item 
virtual double {\bf qform} (vec \&v)=0\label{classsqmat_44e079468bc8bfccf634dc85b32ba6be}

\begin{CompactList}\small\item\em Evaluates quadratic form \$x= v'$\ast$V$\ast$v\$;. \item\end{CompactList}\item 
virtual void {\bf clear} ()=0\label{classsqmat_6fca246f9eabbdeb8cac03030e826b5e}

\begin{CompactList}\small\item\em Clearing matrix so that it corresponds to zeros. \item\end{CompactList}\item 
virtual int {\bf cols} ()=0\label{classsqmat_743d3799d9e73403230c54e14ecf09ed}

\begin{CompactList}\small\item\em Reimplementing common functions of mat: \doxyref{cols()}{p.}{classsqmat_743d3799d9e73403230c54e14ecf09ed}. \item\end{CompactList}\item 
virtual int {\bf rows} ()=0\label{classsqmat_f59664a4be09450f8c6ce3f5e5ab2dc7}

\begin{CompactList}\small\item\em Reimplementing common functions of mat: \doxyref{cols()}{p.}{classsqmat_743d3799d9e73403230c54e14ecf09ed}. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
int \textbf{dim}\label{classsqmat_0abed904bdc0882373ba9adba919689d}

\end{CompactItemize}


\subsection{Detailed Description}
Virtual class for representation of double symmetric matrices in square-root form. 

All operations defined on this class should be optimized for the chosed decomposition. 

\subsection{Member Function Documentation}
\index{sqmat@{sqmat}!opupdt@{opupdt}}
\index{opupdt@{opupdt}!sqmat@{sqmat}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void sqmat::opupdt (const vec \& {\em v}, double {\em w})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classsqmat_b223484796661f2dadb5607a86ce0581}


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. \index{sqmat@{sqmat}!mult_sym@{mult\_\-sym}}
\index{mult_sym@{mult\_\-sym}!sqmat@{sqmat}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void sqmat::mult\_\-sym (const mat \& {\em C}, bool {\em trans} = {\tt true})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classsqmat_faa3bc90be142adde9cf74f573c70157}


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}
\index{sqmat@{sqmat}!sqrt_mult@{sqrt\_\-mult}}
\index{sqrt_mult@{sqrt\_\-mult}!sqmat@{sqmat}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual vec sqmat::sqrt\_\-mult (vec \& {\em v})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classsqmat_b5236c8a050199e1a9d338b0da1a08d2}


Multiplies square root of \$V\$ by vector \$x\$. 

Used e.g. in generating normal samples. 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
work/mixpp/bdm/math/{\bf libDC.h}\end{CompactItemize}