aboutsummaryrefslogtreecommitdiffstats
path: root/doc/latex/classmeow_1_1LinearTransformation.tex
blob: b44110bcd6a5e46208c090f18c3e9e4134499be5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
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}