DPoint2 Class Reference

Description: This class describes a 2D point using double precision x and y coordinates. More...

#include <dpoint2.h>

Public Member Functions
constexpr	DPoint2 ()=default
constexpr	DPoint2 (const DPoint2 &)=default
constexpr	DPoint2 (DPoint2 &&)=default
DPoint2 &	operator= (const DPoint2 &)=default
DPoint2 &	operator= (DPoint2 &&)=default
constexpr	DPoint2 (double X, double Y)
constexpr	DPoint2 (const Point2 &a)
constexpr	DPoint2 (const double af[2])
constexpr DPoint2 &	operator= (const Point2 &a)
	Assign a Point2 to this DPoint2. More...
double &	operator[] (int i)
	const for (0,1) More...
const double &	operator[] (int i) const
constexpr	operator double * ()
	Conversion function. More...
constexpr	operator const double * () const
constexpr	operator Point2 ()
	Convert DPoint2 to Point2. More...
constexpr DPoint2	operator- () const
	Unary - operator. More...
constexpr DPoint2	operator+ () const
	Unary +. More...
constexpr DPoint2 &	operator-= (const DPoint2 &a)
	Subtracts a DPoint2 from this DPoint2. More...
constexpr DPoint2 &	operator+= (const DPoint2 &a)
	Adds a DPoint2 to this DPoint2. More...
constexpr DPoint2 &	operator*= (const DPoint2 &a)
	Member-wise multiplication of two vectors: (x*x, y*y) More...
DPoint2 &	operator/= (const DPoint2 &a)
	Member-wise division of two vectors. More...
constexpr DPoint2 &	operator+= (double a)
	Each element of this DPoint2 is increased by the specified double. More...
constexpr DPoint2 &	operator-= (double a)
	Each element of this DPoint2 is decreased by the specified double. More...
constexpr DPoint2 &	operator*= (double a)
	Each element of this DPoint2 is multiplied by the specified double. More...
DPoint2 &	operator/= (double a)
	Each element of this DPoint2 is divided by the specified double. More...
constexpr DPoint2	operator- (const DPoint2 &a) const
	Subtracts a DPoint2 from a DPoint2. More...
constexpr DPoint2	operator+ (const DPoint2 &a) const
	Adds a DPoint2 to a DPoint2. More...
constexpr DPoint2	operator* (const DPoint2 &a) const
	Member-wise multiplication of two vectors: (x*x, y*y) More...
DPoint2	operator/ (const DPoint2 &a) const
	Member-wise division of two vectors: More...
constexpr double	DotProd (const DPoint2 &a) const
	Returns the dot product of two DPoint2s. More...
constexpr double	operator% (const DPoint2 &a) const
	Returns the dot product of two DPoint2s. More...
constexpr double	LengthSquared () const
	The 'Length' squared of this point. More...
double	Length () const
	Returns the 'Length' of this point (vector). More...
DPoint2 &	Unify ()
	In place normalize. More...
double	LengthUnify ()
int	MaxComponent () const
int	MinComponent () const
DPoint2	Normalize () const
	Returns a unit vector. More...
constexpr bool	operator== (const DPoint2 &p) const
constexpr bool	operator!= (const DPoint2 &p) const
bool	Equals (const DPoint2 &p, double epsilon=1E-6) const

Public Attributes
double	x = 0.0
double	y = 0.0

Static Public Attributes
static const DPoint2	Origin
static const DPoint2	XAxis
	const for (0,0) More...
static const DPoint2	YAxis
	const for (1,0) More...

Detailed Description

Description: This class describes a 2D point using double precision x and y coordinates.

Methods are provided to add and subtract points, multiply and divide by scalars, and element by element multiply and divide two points. All methods are implemented by the system.

Constructor & Destructor Documentation

DPoint2() [1/6]

constexpr DPoint2 ( )

constexprdefault

DPoint2() [2/6]

constexpr DPoint2 ( const DPoint2 &  )

constexprdefault

DPoint2() [3/6]

constexpr DPoint2 ( DPoint2 &&  )

constexprdefault

DPoint2() [4/6]

constexpr DPoint2 ( double  X, double  Y  )

inlineconstexpr

Remarks

Constructor. Data members are initialized to X and Y.

: x(X), y(Y) {}

DPoint2() [5/6]

constexpr DPoint2 ( const Point2 &  a )

inlineconstexpr

Remarks

Constructor. Data members are initialized to a.x and a.y.

: x(a.x), y(a.y) {}

DPoint2() [6/6]

constexpr DPoint2 ( const double  af[2] )

inlineconstexpr

Remarks

Constructor. Data members are initialized as x = af[0] and y = af[1].

: x(af[0]), y(af[1]) {}

Member Function Documentation

operator=() [1/3]

DPoint2& operator= ( const DPoint2 &  )

default

operator=() [2/3]

DPoint2& operator= ( DPoint2 &&  )

default

operator=() [3/3]

constexpr DPoint2& operator= ( const Point2 &  a )

inlineconstexpr

Assign a Point2 to this DPoint2.

    {
        x = a.x;
        y = a.y;
        return *this;
    }

operator[]() [1/2]

double& operator[] ( int  i )

inline

const for (0,1)

Remarks

Allows access to x, y using the subscript operator.

Returns

An index of 0 will return x, 1 will return y.

    {
        assert((i == 0) || (i == 1));
        return (i == 0) ? x : y;
    }

operator[]() [2/2]

const double& operator[] ( int  i ) const

inline

    {
        assert((i == 0) || (i == 1));
        return (i == 0) ? x : y;
    }

operator double *()

constexpr operator double * ( )

inlineconstexpr

Conversion function.

Returns the address of the DPoint2.x

Returns

a pointer to the x component.

    {
        return &x;
    }

operator const double *()

constexpr operator const double * ( ) const

inlineconstexpr

    {
        return &x;
    }

operator Point2()

constexpr operator Point2 ( )

inlineconstexpr

Convert DPoint2 to Point2.

    {
        return Point2(x, y);
    }

operator-() [1/2]

constexpr DPoint2 operator- ( ) const

inlineconstexpr

Unary - operator.

Negates both x and y

    {
        return DPoint2(-x, -y);
    }

operator+() [1/2]

constexpr DPoint2 operator+ ( ) const

inlineconstexpr

Unary +.

Returns this point unaltered.

    {
        return *this;
    }

operator-=() [1/2]

constexpr DPoint2& operator-= ( const DPoint2 &  a )

inlineconstexpr

Subtracts a DPoint2 from this DPoint2.

Parameters

a	the value to subtract from this DPoint2

Returns

the resulting DPoint2

    {
        x -= a.x;
        y -= a.y;
        return *this;
    }

operator+=() [1/2]

constexpr DPoint2& operator+= ( const DPoint2 &  a )

inlineconstexpr

Adds a DPoint2 to this DPoint2.

Parameters

a	the value to add to this DPoint2

Returns

the resulting DPoint2

    {
        x += a.x;
        y += a.y;
        return *this;
    }

operator*=() [1/2]

constexpr DPoint2& operator*= ( const DPoint2 &  a )

inlineconstexpr

Member-wise multiplication of two vectors: (x*x, y*y)

Parameters

a	the multiplier

Returns

the resulting DPoint2

    {
        x *= a.x;
        y *= a.y;
        return *this;
    }

operator/=() [1/2]

DPoint2& operator/= ( const DPoint2 &  a )

inline

Member-wise division of two vectors.

Parameters

a	the multiplier

Returns

the resulting DPoint2

    {
        assert(a.x != 0.0 && a.y != 0.0);
        x /= a.x;
        y /= a.y;
        return *this;
    }

operator+=() [2/2]

constexpr DPoint2& operator+= ( double  a )

inlineconstexpr

Each element of this DPoint2 is increased by the specified double.

    {
        x += a;
        y += a;
        return *this;
    }

operator-=() [2/2]

constexpr DPoint2& operator-= ( double  a )

inlineconstexpr

Each element of this DPoint2 is decreased by the specified double.

    {
        return *this += -a;
    }

operator*=() [2/2]

constexpr DPoint2& operator*= ( double  a )

inlineconstexpr

Each element of this DPoint2 is multiplied by the specified double.

Parameters

a	the multiplier

Returns

the resulting DPoint2

    {
        x *= a;
        y *= a;
        return *this;
    }

operator/=() [2/2]

DPoint2& operator/= ( double  a )

inline

Each element of this DPoint2 is divided by the specified double.

Parameters

a	the divisor

Returns

the resulting DPoint2

    {
        assert(a != 0.0);
        return *this *= (1.0 / a);
    }

operator-() [2/2]

constexpr DPoint2 operator- ( const DPoint2 &  a ) const

inlineconstexpr

Subtracts a DPoint2 from a DPoint2.

Parameters

a	the value to subtract from this DPoint2

Returns

the resulting DPoint2

    {
        return DPoint2(x - a.x, y - a.y);
    }

operator+() [2/2]

constexpr DPoint2 operator+ ( const DPoint2 &  a ) const

inlineconstexpr

Adds a DPoint2 to a DPoint2.

Parameters

a	the value to add to this DPoint2

Returns

the resulting DPoint2

    {
        return DPoint2(x + a.x, y + a.y);
    }

operator*()

constexpr DPoint2 operator* ( const DPoint2 &  a ) const

inlineconstexpr

Member-wise multiplication of two vectors: (x*x, y*y)

Parameters

a	the multiplier

Returns

the resulting DPoint2

    {
        return DPoint2(x * a.x, y * a.y);
    }

operator/()

DPoint2 operator/ ( const DPoint2 &  a ) const

inline

Member-wise division of two vectors:

Parameters

a	the multiplier

Returns

the resulting DPoint2

    {
        assert(a.x != 0.0 && a.y != 0.0);
        return DPoint2(x / a.x, y / a.y);
    }

DotProd()

constexpr double DotProd ( const DPoint2 &  a ) const

inlineconstexpr

Returns the dot product of two DPoint2s.

    {
        return x * a.x + y * a.y;
    }

operator%()

constexpr double operator% ( const DPoint2 &  a ) const

inlineconstexpr

Returns the dot product of two DPoint2s.

    {
        return DotProd(a);
    }

LengthSquared()

constexpr double LengthSquared ( ) const

inlineconstexpr

The 'Length' squared of this point.

This is v.x*v.x+v.y*v.y.

Returns

the length value

    {
        return x * x + y * y;
    }

Length()

double Length ( ) const

inline

Returns the 'Length' of this point (vector).

This is:

sqrt(v.x*v.x+v.y*v.y).

Returns

the length value

    {
        return sqrt(LengthSquared());
    }

Unify()

DPoint2& Unify

(

)

In place normalize.

Returns

the normalized value

LengthUnify()

double LengthUnify

(

)

MaxComponent()

int MaxComponent

(

)

const

Remarks

Returns the component with the maximum abs value. 0=x, 1=y.

MinComponent()

int MinComponent

(

)

const

Remarks

Returns the component with the minimum abs value. 0=x, 1=y.

Normalize()

DPoint2 Normalize

(

)

const

Returns a unit vector.

This is a DPoint2 with each component divided by the point Length().

Returns

the unit vector for the specified DPoint2

operator==()

constexpr bool operator== ( const DPoint2 &  p ) const

inlineconstexpr

Remarks

Equality operator. Compares two Point2's.

    {
        return p.x == x && p.y == y;
    }

operator!=()

constexpr bool operator!= ( const DPoint2 &  p ) const

inlineconstexpr

    {
        return !(*this == p);
    }

Equals()

bool Equals	(	const DPoint2 &	p,
		double	epsilon = 1E-6
	)		const

Remarks

Returns true if the absolute difference between point components is less or equal to the given epsilon for each component

Member Data Documentation

x

double x = 0.0

y

double y = 0.0

Origin

const DPoint2 Origin

static

XAxis

const DPoint2 XAxis

static

const for (0,0)

YAxis

const DPoint2 YAxis

static

const for (1,0)