Debian Codegraph @

src/acl/aclMath/aclComplexNumOfElements.h

raw
1 /*
2 * Advanced Simulation Library <http://asl.org.il>
3 *
4 * Copyright 2015 Avtech Scientific <http://avtechscientific.com>
5 *
6 *
7 * This file is part of Advanced Simulation Library (ASL).
8 *
9 * ASL is free software: you can redistribute it and/or modify it
10 * under the terms of the GNU Affero General Public License as
11 * published by the Free Software Foundation, version 3 of the License.
12 *
13 * ASL is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Affero General Public License for more details.
17 *
18 * You should have received a copy of the GNU Affero General Public License
19 * along with ASL. If not, see <http://www.gnu.org/licenses/>.
20 *
21 */
22
23
24 #ifndef ACLCOMPLEXNUMOFELEMENTS_H
25 #define ACLCOMPLEXNUMOFELEMENTS_H
26
27 #include "aclVectorOfElements.h"
28
29 namespace acl
30 {
31 /// The class represents a matrix elements of ::Element
32 /**
33 \ingroup ComplexDataTypes
34 */
35 class ComplexNumOfElements
36 {
37 private:
38 VectorOfElements ve;
39 public:
40 ComplexNumOfElements();
41
42 void setRe(Element a);
43 void setIm(Element a);
44 const Element getRe() const;
45 const Element getIm() const;
46 VectorOfElements & getInternalVector();
47 const VectorOfElements & getInternalVector() const;
48 };
49
50 ///function copies the ComplexNumOfElements class.
51 /**
52 \relates ComplexNumOfElements
53 */
54 void copy(const ComplexNumOfElements & source, ComplexNumOfElements & destination);
55
56 ///summ of two matrices
57 /**
58 \relates ComplexNumOfElements
59 */
60 ComplexNumOfElements operator+(ComplexNumOfElements & a, ComplexNumOfElements & b);
61 ///difference of two matrices
62 /**
63 \relates ComplexNumOfElements
64 */
65 ComplexNumOfElements operator-(ComplexNumOfElements & a,ComplexNumOfElements & b);
66
67 ///product of two matrices
68 /**
69 \relates ComplexNumOfElements
70 */
71 ComplexNumOfElements operator*(const ComplexNumOfElements & a, const ComplexNumOfElements & b);
72
73
74
75
76
77
78
79 } //namespace acl
80
81 #endif // ACLCOMPLEXNUMOFELEMENTS_H