minimc 0.5.1
Loading...
Searching...
No Matches
Point Class Reference

Point in \( \mathbb{R}^{3} \). More...

#include <Point.hpp>

Inheritance diagram for Point:

Public Member Functions

 Point () noexcept
 Default constructor. Creates a Point at the origin;.
 
 Point (const pugi::xml_node &pointtype_node) noexcept
 Constructs a Point from a PointType node. More...
 
 Point (const Real &x, const Real &y, const Real &z) noexcept
 Constructs a Point with the given components.
 
const PointNormalize () noexcept
 Scales the point to satisfy \( \lVert v \rVert = 1 \).
 
Real Dot (const Point &rhs) const noexcept
 Returns the inner product of this and another Point.
 
Point Cross (const Point &rhs) const noexcept
 Returns the cross product of this and another Point.
 
Pointoperator+= (const Point &rhs) noexcept
 Adds the given Point to the current Point.
 
Pointoperator/= (const Real &rhs) noexcept
 Divides each element of this Point with rhs.
 
bool operator== (const Point &rhs) const noexcept
 Returns true if each corresponding element is equal.
 

Protected Attributes

Real x {0}
 x component
 
Real y {0}
 y component
 
Real z {0}
 z component
 

Friends

Point operator+ (const Point &lhs, const Point &rhs) noexcept
 Returns the vector sum of two Point objects.
 
Point operator- (const Point &lhs, const Point &rhs) noexcept
 Returns the vector difference of two Point objects.
 
Point operator* (const Point &lhs, const Real &rhs) noexcept
 Returns Point with each element multiplied by rhs.
 
Point operator* (const Real &lhs, const Point &rhs) noexcept
 Returns Point with each element multiplied by lhs.
 
Point operator/ (const Point &lhs, const Real &rhs) noexcept
 Returns Point with each element divided by rhs.
 

Detailed Description

Point in \( \mathbb{R}^{3} \).

Constructor & Destructor Documentation

◆ Point()

Point::Point ( const pugi::xml_node &  pointtype_node)
noexcept

Constructs a Point from a PointType node.

PointType is a complexType defined in the minimc XML schema.


The documentation for this class was generated from the following file: