Represents a vector, \( v \in \mathcal{R}^d \). It provides access methods for setting and querying the vector components as well as vector math operators, e.g., adding, subtracting, dot_product and cross_product. More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/primal/geometry/Vector.hpp>
Public Types | |
| typedef Point< T, NDIMS > | PointType |
Public Member Functions | |
| AXOM_HOST_DEVICE | Vector (T val=T(), int sz=NDIMS) |
| Fill vector with single value. Acts as default constructor Sets first sz components of the vector to val (default 0). More... | |
| AXOM_HOST_DEVICE | Vector (const NumericArray< T, NDIMS > &arr) |
| Constructor from a numeric array. More... | |
| AXOM_HOST_DEVICE | Vector (const T *vals, int sz=NDIMS) |
| Creates a vector from the first sz values of the input array. More... | |
| AXOM_HOST_DEVICE | Vector (const Point< T, NDIMS > &pt) |
| Constructor to create vector from a Point. More... | |
| AXOM_HOST_DEVICE | Vector (const Vector< T, NDIMS > &other) |
| Copy constructor. More... | |
| AXOM_HOST_DEVICE Vector & | operator= (const Vector< T, NDIMS > &other) |
| Copy assignment operator. More... | |
| AXOM_HOST_DEVICE | Vector (const Point< T, NDIMS > &A, const Point< T, NDIMS > &B) |
| Constructs a vector from point A to point B. More... | |
| Vector (std::initializer_list< T > values) | |
| Creates a vector from an initializer list. More... | |
| AXOM_HOST_DEVICE | ~Vector () |
| Destructor. More... | |
| AXOM_HOST_DEVICE int | dimension () const |
| Returns the dimension of this vector instance. More... | |
| AXOM_HOST_DEVICE const T & | operator[] (int i) const |
| Access operator for individual components. More... | |
| AXOM_HOST_DEVICE T & | operator[] (int i) |
| AXOM_HOST_DEVICE const NumericArray< T, NDIMS > & | array () const |
| Returns a reference to the underlying NumericArray. More... | |
| AXOM_HOST_DEVICE NumericArray< T, NDIMS > & | array () |
| AXOM_HOST_DEVICE const T * | data () const |
| Returns a pointer to the underlying data. More... | |
| AXOM_HOST_DEVICE T * | data () |
| Vector< T, NDIMS > & | operator+= (const Vector< T, NDIMS > &v) |
| Adds the vector to the Vector instance \(\vec{u} +=\vec{v}\). More... | |
| Vector< T, NDIMS > & | operator-= (const Vector< T, NDIMS > &v) |
| Adds the vector ot the Vector instance \(\vec{u} -=\vec{v}\). More... | |
| Vector< T, NDIMS > & | operator*= (T scalar) |
| Scalar multiplication on the Vector instance. More... | |
| AXOM_HOST_DEVICE Vector< T, NDIMS > & | operator/= (T scalar) |
| Scalar division on the Vector instance. More... | |
| AXOM_HOST_DEVICE T | dot (const Vector< T, NDIMS > &v) const |
| Dot product of the Vector instance with another vector v. More... | |
| AXOM_HOST_DEVICE double | squared_norm () const |
| Computes the squared \( l^2\) norm of this vector instance. More... | |
| AXOM_HOST_DEVICE double | norm () const |
| Computes the \( l^2 \) norm of this vector instance. More... | |
| void | negate () |
| Component-wise negation of the vector. More... | |
| AXOM_HOST_DEVICE Vector | unitVector () const |
| Creates a new unit vector in the direction of the vector instance. More... | |
| std::ostream & | print (std::ostream &os) const |
| Simple formatted print of a Vector instance. More... | |
Static Public Member Functions | |
| static AXOM_HOST_DEVICE T | dot_product (const Vector< T, NDIMS > &u, const Vector< T, NDIMS > &v) |
| Computes the dot product of two vectors u, v. More... | |
| static AXOM_HOST_DEVICE Vector< T, 3 > | cross_product (const Vector< T, 2 > &u, const Vector< T, 2 > &v) |
| Computes the cross product of vector u and v, treating them as 3D. More... | |
| static AXOM_HOST_DEVICE Vector< T, 3 > | cross_product (const Vector< T, 3 > &u, const Vector< T, 3 > &v) |
| Computes the 3-D cross product of vector u and v. More... | |
| static Vector | make_vector (const T &x, const T &y, const T &z=0.0) |
| Utility function to constructs a Vector with the given coordinates. More... | |
Friends | |
| bool | operator== (const Vector &lhs, const Vector &rhs) |
| Equality comparison operator for vectors. More... | |
| bool | operator!= (const Vector &lhs, const Vector &rhs) |
| Inequality operator for points. More... | |
Detailed Description
template<typename T, int NDIMS>
class axom::primal::Vector< T, NDIMS >
Represents a vector, \( v \in \mathcal{R}^d \). It provides access methods for setting and querying the vector components as well as vector math operators, e.g., adding, subtracting, dot_product and cross_product.
- Template Parameters
-
T the coordinate type, e.g., double, float, etc. NDIMS the number of dimensions
- See also
- NumericArray
- Point
Member Typedef Documentation
◆ PointType
| typedef Point<T, NDIMS> axom::primal::Vector< T, NDIMS >::PointType |
Constructor & Destructor Documentation
◆ Vector() [1/7]
|
inlineexplicit |
Fill vector with single value. Acts as default constructor Sets first sz components of the vector to val (default 0).
- Parameters
-
[in] val The value to set the coordinates to. Defaults to zero [in] sz The number of coordinates to set to val. The rest will be set to zero. Defaults is NDIMS.
Referenced by axom::primal::Vector< SpaceCoordType, NDIMS >::make_vector(), and axom::primal::Vector< SpaceCoordType, NDIMS >::unitVector().
◆ Vector() [2/7]
|
inline |
Constructor from a numeric array.
- Parameters
-
[in] arr The numeric array to copy from
◆ Vector() [3/7]
|
inline |
Creates a vector from the first sz values of the input array.
- Parameters
-
[in] vals An array containing at least sz values [in] sz The number of coordinates to take from the array. Defaults to NDIMS. If sz is greater than NDIMS, we only take the first NDIMS values.
◆ Vector() [4/7]
|
inline |
Constructor to create vector from a Point.
- Parameters
-
[in] pt The point containing the vector's coordinates.
- Note
- Equivalent to Vector( Point::zero(), pt)
◆ Vector() [5/7]
|
inline |
Copy constructor.
- Parameters
-
[in] other The vector to copy
◆ Vector() [6/7]
|
inline |
Constructs a vector from point A to point B.
- Parameters
-
[in] A origin point of the vector. [in] B destination point of the vector.
- Precondition
- A.dimension() == B.dimension()
- A.dimension() == ndims
◆ Vector() [7/7]
|
inline |
Creates a vector from an initializer list.
- Parameters
-
[in] values an initializer list containing the values of the vector. If the size is not the same as the size of this vector, this behaves the same way as the constructor which takes a pointer and size.
◆ ~Vector()
|
inline |
Destructor.
Member Function Documentation
◆ operator=()
|
inline |
Copy assignment operator.
- Parameters
-
[in] other The vector to copy
Referenced by axom::primal::Vector< SpaceCoordType, NDIMS >::Vector().
◆ dimension()
|
inline |
Returns the dimension of this vector instance.
- Returns
- d the dimension (size) of the vector
- Postcondition
- d >= 1.
Referenced by axom::primal::Vector< SpaceCoordType, NDIMS >::dot_product().
◆ operator[]() [1/2]
|
inline |
Access operator for individual components.
- Parameters
-
[in] i the component index to access
- Returns
- p[i] the value at the given component index.
- Precondition
- (i >= 0) && (i < ndims)
◆ operator[]() [2/2]
|
inline |
◆ array() [1/2]
|
inline |
Returns a reference to the underlying NumericArray.
Referenced by axom::primal::OrientedBoundingBox< T, NDIMS >::bisect(), axom::primal::OrientedBoundingBox< T, NDIMS >::furthestPoint(), axom::primal::OrientedBoundingBox< T, NDIMS >::getPoints(), axom::primal::Vector< SpaceCoordType, NDIMS >::operator+=(), axom::primal::Vector< SpaceCoordType, NDIMS >::operator-=(), axom::primal::Vector< SpaceCoordType, NDIMS >::operator=(), axom::primal::BoundingBox< double, DIM >::scale(), and axom::primal::BoundingBox< double, DIM >::shift().
◆ array() [2/2]
|
inline |
◆ data() [1/2]
|
inline |
Returns a pointer to the underlying data.
Referenced by axom::primal::Vector< SpaceCoordType, NDIMS >::cross_product(), and axom::primal::Vector< SpaceCoordType, NDIMS >::dot_product().
◆ data() [2/2]
|
inline |
◆ operator+=()
|
inline |
◆ operator-=()
|
inline |
◆ operator*=()
|
inline |
Scalar multiplication on the Vector instance.
- Parameters
-
[in] scalar the scalar value to multiply with this vector.
- Returns
- A reference to the vector instance after scalar multiplication.
◆ operator/=()
|
inline |
Scalar division on the Vector instance.
- Parameters
-
[in] scalar the scalar value to divide with this vector.
- Precondition
- scalar != 0
- Returns
- A reference to the vector instance after scalar division.
◆ dot()
|
inline |
Dot product of the Vector instance with another vector v.
- Parameters
-
[in] v the other vector in the dot product
- Returns
- The dot product of the two vectors.
Referenced by axom::quest::SignedDistance< NDIMS >::computeDistance(), axom::primal::Vector< SpaceCoordType, NDIMS >::squared_norm(), and axom::primal::OrientedBoundingBox< T, NDIMS >::toLocal().
◆ squared_norm()
|
inline |
Computes the squared \( l^2\) norm of this vector instance.
- Returns
- n the squared norm.
- See also
- Vector::norm()
Referenced by axom::primal::Vector< SpaceCoordType, NDIMS >::norm(), axom::primal::Ray< T, NDIMS >::Ray(), axom::primal::squared_distance(), and axom::primal::Vector< SpaceCoordType, NDIMS >::unitVector().
◆ norm()
|
inline |
Computes the \( l^2 \) norm of this vector instance.
- Returns
- n the norm of the vector, a.k.a., magnitude or length.
Referenced by axom::primal::Triangle< T, NDIMS >::angle(), axom::spin::ImplicitGrid< NDIMS, TheIndexType >::initialize(), and axom::primal::Segment< T, NDIMS >::length().
◆ negate()
|
inline |
Component-wise negation of the vector.
Referenced by axom::primal::operator-().
◆ unitVector()
|
inline |
Creates a new unit vector in the direction of the vector instance.
- Note
- The unit vector of the zero vector is (1,0,0,...) when normalized.
- Postcondition
- this->norm() == 1.0f
Referenced by axom::primal::Ray< T, NDIMS >::Ray().
◆ print()
| std::ostream & axom::primal::Vector< T, NDIMS >::print | ( | std::ostream & | os | ) | const |
Simple formatted print of a Vector instance.
- Parameters
-
os The output stream to write to
- Returns
- A reference to the modified ostream
Referenced by axom::primal::operator<<().
◆ dot_product()
|
inlinestatic |
Computes the dot product of two vectors u, v.
- Parameters
-
[in] u the vector on the right-hand side. [in] v the vector on the left-hand side.
- Returns
- dotprod the computed dot product.
- Precondition
- u.dimension() == v.dimension().
Referenced by axom::primal::Triangle< T, NDIMS >::angle(), axom::primal::closest_point(), axom::primal::Vector< SpaceCoordType, NDIMS >::dot(), and axom::primal::squared_distance().
◆ cross_product() [1/2]
|
inlinestatic |
Computes the cross product of vector u and v, treating them as 3D.
- Parameters
-
[in] u the vector on the right-hand side. [in] v the vector on the left-hand side.
- Returns
- C the resulting vector from A x B.
Referenced by axom::primal::Triangle< T, NDIMS >::area(), axom::primal::Triangle< T, NDIMS >::normal(), and axom::primal::Triangle< T, NDIMS >::physToBarycentric().
◆ cross_product() [2/2]
|
inlinestatic |
Computes the 3-D cross product of vector u and v.
- Parameters
-
[in] u the vector on the right-hand side. [in] v the vector on the left-hand side.
- Returns
- C the resulting vector from A x B.
◆ make_vector()
|
inlinestatic |
Friends And Related Function Documentation
◆ operator==
|
friend |
Equality comparison operator for vectors.
◆ operator!=
|
friend |
Inequality operator for points.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/primal/geometry/Vector.hpp
