boca::Line< Vector_, Value_ > Class Template Reference

Line between two points. More...

#include <Line.hh>

Public Member Functions
Constructor
	Line ()
	Default constructor. More...
	Line (Vector_< Value_ > const &point_1, Vector_< Value_ > const &point_2)
	Constructor accepting two vectors. More...
Getter
Vector_< Value_ > const &	Point_1 () const
	Vector of first point. More...
Vector_< Value_ >	Point_1 ()
	Vector of first point. More...
Vector_< Value_ > const &	Point_2 () const
	Vector of second point. More...
Vector_< Value_ >	Point_2 ()
	Vector of second point. More...
Distances
Value_	DistanceToSegment (Vector_< Value_ > const &point) const
	Distance of point to line segment spanned between the two vectors. More...
Value_	DistanceToLine (Vector_< Value_ > const &point) const
	Distance of point to the line. More...
Line vector
Vector_< Value_ >	Vector () const
	Vector between the two points. More...
Value_Square	Mag2 () const
	Square of the magnitude of the vector. More...
Value_	Mag () const
	Magnitude of the vector. More...
Relation to a point
Vector_< Value_ >	Vector_1 (Vector_< Value_ > const &point) const
	vector between a point and the first point More...
Vector_< Value_ >	Vector_2 (Vector_< Value_ > const &point) const
	vector between a point and the second point More...
Value_	Distance_1 (Vector_< Value_ > const &point) const
	Distance between the point and the first point. More...
Value_	Distance_2 (Vector_< Value_ > const &point) const
	Distance between the point and the second point. More...
double	Paramter (Vector_< Value_ > const &point) const
	Parameter along the line segment between the two points. More...
Vector_< Value_ >	Projection (Vector_< Value_ > const &point) const
	Projection of the point onto the line. More...

Friends
auto &	operator<< (std::ostream &stream, Line const &line)
	Output stream operator. More...

Detailed Description

template<template< typename > class Vector_, typename Value_>
class boca::Line< Vector_, Value_ >

Line between two points.

Constructor & Destructor Documentation

template<template< typename > class Vector_, typename Value_>

boca::Line< Vector_, Value_ >::Line ( )

inline

Default constructor.

template<template< typename > class Vector_, typename Value_>

boca::Line< Vector_, Value_ >::Line ( Vector_< Value_ > const &  point_1, Vector_< Value_ > const &  point_2  )

inline

Constructor accepting two vectors.

Member Function Documentation

template<template< typename > class Vector_, typename Value_>

Value_ boca::Line< Vector_, Value_ >::Distance_1 ( Vector_< Value_ > const &  point ) const

inline

Distance between the point and the first point.

template<template< typename > class Vector_, typename Value_>

Value_ boca::Line< Vector_, Value_ >::Distance_2 ( Vector_< Value_ > const &  point ) const

inline

Distance between the point and the second point.

template<template< typename > class Vector_, typename Value_>

Value_ boca::Line< Vector_, Value_ >::DistanceToLine ( Vector_< Value_ > const &  point ) const

inline

Distance of point to the line.

template<template< typename > class Vector_, typename Value_>

Value_ boca::Line< Vector_, Value_ >::DistanceToSegment ( Vector_< Value_ > const &  point ) const

inline

Distance of point to line segment spanned between the two vectors.

template<template< typename > class Vector_, typename Value_>

Value_ boca::Line< Vector_, Value_ >::Mag ( ) const

inline

Magnitude of the vector.

template<template< typename > class Vector_, typename Value_>

Value_Square boca::Line< Vector_, Value_ >::Mag2 ( ) const

inline

Square of the magnitude of the vector.

template<template< typename > class Vector_, typename Value_>

double boca::Line< Vector_, Value_ >::Paramter ( Vector_< Value_ > const &  point ) const

inline

Parameter along the line segment between the two points.

template<template< typename > class Vector_, typename Value_>

Vector_<Value_> const& boca::Line< Vector_, Value_ >::Point_1 ( ) const

inline

Vector of first point.

template<template< typename > class Vector_, typename Value_>

Vector_<Value_> boca::Line< Vector_, Value_ >::Point_1 ( )

inline

Vector of first point.

template<template< typename > class Vector_, typename Value_>

Vector_<Value_> const& boca::Line< Vector_, Value_ >::Point_2 ( ) const

inline

Vector of second point.

template<template< typename > class Vector_, typename Value_>

Vector_<Value_> boca::Line< Vector_, Value_ >::Point_2 ( )

inline

Vector of second point.

template<template< typename > class Vector_, typename Value_>

Vector_<Value_> boca::Line< Vector_, Value_ >::Projection ( Vector_< Value_ > const &  point ) const

inline

Projection of the point onto the line.

template<template< typename > class Vector_, typename Value_>

Vector_<Value_> boca::Line< Vector_, Value_ >::Vector ( ) const

inline

Vector between the two points.

template<template< typename > class Vector_, typename Value_>

Vector_<Value_> boca::Line< Vector_, Value_ >::Vector_1 ( Vector_< Value_ > const &  point ) const

inline

vector between a point and the first point

template<template< typename > class Vector_, typename Value_>

Vector_<Value_> boca::Line< Vector_, Value_ >::Vector_2 ( Vector_< Value_ > const &  point ) const

inline

vector between a point and the second point

Friends And Related Function Documentation

template<template< typename > class Vector_, typename Value_>

auto& operator<< ( std::ostream &  stream, Line< Vector_, Value_ > const &  line  )

friend

Output stream operator.

---

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

• boca/math/Line.hh