Template Class GeomPoint

Inheritance Relationships

Derived Types

Class Documentation

template<int spacedim, typename T = real_t>
class GeomPoint

A class that describes a point with spacedim spatial dimension space.

Subclassed by bitrl::utils::geom::FaceElement< spacedim, 0 >, bitrl::utils::trajectory::WayPoint< dim, Data >

Public Types

typedef T value_type

value_type. The type of the coordinates

Public Functions

inline explicit GeomPoint(T val = T())

ctor all dim data are assigned the given value

template<typename Container>
inline explicit GeomPoint(const Container &data)

Create by passing a vector of data.

GeomPoint(const std::initializer_list<T> &list)

Construct given an initializer_list.

inline GeomPoint(const GeomPoint &t)

copy ctor

inline GeomPoint &operator=(const GeomPoint &t)

copy assignement operator

inline virtual ~GeomPoint()

dtor

inline GeomPoint &operator+=(const GeomPoint&)

Add another vector, i.e. move this point by the given offset.

inline GeomPoint &operator-=(const GeomPoint&)

\detailed Subtract another tensor.

inline GeomPoint &operator*=(T factor)

Scale the point by factor.

inline GeomPoint &operator/=(T factor)

Scale the vector by factor.

inline GeomPoint &operator=(const std::initializer_list<T> &list)

operator = Assign from the initializer list

void scale(T factor)

scale with a given factor

void scale(const std::vector<T> &factors)

scale this object by the given factors p factors should have size at least spacedim

inline void zero()

Zero the entries of the tensor.

inline void add_scaled(const GeomPoint &p, T factor)

Add the coordinates of the given point to this scaled by factor.

inline T &operator[](uint_t i)

Access the i-th coordinate of the point.

inline T operator[](uint_t i) const

Access the i-th coordinate of the point read-only.

inline T entry(uint_t i) const

access the i-th coordinate of the point read-only

inline auto coordinates() const

Get a copy of the data of this object.

T max() const

Get the max element in the point.

T min() const

Get the min element in the point.

T distance(const GeomPoint&) const

Get the distance from the given point.

inline T L2_norm() const

Return the distance from the origin.

T dot(const GeomPoint &other) const

Returns the dot product of this point and the given point.

T square_sum() const

Returns the square sum of the compontents.

inline std::ostream &print_point_info(std::ostream &out) const

print the point

const std::string to_string() const

Returns string representation of the point.

Public Static Attributes

static const int dimension = spacedim

dimension. Spatial dimension of the point