vector2d.h File Reference

#include <algorithm>
#include <limits>
#include <iostream>
#include <sstream>
#include <type_traits>
#include <math/util.h>

Go to the source code of this file.

Classes
struct	VECTOR2_TRAITS< T >
	Traits class for VECTOR2. More...
struct	VECTOR2_TRAITS< int >
class	VECTOR2< T >
	Define a general 2D-vector/point. More...
struct	std::hash< VECTOR2I >
struct	std::less< VECTOR2I >

Namespaces
namespace	std
	STL namespace.

Typedefs
typedef VECTOR2< double >	VECTOR2D
typedef VECTOR2< int32_t >	VECTOR2I
typedef VECTOR2< int64_t >	VECTOR2L

Functions
template<class T>
std::ostream &	operator<< (std::ostream &aStream, const VECTOR2< T > &aVector)
template<class T, class U>
constexpr VECTOR2< std::common_type_t< T, U > >	operator+ (const VECTOR2< T > &aLHS, const VECTOR2< U > &aRHS)
template<FloatingPoint T, class U>
constexpr VECTOR2< T >	operator+ (const VECTOR2< T > &aLHS, const U &aScalar)
template<class T, class U>
constexpr VECTOR2< std::common_type_t< T, U > >	operator- (const VECTOR2< T > &aLHS, const VECTOR2< U > &aRHS)
template<FloatingPoint T, class U>
constexpr VECTOR2< T >	operator- (const VECTOR2< T > &aLHS, U aScalar)
template<Integral T, FloatingPoint U>
constexpr VECTOR2< T >	operator- (const VECTOR2< T > &aLHS, const U &aScalar)
template<class T, class U>
constexpr auto	operator* (const VECTOR2< T > &aLHS, const VECTOR2< U > &aRHS)
template<class T, class U>
constexpr VECTOR2< std::common_type_t< T, U > >	operator* (const VECTOR2< T > &aLHS, const U &aScalar)
template<class T, class U>
constexpr VECTOR2< std::common_type_t< T, U > >	operator* (const T &aScalar, const VECTOR2< U > &aVector)
template<class T>
constexpr const VECTOR2< T > &	LexicographicalMax (const VECTOR2< T > &aA, const VECTOR2< T > &aB)
template<class T>
constexpr const VECTOR2< T > &	LexicographicalMin (const VECTOR2< T > &aA, const VECTOR2< T > &aB)
template<class T>
constexpr int	LexicographicalCompare (const VECTOR2< T > &aA, const VECTOR2< T > &aB)
template<class T>
std::enable_if<!std::numeric_limits< T >::is_integer, bool >::type	equals (VECTOR2< T > const &aFirst, VECTOR2< T > const &aSecond, T aEpsilon=std::numeric_limits< T >::epsilon())
	Template to compare two VECTOR2<T> values for equality within a required epsilon.
constexpr VECTOR2I	KiROUND (const VECTOR2D &vec)

Typedef Documentation

VECTOR2D

typedef VECTOR2<double> VECTOR2D

Definition at line 694 of file vector2d.h.

VECTOR2I

typedef VECTOR2<int32_t> VECTOR2I

Definition at line 695 of file vector2d.h.

VECTOR2L

typedef VECTOR2<int64_t> VECTOR2L

Definition at line 696 of file vector2d.h.

Function Documentation

equals()

template<class T>

std::enable_if<!std::numeric_limits< T >::is_integer, bool >::type equals	(	VECTOR2< T > const &	aFirst,
		VECTOR2< T > const &	aSecond,
		T	aEpsilon = std::numeric_limits<T>::epsilon() )

Template to compare two VECTOR2<T> values for equality within a required epsilon.

Not constexpr until C++23 (without forgoing std::abs in equals)

Parameters

aFirst	value to compare.
aSecond	value to compare.
aEpsilon	allowed error.

Returns

true if the values considered equal within the specified epsilon, otherwise false.

Definition at line 674 of file vector2d.h.

References equals(), T, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by equals().

KiROUND()

VECTOR2I KiROUND ( const VECTOR2D & vec )

inlineconstexpr

Definition at line 699 of file vector2d.h.

References KiROUND(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by VECTOR2< T >::EuclideanNorm(), KiROUND(), operator-(), VECTOR2< T >::operator/(), and VECTOR2< T >::Resize().

LexicographicalCompare()

template<class T>

int LexicographicalCompare ( const VECTOR2< T > & aA, const VECTOR2< T > & aB )

constexpr

Definition at line 644 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), checkSelfIntersections(), DoOvalPointTestChecks(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), and KIGEOM::NormalisedSeg().

LexicographicalMax()

template<class T>

const VECTOR2< T > & LexicographicalMax ( const VECTOR2< T > & aA, const VECTOR2< T > & aB )

constexpr

Definition at line 620 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

LexicographicalMin()

template<class T>

const VECTOR2< T > & LexicographicalMin ( const VECTOR2< T > & aA, const VECTOR2< T > & aB )

constexpr

Definition at line 632 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE().

operator*() [1/3]

template<class T, class U>

VECTOR2< std::common_type_t< T, U > > operator* ( const T & aScalar, const VECTOR2< U > & aVector )

constexpr

Definition at line 529 of file vector2d.h.

References T, VECTOR2< T >::x, and VECTOR2< T >::y.

operator*() [2/3]

template<class T, class U>

VECTOR2< std::common_type_t< T, U > > operator* ( const VECTOR2< T > & aLHS, const U & aScalar )

constexpr

Definition at line 522 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

operator*() [3/3]

template<class T, class U>

auto operator* ( const VECTOR2< T > & aLHS, const VECTOR2< U > & aRHS )

constexpr

Definition at line 513 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

operator+() [1/2]

template<FloatingPoint T, class U>

VECTOR2< T > operator+ ( const VECTOR2< T > & aLHS, const U & aScalar )

constexpr

Definition at line 449 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

operator+() [2/2]

template<class T, class U>

VECTOR2< std::common_type_t< T, U > > operator+ ( const VECTOR2< T > & aLHS, const VECTOR2< U > & aRHS )

constexpr

Definition at line 441 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

operator-() [1/3]

template<Integral T, FloatingPoint U>

VECTOR2< T > operator- ( const VECTOR2< T > & aLHS, const U & aScalar )

constexpr

Definition at line 495 of file vector2d.h.

References KiROUND(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

operator-() [2/3]

template<class T, class U>

VECTOR2< std::common_type_t< T, U > > operator- ( const VECTOR2< T > & aLHS, const VECTOR2< U > & aRHS )

constexpr

Definition at line 472 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

operator-() [3/3]

template<FloatingPoint T, class U>

VECTOR2< T > operator- ( const VECTOR2< T > & aLHS, U aScalar )

constexpr

Definition at line 480 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

operator<<()

template<class T>

std::ostream & operator<<	(	std::ostream &	aStream,
		const VECTOR2< T > &	aVector )

Definition at line 687 of file vector2d.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.