diff options
Diffstat (limited to 'doc/latex/classmeow_1_1LinearTransformation.tex')
-rw-r--r-- | doc/latex/classmeow_1_1LinearTransformation.tex | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/doc/latex/classmeow_1_1LinearTransformation.tex b/doc/latex/classmeow_1_1LinearTransformation.tex new file mode 100644 index 0000000..b44110b --- /dev/null +++ b/doc/latex/classmeow_1_1LinearTransformation.tex @@ -0,0 +1,188 @@ +\hypertarget{classmeow_1_1LinearTransformation}{\section{meow\-:\-:Linear\-Transformation$<$ Scalar $>$ Class Template Reference} +\label{classmeow_1_1LinearTransformation}\index{meow\-::\-Linear\-Transformation$<$ Scalar $>$@{meow\-::\-Linear\-Transformation$<$ Scalar $>$}} +} + + +A base class for implementing kinds of linear transformations. + + + + +{\ttfamily \#include \char`\"{}Linear\-Transformation.\-h\char`\"{}} + +Inheritance diagram for meow\-:\-:Linear\-Transformation$<$ Scalar $>$\-:\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=3.000000cm]{classmeow_1_1LinearTransformation} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +virtual \hyperlink{classmeow_1_1LinearTransformation_ad21d0eb275d3ac9ce780e4ccf2c78bcb}{$\sim$\-Linear\-Transformation} () +\item +virtual \hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$ const \& \hyperlink{classmeow_1_1LinearTransformation_aeab1cf88fc67a1857504bd2fb18519f5}{matrix} () const +\begin{DoxyCompactList}\small\item\em Return the matrix form of this transformation. \end{DoxyCompactList}\item +virtual \hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$ \hyperlink{classmeow_1_1LinearTransformation_a60ead2898f321c5d77d099e1dc3e103c}{matrix\-Inv} () const +\begin{DoxyCompactList}\small\item\em Return the inverse of the matrix form of this transformate. \end{DoxyCompactList}\end{DoxyCompactItemize} +\subsection*{Protected Member Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{classmeow_1_1LinearTransformation_a2c5d98a8bf1dc09c9284d40db9534a6e}{Linear\-Transformation} (size\-\_\-t \hyperlink{classmeow_1_1Transformation_a9c4d19fe8d95967596b06bc026bdf200}{input\-Rows}, size\-\_\-t \hyperlink{classmeow_1_1Transformation_aae50028aba551ad3459335299794f8af}{output\-Rows}, size\-\_\-t psize) +\item +\hyperlink{classmeow_1_1LinearTransformation_a799ed3fafc41010b87807b46e9b9c222}{Linear\-Transformation} (size\-\_\-t \hyperlink{classmeow_1_1Transformation_a9c4d19fe8d95967596b06bc026bdf200}{input\-Rows}, size\-\_\-t \hyperlink{classmeow_1_1Transformation_aae50028aba551ad3459335299794f8af}{output\-Rows}, size\-\_\-t psize, \hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$ const \&m) +\item +\hyperlink{classmeow_1_1LinearTransformation_a4d73d74510c76bdbe176a8d498be185e}{Linear\-Transformation} (\hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} const \&b) +\item +\hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} \& \hyperlink{classmeow_1_1LinearTransformation_afb3ea3e2653152b7b5a8bbad952d3f0e}{copy\-From} (\hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} const \&b) +\begin{DoxyCompactList}\small\item\em Copy settings, matrix from another \hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation}. \end{DoxyCompactList}\item +\hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} \& \hyperlink{classmeow_1_1LinearTransformation_a573c034e179570f7a1c41f0c1de54c87}{reference\-From} (\hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} const \&b) +\begin{DoxyCompactList}\small\item\em Reference settings, matrix from another \hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation}. \end{DoxyCompactList}\item +\hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$ const \& \hyperlink{classmeow_1_1LinearTransformation_a9227417bd74bb950e1c732e5948befc0}{matrix} (\hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$ const \&m) +\begin{DoxyCompactList}\small\item\em Setup the matrix. \end{DoxyCompactList}\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +\subsubsection*{template$<$class Scalar$>$class meow\-::\-Linear\-Transformation$<$ Scalar $>$} + +A base class for implementing kinds of linear transformations. + +Because all linear transformations belong to transformations, this class inherit to \hyperlink{classmeow_1_1Transformation}{Transformation}. + +\begin{DoxyAuthor}{Author} +cat\-\_\-leopard +\end{DoxyAuthor} + + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classmeow_1_1LinearTransformation_a2c5d98a8bf1dc09c9284d40db9534a6e}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!Linear\-Transformation@{Linear\-Transformation}} +\index{Linear\-Transformation@{Linear\-Transformation}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{Linear\-Transformation}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::{\bf Linear\-Transformation} ( +\begin{DoxyParamCaption} +\item[{size\-\_\-t}]{input\-Rows, } +\item[{size\-\_\-t}]{output\-Rows, } +\item[{size\-\_\-t}]{psize} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}}\label{classmeow_1_1LinearTransformation_a2c5d98a8bf1dc09c9284d40db9534a6e} +Constructor with input/output size gived \hypertarget{classmeow_1_1LinearTransformation_a799ed3fafc41010b87807b46e9b9c222}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!Linear\-Transformation@{Linear\-Transformation}} +\index{Linear\-Transformation@{Linear\-Transformation}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{Linear\-Transformation}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::{\bf Linear\-Transformation} ( +\begin{DoxyParamCaption} +\item[{size\-\_\-t}]{input\-Rows, } +\item[{size\-\_\-t}]{output\-Rows, } +\item[{size\-\_\-t}]{psize, } +\item[{{\bf Matrix}$<$ Scalar $>$ const \&}]{m} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}}\label{classmeow_1_1LinearTransformation_a799ed3fafc41010b87807b46e9b9c222} +Constructor with input/output size gived and a inital matrix \hypertarget{classmeow_1_1LinearTransformation_a4d73d74510c76bdbe176a8d498be185e}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!Linear\-Transformation@{Linear\-Transformation}} +\index{Linear\-Transformation@{Linear\-Transformation}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{Linear\-Transformation}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::{\bf Linear\-Transformation} ( +\begin{DoxyParamCaption} +\item[{{\bf Linear\-Transformation}$<$ Scalar $>$ const \&}]{b} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}}\label{classmeow_1_1LinearTransformation_a4d73d74510c76bdbe176a8d498be185e} +Constructor with another \hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} + + +\begin{DoxyParams}[1]{Parameters} +\mbox{\tt in} & {\em b} & another \hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} \\ +\hline +\end{DoxyParams} +\hypertarget{classmeow_1_1LinearTransformation_ad21d0eb275d3ac9ce780e4ccf2c78bcb}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!$\sim$\-Linear\-Transformation@{$\sim$\-Linear\-Transformation}} +\index{$\sim$\-Linear\-Transformation@{$\sim$\-Linear\-Transformation}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{$\sim$\-Linear\-Transformation}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ virtual {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::$\sim${\bf Linear\-Transformation} ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{classmeow_1_1LinearTransformation_ad21d0eb275d3ac9ce780e4ccf2c78bcb} +Destructor + +\subsection{Member Function Documentation} +\hypertarget{classmeow_1_1LinearTransformation_afb3ea3e2653152b7b5a8bbad952d3f0e}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!copy\-From@{copy\-From}} +\index{copy\-From@{copy\-From}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{copy\-From}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf Linear\-Transformation}\& {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::copy\-From ( +\begin{DoxyParamCaption} +\item[{{\bf Linear\-Transformation}$<$ Scalar $>$ const \&}]{b} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}}\label{classmeow_1_1LinearTransformation_afb3ea3e2653152b7b5a8bbad952d3f0e} + + +Copy settings, matrix from another \hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation}. + + +\begin{DoxyParams}[1]{Parameters} +\mbox{\tt in} & {\em b} & another \hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} \\ +\hline +\end{DoxyParams} +\hypertarget{classmeow_1_1LinearTransformation_a9227417bd74bb950e1c732e5948befc0}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!matrix@{matrix}} +\index{matrix@{matrix}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{matrix}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf Matrix}$<$Scalar$>$ const\& {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::matrix ( +\begin{DoxyParamCaption} +\item[{{\bf Matrix}$<$ Scalar $>$ const \&}]{m} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}}\label{classmeow_1_1LinearTransformation_a9227417bd74bb950e1c732e5948befc0} + + +Setup the matrix. + + +\begin{DoxyParams}[1]{Parameters} +\mbox{\tt in} & {\em m} & matrix \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +new matrix +\end{DoxyReturn} +\hypertarget{classmeow_1_1LinearTransformation_aeab1cf88fc67a1857504bd2fb18519f5}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!matrix@{matrix}} +\index{matrix@{matrix}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{matrix}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ virtual {\bf Matrix}$<$Scalar$>$ const\& {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::matrix ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{classmeow_1_1LinearTransformation_aeab1cf88fc67a1857504bd2fb18519f5} + + +Return the matrix form of this transformation. + +\begin{DoxyReturn}{Returns} +A matrix +\end{DoxyReturn} +\hypertarget{classmeow_1_1LinearTransformation_a60ead2898f321c5d77d099e1dc3e103c}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!matrix\-Inv@{matrix\-Inv}} +\index{matrix\-Inv@{matrix\-Inv}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{matrix\-Inv}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ virtual {\bf Matrix}$<$Scalar$>$ {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::matrix\-Inv ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{classmeow_1_1LinearTransformation_a60ead2898f321c5d77d099e1dc3e103c} + + +Return the inverse of the matrix form of this transformate. + +\begin{DoxyReturn}{Returns} +A matrix (may be invalid) +\end{DoxyReturn} + + +Reimplemented in \hyperlink{classmeow_1_1Rotation3D_a513851c5d53274b76fd9511ba1aea484}{meow\-::\-Rotation3\-D$<$ Scalar $>$}, and \hyperlink{classmeow_1_1Rotation3D_a513851c5d53274b76fd9511ba1aea484}{meow\-::\-Rotation3\-D$<$ double $>$}. + +\hypertarget{classmeow_1_1LinearTransformation_a573c034e179570f7a1c41f0c1de54c87}{\index{meow\-::\-Linear\-Transformation@{meow\-::\-Linear\-Transformation}!reference\-From@{reference\-From}} +\index{reference\-From@{reference\-From}!meow::LinearTransformation@{meow\-::\-Linear\-Transformation}} +\subsubsection[{reference\-From}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf Linear\-Transformation}\& {\bf meow\-::\-Linear\-Transformation}$<$ Scalar $>$\-::reference\-From ( +\begin{DoxyParamCaption} +\item[{{\bf Linear\-Transformation}$<$ Scalar $>$ const \&}]{b} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}}\label{classmeow_1_1LinearTransformation_a573c034e179570f7a1c41f0c1de54c87} + + +Reference settings, matrix from another \hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation}. + + +\begin{DoxyParams}[1]{Parameters} +\mbox{\tt in} & {\em b} & another \hyperlink{classmeow_1_1LinearTransformation}{Linear\-Transformation} \\ +\hline +\end{DoxyParams} + + +The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize} +\item +meowpp/math/\hyperlink{LinearTransformation_8h}{Linear\-Transformation.\-h}\end{DoxyCompactItemize} |