Changeset 172 for doc/latex/classsqmat.tex

Timestamp:

09/24/08 13:31:03 (16 years ago)

Author:

smidl

Message:

Latex doc

Files:

• doc/latex/classsqmat.tex (modified) (8 diffs)

doc/latex/classsqmat.tex

@@ +1 @@
+\hypertarget{classsqmat}{
 \section{sqmat Class Reference}
 \label{classsqmat}\index{sqmat@{sqmat}}
+}
 Virtual class for representation of double symmetric matrices in square-root form.  
 
@@ -16 +18 @@
 \begin{CompactItemize}
 \item 
-virtual void {\bf opupdt} (const vec \&v, double w)=0
+virtual void \hyperlink{classsqmat_b223484796661f2dadb5607a86ce0581}{opupdt} (const vec \&v, double w)=0
 \item 
-virtual mat {\bf to\_\-mat} ()=0\label{classsqmat_9a5b6fddfeb42339e1dc9b978a2590fc}
+\hypertarget{classsqmat_cd0ea3701e4493f353499755fba6e07f}{
+virtual mat \hyperlink{classsqmat_cd0ea3701e4493f353499755fba6e07f}{to\_\-mat} () const =0}
+\label{classsqmat_cd0ea3701e4493f353499755fba6e07f}
 
 \begin{CompactList}\small\item\em Conversion to full matrix. \item\end{CompactList}\item 
-virtual void {\bf mult\_\-sym} (const mat \&C)=0
+virtual void \hyperlink{classsqmat_60fbbfa9e483b8187c135f787ee53afa}{mult\_\-sym} (const mat \&C)=0
 \begin{CompactList}\small\item\em Inplace symmetric multiplication by a SQUARE matrix $C$, i.e. $V = C*V*C'$. \item\end{CompactList}\item 
-virtual void {\bf mult\_\-sym\_\-t} (const mat \&C)=0
+virtual void \hyperlink{classsqmat_6909e906da17725b1b80f3cae7cf3325}{mult\_\-sym\_\-t} (const mat \&C)=0
 \begin{CompactList}\small\item\em Inplace symmetric multiplication by a SQUARE transpose of matrix $C$, i.e. $V = C'*V*C$. \item\end{CompactList}\item 
-virtual double {\bf logdet} () const =0\label{classsqmat_0a772b396750eeeed85d69fa72478b45}
+\hypertarget{classsqmat_0a772b396750eeeed85d69fa72478b45}{
+virtual double \hyperlink{classsqmat_0a772b396750eeeed85d69fa72478b45}{logdet} () const =0}
+\label{classsqmat_0a772b396750eeeed85d69fa72478b45}
 
 \begin{CompactList}\small\item\em Logarithm of a determinant. \item\end{CompactList}\item 
-virtual vec {\bf sqrt\_\-mult} (const vec \&v) const =0
+virtual vec \hyperlink{classsqmat_6b79438b5d7544a9c8e110a145355d8f}{sqrt\_\-mult} (const vec \&v) const =0
 \begin{CompactList}\small\item\em Multiplies square root of $V$ by vector $x$. \item\end{CompactList}\item 
-virtual double {\bf qform} (const vec \&v) const =0\label{classsqmat_fc026312eb02ba09f85d5aacd6f05ab3}
+\hypertarget{classsqmat_fc026312eb02ba09f85d5aacd6f05ab3}{
+virtual double \hyperlink{classsqmat_fc026312eb02ba09f85d5aacd6f05ab3}{qform} (const vec \&v) const =0}
+\label{classsqmat_fc026312eb02ba09f85d5aacd6f05ab3}
 
 \begin{CompactList}\small\item\em Evaluates quadratic form $x= v'*V*v$;. \item\end{CompactList}\item 
-virtual double {\bf invqform} (const vec \&v) const =0\label{classsqmat_6230e8e8a9341866aaa0ce008691aac2}
+\hypertarget{classsqmat_6230e8e8a9341866aaa0ce008691aac2}{
+virtual double \hyperlink{classsqmat_6230e8e8a9341866aaa0ce008691aac2}{invqform} (const vec \&v) const =0}
+\label{classsqmat_6230e8e8a9341866aaa0ce008691aac2}
 
 \begin{CompactList}\small\item\em Evaluates quadratic form $x= v'*inv(V)*v$;. \item\end{CompactList}\item 
-virtual void {\bf clear} ()=0\label{classsqmat_6fca246f9eabbdeb8cac03030e826b5e}
+\hypertarget{classsqmat_6fca246f9eabbdeb8cac03030e826b5e}{
+virtual void \hyperlink{classsqmat_6fca246f9eabbdeb8cac03030e826b5e}{clear} ()=0}
+\label{classsqmat_6fca246f9eabbdeb8cac03030e826b5e}
 
 \begin{CompactList}\small\item\em Clearing matrix so that it corresponds to zeros. \item\end{CompactList}\item 
-int {\bf cols} () const \label{classsqmat_ecc2e2540f95a04f4449842588170f5b}
+\hypertarget{classsqmat_ecc2e2540f95a04f4449842588170f5b}{
+int \hyperlink{classsqmat_ecc2e2540f95a04f4449842588170f5b}{cols} () const }
+\label{classsqmat_ecc2e2540f95a04f4449842588170f5b}
 
-\begin{CompactList}\small\item\em Reimplementing common functions of mat: \doxyref{cols()}{p.}{classsqmat_ecc2e2540f95a04f4449842588170f5b}. \item\end{CompactList}\item 
-int {\bf rows} () const \label{classsqmat_071e80ced9cc3b8cbb360fa7462eb646}
+\begin{CompactList}\small\item\em Reimplementing common functions of mat: \hyperlink{classsqmat_ecc2e2540f95a04f4449842588170f5b}{cols()}. \item\end{CompactList}\item 
+\hypertarget{classsqmat_071e80ced9cc3b8cbb360fa7462eb646}{
+int \hyperlink{classsqmat_071e80ced9cc3b8cbb360fa7462eb646}{rows} () const }
+\label{classsqmat_071e80ced9cc3b8cbb360fa7462eb646}
 
-\begin{CompactList}\small\item\em Reimplementing common functions of mat: \doxyref{cols()}{p.}{classsqmat_ecc2e2540f95a04f4449842588170f5b}. \item\end{CompactList}\item 
-virtual {\bf $\sim$sqmat} ()\label{classsqmat_0481f2067bb32aaea7e6d4f27e46b656}
+\begin{CompactList}\small\item\em Reimplementing common functions of mat: \hyperlink{classsqmat_ecc2e2540f95a04f4449842588170f5b}{cols()}. \item\end{CompactList}\item 
+\hypertarget{classsqmat_0481f2067bb32aaea7e6d4f27e46b656}{
+virtual \hyperlink{classsqmat_0481f2067bb32aaea7e6d4f27e46b656}{$\sim$sqmat} ()}
+\label{classsqmat_0481f2067bb32aaea7e6d4f27e46b656}
 
 \begin{CompactList}\small\item\em Destructor for future use;. \item\end{CompactList}\item 
-{\bf sqmat} (const int dim0)\label{classsqmat_4268750c040c716b2c05037f725078a2}
+\hypertarget{classsqmat_4268750c040c716b2c05037f725078a2}{
+\hyperlink{classsqmat_4268750c040c716b2c05037f725078a2}{sqmat} (const int dim0)}
+\label{classsqmat_4268750c040c716b2c05037f725078a2}
 
 \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\end{CompactItemize}
@@ -54 +74 @@
 \begin{CompactItemize}
 \item 
-int {\bf dim}\label{classsqmat_0abed904bdc0882373ba9adba919689d}
+\hypertarget{classsqmat_0abed904bdc0882373ba9adba919689d}{
+int \hyperlink{classsqmat_0abed904bdc0882373ba9adba919689d}{dim}}
+\label{classsqmat_0abed904bdc0882373ba9adba919689d}
 
 \begin{CompactList}\small\item\em dimension of the square matrix \item\end{CompactList}\end{CompactItemize}
@@ -65 +87 @@
 
 \subsection{Member Function Documentation}
+\hypertarget{classsqmat_b223484796661f2dadb5607a86ce0581}{
 \index{sqmat@{sqmat}!opupdt@{opupdt}}
 \index{opupdt@{opupdt}!sqmat@{sqmat}}
-\subsubsection[opupdt]{\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}
+\subsubsection[opupdt]{\setlength{\rightskip}{0pt plus 5cm}virtual void sqmat::opupdt (const vec \& {\em v}, \/  double {\em w})\hspace{0.3cm}{\tt  \mbox{[}pure virtual\mbox{]}}}}
+\label{classsqmat_b223484796661f2dadb5607a86ce0581}
 
 
@@ -77 +101 @@
 BLAS-2b operation. 
 
-Implemented in {\bf chmat} \doxyref{}{p.}{classchmat_bbc2d98d7455b1f38828907d442836bf}, {\bf fsqmat} \doxyref{}{p.}{classfsqmat_b36530e155667fe9f1bd58394e50c65a}, and {\bf ldmat} \doxyref{}{p.}{classldmat_0f0f6e083e6d947cf58097ffce3ccd1a}.\index{sqmat@{sqmat}!mult\_\-sym@{mult\_\-sym}}
+Implemented in \hyperlink{classchmat_bbc2d98d7455b1f38828907d442836bf}{chmat}, \hyperlink{classfsqmat_b36530e155667fe9f1bd58394e50c65a}{fsqmat}, and \hyperlink{classldmat_0f0f6e083e6d947cf58097ffce3ccd1a}{ldmat}.\hypertarget{classsqmat_60fbbfa9e483b8187c135f787ee53afa}{
+\index{sqmat@{sqmat}!mult\_\-sym@{mult\_\-sym}}
 \index{mult\_\-sym@{mult\_\-sym}!sqmat@{sqmat}}
-\subsubsection[mult\_\-sym]{\setlength{\rightskip}{0pt plus 5cm}virtual void sqmat::mult\_\-sym (const mat \& {\em C})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classsqmat_60fbbfa9e483b8187c135f787ee53afa}
+\subsubsection[mult\_\-sym]{\setlength{\rightskip}{0pt plus 5cm}virtual void sqmat::mult\_\-sym (const mat \& {\em C})\hspace{0.3cm}{\tt  \mbox{[}pure virtual\mbox{]}}}}
+\label{classsqmat_60fbbfa9e483b8187c135f787ee53afa}
 
 
@@ -91 +117 @@
 
 
-Implemented in {\bf chmat} \doxyref{}{p.}{classchmat_66f509f92b0ccf020e2a2a32566e0777}, {\bf fsqmat} \doxyref{}{p.}{classfsqmat_5530d2756b5d991de755e6121c9a452e}, and {\bf ldmat} \doxyref{}{p.}{classldmat_e967b9425007f0cb6cd59b845f9756d8}.\index{sqmat@{sqmat}!mult\_\-sym\_\-t@{mult\_\-sym\_\-t}}
+Implemented in \hyperlink{classchmat_66f509f92b0ccf020e2a2a32566e0777}{chmat}, \hyperlink{classfsqmat_5530d2756b5d991de755e6121c9a452e}{fsqmat}, and \hyperlink{classldmat_e967b9425007f0cb6cd59b845f9756d8}{ldmat}.\hypertarget{classsqmat_6909e906da17725b1b80f3cae7cf3325}{
+\index{sqmat@{sqmat}!mult\_\-sym\_\-t@{mult\_\-sym\_\-t}}
 \index{mult\_\-sym\_\-t@{mult\_\-sym\_\-t}!sqmat@{sqmat}}
-\subsubsection[mult\_\-sym\_\-t]{\setlength{\rightskip}{0pt plus 5cm}virtual void sqmat::mult\_\-sym\_\-t (const mat \& {\em C})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classsqmat_6909e906da17725b1b80f3cae7cf3325}
+\subsubsection[mult\_\-sym\_\-t]{\setlength{\rightskip}{0pt plus 5cm}virtual void sqmat::mult\_\-sym\_\-t (const mat \& {\em C})\hspace{0.3cm}{\tt  \mbox{[}pure virtual\mbox{]}}}}
+\label{classsqmat_6909e906da17725b1b80f3cae7cf3325}
 
 
@@ -105 +133 @@
 
 
-Implemented in {\bf chmat} \doxyref{}{p.}{classchmat_07f50d1332b901eee962e8b1913102f7}, {\bf fsqmat} \doxyref{}{p.}{classfsqmat_92052a8adc2054b63e42d1373d145c89}, and {\bf ldmat} \doxyref{}{p.}{classldmat_4fd155f38eb6dd5af4bdf9c98a7999a9}.\index{sqmat@{sqmat}!sqrt\_\-mult@{sqrt\_\-mult}}
+Implemented in \hyperlink{classchmat_07f50d1332b901eee962e8b1913102f7}{chmat}, \hyperlink{classfsqmat_92052a8adc2054b63e42d1373d145c89}{fsqmat}, and \hyperlink{classldmat_4fd155f38eb6dd5af4bdf9c98a7999a9}{ldmat}.\hypertarget{classsqmat_6b79438b5d7544a9c8e110a145355d8f}{
+\index{sqmat@{sqmat}!sqrt\_\-mult@{sqrt\_\-mult}}
 \index{sqrt\_\-mult@{sqrt\_\-mult}!sqmat@{sqmat}}
-\subsubsection[sqrt\_\-mult]{\setlength{\rightskip}{0pt plus 5cm}virtual vec sqmat::sqrt\_\-mult (const vec \& {\em v}) const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classsqmat_6b79438b5d7544a9c8e110a145355d8f}
+\subsubsection[sqrt\_\-mult]{\setlength{\rightskip}{0pt plus 5cm}virtual vec sqmat::sqrt\_\-mult (const vec \& {\em v}) const\hspace{0.3cm}{\tt  \mbox{[}pure virtual\mbox{]}}}}
+\label{classsqmat_6b79438b5d7544a9c8e110a145355d8f}
 
 
@@ -114 +144 @@
 Used e.g. in generating normal samples. 
 
-Implemented in {\bf chmat} \doxyref{}{p.}{classchmat_b22aa239dbaca33e3fb93b4f674d7051}, {\bf fsqmat} \doxyref{}{p.}{classfsqmat_842a774077ee34ac3c36d180ab33e103}, and {\bf ldmat} \doxyref{}{p.}{classldmat_fc380626ced6f9244fb58c5f0231174d}.
+Implemented in \hyperlink{classchmat_b22aa239dbaca33e3fb93b4f674d7051}{chmat}, \hyperlink{classfsqmat_842a774077ee34ac3c36d180ab33e103}{fsqmat}, and \hyperlink{classldmat_fc380626ced6f9244fb58c5f0231174d}{ldmat}.
 
 The documentation for this class was generated from the following file:\begin{CompactItemize}
 \item 
-work/git/mixpp/bdm/math/{\bf libDC.h}\end{CompactItemize}
+work/git/mixpp/bdm/math/\hyperlink{libDC_8h}{libDC.h}\end{CompactItemize}