Peano
Loading...
Searching...
No Matches
VectorVectorOperations.h
Go to the documentation of this file.
1// This file is part of the Peano project. For conditions of distribution and
2// use, please see the copyright notice at www.peano-framework.org
3#pragma once
4
5#include "tarch/la/Vector.h"
6
7namespace tarch {
8 namespace la {
9
15 template <int Size, typename Scalar>
16 Vector<Size, Scalar>& operator+=(Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
17
23 template <int Size, typename Scalar>
24 Vector<Size, Scalar>& operator-=(Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
25
31 template <int Size, typename Scalar>
32 Vector<Size, Scalar> operator+(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
33
39 template <int Size, typename Scalar>
40 Vector<Size, Scalar> operator-(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
41
46 template <int Size, typename Scalar>
47 Vector<Size, Scalar> multiplyComponents(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
48
54 template <int Size, typename Scalar>
55 Scalar operator*(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
56
62 template <int Size, typename Scalar>
63 Scalar dot(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
64
70 template <int Size, typename Scalar>
71 Scalar innerDot(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
72
76 template <typename Scalar>
77 Vector<3, Scalar> cross(const Vector<3, Scalar>& lhs, const Vector<3, Scalar>& rhs);
78
85 template <int Size, typename Scalar>
86 bool equals(
87 const Vector<Size, Scalar>& lhs,
88 const Vector<Size, Scalar>& rhs,
89 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
90 );
91
101 template <int Size, typename Scalar>
102 bool firstGreater(
103 const Vector<Size, Scalar>& lhs,
104 const Vector<Size, Scalar>& rhs,
105 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
106 );
107
115 template <int Size, typename Scalar>
116 bool oneGreater(
117 const Vector<Size, Scalar>& lhs,
118 const Vector<Size, Scalar>& rhs,
119 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
120 );
121
126 template <int Size, typename Scalar>
127 bool oneGreaterEquals(
128 const Vector<Size, Scalar>& lhs,
129 const Vector<Size, Scalar>& rhs,
130 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
131 );
132
140 template <int Size, typename Scalar>
141 bool allGreater(
142 const Vector<Size, Scalar>& lhs,
143 const Vector<Size, Scalar>& rhs,
144 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
145 );
146
151 template <int Size, typename Scalar>
152 bool allGreaterEquals(
153 const Vector<Size, Scalar>& lhs,
154 const Vector<Size, Scalar>& rhs,
155 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
156 );
157
158 template <int Size, typename Scalar>
159 bool allSmaller(
160 const Vector<Size, Scalar>& lhs,
161 const Vector<Size, Scalar>& rhs,
162 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
163 );
164
165 template <int Size, typename Scalar>
166 bool allSmallerEquals(
167 const Vector<Size, Scalar>& lhs,
168 const Vector<Size, Scalar>& rhs,
169 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
170 );
171
172 template <int Size, typename Scalar>
173 bool oneSmaller(
174 const Vector<Size, Scalar>& lhs,
175 const Vector<Size, Scalar>& rhs,
176 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
177 );
178
179 template <int Size, typename Scalar>
180 bool oneSmallerEquals(
181 const Vector<Size, Scalar>& lhs,
182 const Vector<Size, Scalar>& rhs,
183 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
184 );
185
189 template <int Size, typename Scalar>
190 Vector<Size, Scalar> max(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
191
195 template <int Size, typename Scalar>
196 Vector<Size, Scalar> min(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
197
204 template <int Size, typename Scalar>
205 bool operator==(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
206
213 template <int Size, typename Scalar>
214 bool operator!=(const Vector<Size, Scalar>& lhs, const Vector<Size, Scalar>& rhs);
215
220 template <int Size, typename Scalar>
221 int equalsReturnIndex(
222 const Vector<Size, Scalar>& lhs,
223 const Vector<Size, Scalar>& rhs,
224 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
225 );
226
227 template <int Size>
228 int equalsReturnIndex(const Vector<Size, int>& lhs, const Vector<Size, int>& rhs);
229
233 template <int Size>
234 int countEqualEntries(const Vector<Size, int>& lhs, const Vector<Size, int>& rhs);
235
236 template <int Size, typename Scalar>
237 int countEqualEntries(
238 const Vector<Size, Scalar>& lhs,
239 const Vector<Size, Scalar>& rhs,
240 const Scalar tolerance = NUMERICAL_ZERO_DIFFERENCE
241 );
242 } // namespace la
243} // namespace tarch
244
245#include "tarch/la/VectorVectorOperations.cpph"
tarch::la::dot
Scalar dot(const Vector< Size, Scalar > &lhs, const Vector< Size, Scalar > &rhs)
Performs the dot (=inner) product of two vectors.
tarch::la::allGreaterEquals
bool allGreaterEquals(const Vector< Size, Scalar > &lhs, const Scalar &cmp, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
tarch::la::operator!=
bool operator!=(const Vector< Size, Scalar > &lhs, const Vector< Size, Scalar > &rhs)
Bit-wise comparison of the components of two vectors for inequality.
tarch::la::allGreater
bool allGreater(const Vector< Size, Scalar > &lhs, const Scalar &cmp, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
tarch::la::cross
Vector< 3, Scalar > cross(const Vector< 3, Scalar > &lhs, const Vector< 3, Scalar > &rhs)
Performs the cross product of two 3D vectors into result.
tarch::la::oneSmaller
bool oneSmaller(const Vector< Size, Scalar > &lhs, const Scalar &cmp, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
tarch::la::countEqualEntries
int countEqualEntries(const Vector< Size, int > &lhs, const Vector< Size, int > &rhs)
Run through both vectors and count how many entries are the same.
tarch::la::operator==
bool operator==(const Matrix< Rows, Cols, Scalar > &lhs, const Matrix< Rows, Cols, Scalar > &rhs)
Bitwise comparison of the components of two matrices on equality.
tarch::la::operator-
Matrix< Rows, Cols, Scalar > operator-(const Matrix< Rows, Cols, Scalar > &lhs, const Matrix< Rows, Cols, Scalar > &rhs)
tarch::la::operator+=
Vector< Size, Scalar > & operator+=(Vector< Size, Scalar > &vector, const Scalar &scalar)
Adds every component of the vector to the scalar and assigns the result to the vector.
tarch::la::NUMERICAL_ZERO_DIFFERENCE
constexpr double NUMERICAL_ZERO_DIFFERENCE
Definition Scalar.h:17
tarch::la::operator+
Matrix< Rows, Cols, Scalar > operator+(const Matrix< Rows, Cols, Scalar > &lhs, const Matrix< Rows, Cols, Scalar > &rhs)
tarch::la::oneSmallerEquals
bool oneSmallerEquals(const Vector< Size, Scalar > &lhs, const Scalar &cmp, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
tarch::la::max
double max(double a, double b, double c)
I need the maximum of three values all the time, to I decided to write a function for this.
tarch::la::firstGreater
bool firstGreater(const Vector< Size, Scalar > &lhs, const Vector< Size, Scalar > &rhs, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
Compares sequentially every component pair of lVector and rVector, and stops as soon as one is greate...
tarch::la::allSmallerEquals
bool allSmallerEquals(const Vector< Size, Scalar > &lhs, const Scalar &cmp, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
tarch::la::allSmaller
bool allSmaller(const Vector< Size, Scalar > &lhs, const Scalar &cmp, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
tarch::la::operator*
Matrix< Rows, Cols, Scalar > operator*(const Matrix< Rows, X, Scalar > &lhs, const Matrix< X, Cols, Scalar > &rhs)
tarch::la::equals
bool equals(const Matrix< Rows, Cols, Scalar > &lhs, const Matrix< Rows, Cols, Scalar > &rhs, const Scalar &tolerance=NUMERICAL_ZERO_DIFFERENCE)
Compares to matrices on equality by means of a numerical accuracy.
tarch::la::equalsReturnIndex
std::pair< int, int > equalsReturnIndex(const Matrix< Rows, Cols, Scalar > &lhs, const Matrix< Rows, Cols, Scalar > &rhs, const Scalar &tolerance=NUMERICAL_ZERO_DIFFERENCE)
Return Index of element which is not equals.
tarch::la::oneGreaterEquals
bool oneGreaterEquals(const Vector< Size, Scalar > &lhs, const Scalar &cmp, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
tarch::la::multiplyComponents
Matrix< Rows, Cols, Scalar > multiplyComponents(const Matrix< Rows, X, Scalar > &lhs, const Matrix< X, Cols, Scalar > &rhs)
tarch::la::innerDot
Scalar innerDot(const Vector< Size, Scalar > &lhs, const Vector< Size, Scalar > &rhs)
Performs the dot (=inner) product of two vectors.
tarch::la::operator-=
Vector< Size, Scalar > & operator-=(Vector< Size, Scalar > &vector, const Scalar &scalar)
Subtracts the scalar from every component of the vector and assigns the result to the vector.
tarch::la::oneGreater
bool oneGreater(const Vector< Size, Scalar > &lhs, const Scalar &cmp, const Scalar tolerance=NUMERICAL_ZERO_DIFFERENCE)
tarch::la::min
Scalar min(const Vector< Size, Scalar > &vector)
Returns the element with minimal value (NOT absolute value).
tarch
Have to include this header, as I need access to the SYCL_EXTERNAL keyword.
Definition accelerator.h:19
tarch::la::Vector
Simple vector class.
Definition Vector.h:159