#include <ImathVec.h>

Public Types
typedef T	BaseType

Public Member Functions
IMATH_HOSTDEVICE IMATH_CONSTEXPR14 T &	operator[] (int i) IMATH_NOEXCEPT

IMATH_HOSTDEVICE constexpr const T &	operator[] (int i) const IMATH_NOEXCEPT

Constructors and Assignment
IMATH_HOSTDEVICE	Vec2 () IMATH_NOEXCEPT
	Uninitialized by default. More...

IMATH_HOSTDEVICE constexpr	Vec2 (T a) IMATH_NOEXCEPT
	Initialize to a scalar `(a,a)` More...

IMATH_HOSTDEVICE constexpr	Vec2 (T a, T b) IMATH_NOEXCEPT
	Initialize to given elements `(a,b)` More...

IMATH_HOSTDEVICE constexpr	Vec2 (const Vec2 &v) IMATH_NOEXCEPT
	Copy constructor. More...

template<class S >
IMATH_HOSTDEVICE constexpr	Vec2 (const Vec2< S > &v) IMATH_NOEXCEPT
	Construct from Vec2 of another base type. More...

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	operator= (const Vec2 &v) IMATH_NOEXCEPT
	Assignment. More...

	~Vec2 () IMATH_NOEXCEPT=default
	Destructor. More...

Interoperability with other vector types
Construction and assignment are allowed from other classes that appear to be equivalent vector types, provided that they have either a subscripting operator, or data members .x and .y, that are of the same type as the elements of this vector, and their size appears to be the right number of elements. This functionality is disabled for gcc 4.x, which seems to have a compiler bug that results in spurious errors. It can also be disabled by defining IMATH_FOREIGN_VECTOR_INTEROP to be 0 prior to including any Imath header files.
template<typename V , IMATH_ENABLE_IF(has_xy< V, T >::value) >
IMATH_HOSTDEVICE constexpr	Vec2 (const V &v) IMATH_NOEXCEPT

template<typename V , IMATH_ENABLE_IF(has_subscript< V, T, 2 >::value &&!has_xy< V, T >::value) >
IMATH_HOSTDEVICE	Vec2 (const V &v)

template<typename V , IMATH_ENABLE_IF(has_xy< V, T >::value) >
IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	operator= (const V &v) IMATH_NOEXCEPT

template<typename V , IMATH_ENABLE_IF(has_subscript< V, T, 2 >::value &&!has_xy< V, T >::value) >
IMATH_HOSTDEVICE const Vec2 &	operator= (const V &v)

Compatibility with Sb
template<class S >
IMATH_HOSTDEVICE void	setValue (S a, S b) IMATH_NOEXCEPT
	Set the value. More...

template<class S >
IMATH_HOSTDEVICE void	setValue (const Vec2< S > &v) IMATH_NOEXCEPT
	Set the value. More...

template<class S >
IMATH_HOSTDEVICE void	getValue (S &a, S &b) const IMATH_NOEXCEPT
	Return the value in `a` and `b` More...

template<class S >
IMATH_HOSTDEVICE void	getValue (Vec2< S > &v) const IMATH_NOEXCEPT
	Return the value in `v` More...

IMATH_HOSTDEVICE T *	getValue () IMATH_NOEXCEPT
	Return a raw pointer to the array of values. More...

IMATH_HOSTDEVICE const T *	getValue () const IMATH_NOEXCEPT
	Return a raw pointer to the array of values. More...

Arithmetic and Comparison
template<class S >
IMATH_HOSTDEVICE constexpr bool	operator== (const Vec2< S > &v) const IMATH_NOEXCEPT
	Equality. More...

template<class S >
IMATH_HOSTDEVICE constexpr bool	operator!= (const Vec2< S > &v) const IMATH_NOEXCEPT
	Inequality. More...

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool	equalWithAbsError (const Vec2< T > &v, T e) const IMATH_NOEXCEPT

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool	equalWithRelError (const Vec2< T > &v, T e) const IMATH_NOEXCEPT

IMATH_HOSTDEVICE constexpr T	dot (const Vec2 &v) const IMATH_NOEXCEPT
	Dot product. More...

IMATH_HOSTDEVICE constexpr T	operator^ (const Vec2 &v) const IMATH_NOEXCEPT
	Dot product. More...

IMATH_HOSTDEVICE constexpr T	cross (const Vec2 &v) const IMATH_NOEXCEPT

IMATH_HOSTDEVICE constexpr T	operator% (const Vec2 &v) const IMATH_NOEXCEPT

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	operator+= (const Vec2 &v) IMATH_NOEXCEPT
	Component-wise addition. More...

IMATH_HOSTDEVICE constexpr Vec2	operator+ (const Vec2 &v) const IMATH_NOEXCEPT
	Component-wise addition. More...

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	operator-= (const Vec2 &v) IMATH_NOEXCEPT
	Component-wise subtraction. More...

IMATH_HOSTDEVICE constexpr Vec2	operator- (const Vec2 &v) const IMATH_NOEXCEPT
	Component-wise subtraction. More...

IMATH_HOSTDEVICE constexpr Vec2	operator- () const IMATH_NOEXCEPT
	Component-wise multiplication by -1. More...

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	negate () IMATH_NOEXCEPT
	Component-wise multiplication by -1. More...

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	operator*= (const Vec2 &v) IMATH_NOEXCEPT
	Component-wise multiplication. More...

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	operator*= (T a) IMATH_NOEXCEPT
	Component-wise multiplication. More...

IMATH_HOSTDEVICE constexpr Vec2	operator* (const Vec2 &v) const IMATH_NOEXCEPT
	Component-wise multiplication. More...

IMATH_HOSTDEVICE constexpr Vec2	operator* (T a) const IMATH_NOEXCEPT
	Component-wise multiplication. More...

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	operator/= (const Vec2 &v) IMATH_NOEXCEPT
	Component-wise division. More...

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2 &	operator/= (T a) IMATH_NOEXCEPT
	Component-wise division. More...

IMATH_HOSTDEVICE constexpr Vec2	operator/ (const Vec2 &v) const IMATH_NOEXCEPT
	Component-wise division. More...

IMATH_HOSTDEVICE constexpr Vec2	operator/ (T a) const IMATH_NOEXCEPT
	Component-wise division. More...

Query and Manipulation
IMATH_HOSTDEVICE T	length () const IMATH_NOEXCEPT
	Return the Euclidean norm. More...

IMATH_HOSTDEVICE constexpr T	length2 () const IMATH_NOEXCEPT

IMATH_HOSTDEVICE const Vec2 &	normalize () IMATH_NOEXCEPT
	Normalize in place. If length()==0, return a null vector. More...

const Vec2 &	normalizeExc ()
	Normalize in place. If length()==0, throw an exception. More...

IMATH_HOSTDEVICE const Vec2 &	normalizeNonNull () IMATH_NOEXCEPT

IMATH_HOSTDEVICE Vec2< T >	normalized () const IMATH_NOEXCEPT
	Return a normalized vector. Does not modify *this. More...

Vec2< T >	normalizedExc () const

IMATH_HOSTDEVICE Vec2< T >	normalizedNonNull () const IMATH_NOEXCEPT

Static Public Member Functions
IMATH_HOSTDEVICE static constexpr unsigned int	dimensions () IMATH_NOEXCEPT
	Return the number of dimensions, i.e. 2. More...

Numeric Limits
IMATH_HOSTDEVICE static constexpr T	baseTypeLowest () IMATH_NOEXCEPT
	Largest possible negative value. More...

IMATH_HOSTDEVICE static constexpr T	baseTypeMax () IMATH_NOEXCEPT
	Largest possible positive value. More...

IMATH_HOSTDEVICE static constexpr T	baseTypeSmallest () IMATH_NOEXCEPT
	Smallest possible positive value. More...

IMATH_HOSTDEVICE static constexpr T	baseTypeEpsilon () IMATH_NOEXCEPT
	Smallest possible e for which 1+e != 1. More...

Public Attributes
Direct access to elements
T	x

T	y

Detailed Description

template<class T>
class Vec2< T >

2-element vector

Definition at line 39 of file ImathVec.h.

Member Typedef Documentation

template<class T>

typedef T Vec2< T >::BaseType

The base type: In templates that accept a parameter V, you can refer to T as V::BaseType

Definition at line 352 of file ImathVec.h.

Constructor & Destructor Documentation

template<class T >

IMATH_HOSTDEVICE Vec2< T >::Vec2 ( )

inline

Uninitialized by default.

Definition at line 1288 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T >::Vec2 ( T a )

inlineexplicit

Initialize to a scalar (a,a)

Definition at line 1294 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T >::Vec2	(	T	a,
		T	b
	)

inline

Initialize to given elements (a,b)

Definition at line 1299 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T >::Vec2 ( const Vec2< T > & v )

inline

Copy constructor.

Definition at line 1305 of file ImathVec.h.

template<class T >

template<class S >

IMATH_HOSTDEVICE constexpr Vec2< T >::Vec2 ( const Vec2< S > & v )

inline

Construct from Vec2 of another base type.

Definition at line 1312 of file ImathVec.h.

template<class T>

Vec2< T >::~Vec2 ( )

default

Destructor.

template<class T>

template<typename V , IMATH_ENABLE_IF(has_xy< V, T >::value) >

IMATH_HOSTDEVICE constexpr Vec2< T >::Vec2 ( const V & v )

inlineexplicit

Definition at line 126 of file ImathVec.h.

template<class T>

template<typename V , IMATH_ENABLE_IF(has_subscript< V, T, 2 >::value &&!has_xy< V, T >::value) >

IMATH_HOSTDEVICE Vec2< T >::Vec2 ( const V & v )

inlineexplicit

Definition at line 133 of file ImathVec.h.

Member Function Documentation

template<class T>

IMATH_HOSTDEVICE static constexpr T Vec2< T >::baseTypeEpsilon ( )

inlinestatic

Smallest possible e for which 1+e != 1.

Definition at line 337 of file ImathVec.h.

template<class T>

IMATH_HOSTDEVICE static constexpr T Vec2< T >::baseTypeLowest ( )

inlinestatic

Largest possible negative value.

Definition at line 319 of file ImathVec.h.

template<class T>

IMATH_HOSTDEVICE static constexpr T Vec2< T >::baseTypeMax ( )

inlinestatic

Largest possible positive value.

Definition at line 325 of file ImathVec.h.

template<class T>

IMATH_HOSTDEVICE static constexpr T Vec2< T >::baseTypeSmallest ( )

inlinestatic

Smallest possible positive value.

Definition at line 331 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr T Vec2< T >::cross ( const Vec2< T > & v ) const

inline

Right-handed cross product, i.e. z component of Vec3 (this->x, this->y, 0) % Vec3 (v.x, v.y, 0)

Definition at line 1432 of file ImathVec.h.

template<class T>

IMATH_HOSTDEVICE static constexpr unsigned int Vec2< T >::dimensions ( )

inlinestatic

Return the number of dimensions, i.e. 2.

Definition at line 345 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr T Vec2< T >::dot ( const Vec2< T > & v ) const

inline

Dot product.

Definition at line 1418 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool Vec2< T >::equalWithAbsError	(	const Vec2< T > &	v,
		T	e
	)		const

inline

Compare two vectors and test if they are "approximately equal":

Returns

True if the components of this and v are the same with an absolute error of no more than e, i.e., for all i:

abs (this[i] - v[i]) <= e

Definition at line 1394 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 bool Vec2< T >::equalWithRelError	(	const Vec2< T > &	v,
		T	e
	)		const

inline

Compare two vectors and test if they are "approximately equal":

Returns

True if the components of this and v are the same with a relative error of no more than e, i.e., for all i:

abs (this[i] - v[i]) <= e * abs (this[i])

Definition at line 1406 of file ImathVec.h.

template<class T >

template<class S >

IMATH_HOSTDEVICE void Vec2< T >::getValue	(	S &	a,
		S &	b
	)		const

inline

Return the value in a and b

Definition at line 1347 of file ImathVec.h.

template<class T >

template<class S >

IMATH_HOSTDEVICE void Vec2< T >::getValue ( Vec2< S > & v ) const

inline

Return the value in v

Definition at line 1356 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE T * Vec2< T >::getValue ( )

inline

Return a raw pointer to the array of values.

Definition at line 1364 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE const T * Vec2< T >::getValue ( ) const

inline

Return a raw pointer to the array of values.

Definition at line 1371 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE T Vec2< T >::length ( void ) const

inline

Return the Euclidean norm.

Definition at line 1583 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr T Vec2< T >::length2 ( ) const

inline

Return the square of the Euclidean norm, i.e. the dot product with itself.

Definition at line 1595 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2< T > & Vec2< T >::negate ( )

inline

Component-wise multiplication by -1.

Definition at line 1485 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE const Vec2< T > & Vec2< T >::normalize ( )

inline

Normalize in place. If length()==0, return a null vector.

Definition at line 1602 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE Vec2< T > Vec2< T >::normalized ( ) const

inline

Return a normalized vector. Does not modify *this.

Definition at line 1647 of file ImathVec.h.

template<class T >

Vec2< T > Vec2< T >::normalizedExc ( ) const

inline

Return a normalized vector. Does not modify *this. Throw an exception if length()==0.

Definition at line 1658 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE Vec2< T > Vec2< T >::normalizedNonNull ( ) const

inline

Return a normalized vector. Does not modify *this, and does not check for length()==0. Slightly faster than the other normalization routines, but if v.length() is 0.0, the result is undefined.

Definition at line 1670 of file ImathVec.h.

template<class T >

const Vec2< T > & Vec2< T >::normalizeExc ( )

inline

Normalize in place. If length()==0, throw an exception.

Definition at line 1623 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE const Vec2< T > & Vec2< T >::normalizeNonNull ( )

inline

Normalize without any checks for length()==0. Slightly faster than the other normalization routines, but if v.length() is 0.0, the result is undefined.

Definition at line 1637 of file ImathVec.h.

template<class T >

template<class S >

IMATH_HOSTDEVICE constexpr bool Vec2< T >::operator!= ( const Vec2< S > & v ) const

inline

Inequality.

Definition at line 1387 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr T Vec2< T >::operator% ( const Vec2< T > & v ) const

inline

Right-handed cross product, i.e. z component of Vec3 (this->x, this->y, 0) % Vec3 (v.x, v.y, 0)

Definition at line 1439 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T > Vec2< T >::operator* ( const Vec2< T > & v ) const

inline

Component-wise multiplication.

Definition at line 1512 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T > Vec2< T >::operator* ( T a ) const

inline

Component-wise multiplication.

Definition at line 1519 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2< T > & Vec2< T >::operator*= ( const Vec2< T > & v )

inline

Component-wise multiplication.

Definition at line 1494 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2< T > & Vec2< T >::operator*= ( T a )

inline

Component-wise multiplication.

Definition at line 1503 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T > Vec2< T >::operator+ ( const Vec2< T > & v ) const

inline

Component-wise addition.

Definition at line 1455 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2< T > & Vec2< T >::operator+= ( const Vec2< T > & v )

inline

Component-wise addition.

Definition at line 1446 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T > Vec2< T >::operator- ( const Vec2< T > & v ) const

inline

Component-wise subtraction.

Definition at line 1471 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T > Vec2< T >::operator- ( ) const

inline

Component-wise multiplication by -1.

Definition at line 1478 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2< T > & Vec2< T >::operator-= ( const Vec2< T > & v )

inline

Component-wise subtraction.

Definition at line 1462 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T > Vec2< T >::operator/ ( const Vec2< T > & v ) const

inline

Component-wise division.

Definition at line 1544 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr Vec2< T > Vec2< T >::operator/ ( T a ) const

inline

Component-wise division.

Definition at line 1551 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2< T > & Vec2< T >::operator/= ( const Vec2< T > & v )

inline

Component-wise division.

Definition at line 1526 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2< T > & Vec2< T >::operator/= ( T a )

inline

Component-wise division.

Definition at line 1535 of file ImathVec.h.

template<class T >

IMATH_CONSTEXPR14 IMATH_HOSTDEVICE const Vec2< T > & Vec2< T >::operator= ( const Vec2< T > & v )

inline

Assignment.

Definition at line 1319 of file ImathVec.h.

template<class T>

template<typename V , IMATH_ENABLE_IF(has_xy< V, T >::value) >

IMATH_HOSTDEVICE IMATH_CONSTEXPR14 const Vec2& Vec2< T >::operator= ( const V & v )

inline

Definition at line 138 of file ImathVec.h.

template<class T>

template<typename V , IMATH_ENABLE_IF(has_subscript< V, T, 2 >::value &&!has_xy< V, T >::value) >

IMATH_HOSTDEVICE const Vec2& Vec2< T >::operator= ( const V & v )

inline

Definition at line 148 of file ImathVec.h.

template<class T >

template<class S >

IMATH_HOSTDEVICE constexpr bool Vec2< T >::operator== ( const Vec2< S > & v ) const

inline

Equality.

Definition at line 1379 of file ImathVec.h.

template<class T >

Doxygen_Suppress IMATH_CONSTEXPR14 IMATH_HOSTDEVICE T & Vec2< T >::operator[] ( int i )

inline

Element access by index.

NB: This method of access may use dynamic array accesses which can prevent compiler optimizations and force temporaries to be stored to the stack and other missed vectorization opportunities. Use of direct access to x, y when possible should be preferred.

Definition at line 1265 of file ImathVec.h.

template<class T >

constexpr IMATH_HOSTDEVICE const T & Vec2< T >::operator[] ( int i ) const

inline

Element access by index.

NB: This method of access may use dynamic array accesses which can prevent compiler optimizations and force temporaries to be stored to the stack and other missed vectorization opportunities. Use of direct access to x, y when possible should be preferred.

Definition at line 1272 of file ImathVec.h.

template<class T >

IMATH_HOSTDEVICE constexpr T Vec2< T >::operator^ ( const Vec2< T > & v ) const

inline

Dot product.

Definition at line 1425 of file ImathVec.h.

template<class T >

template<class S >

IMATH_HOSTDEVICE void Vec2< T >::setValue	(	S	a,
		S	b
	)

inline

Set the value.

Definition at line 1329 of file ImathVec.h.

template<class T >

template<class S >

IMATH_HOSTDEVICE void Vec2< T >::setValue ( const Vec2< S > & v )

inline

Set the value.

Definition at line 1338 of file ImathVec.h.

Member Data Documentation

template<class T>

T Vec2< T >::x

Definition at line 59 of file ImathVec.h.

template<class T>

T Vec2< T >::y

Definition at line 59 of file ImathVec.h.

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

Imath/ImathVec.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

template<class T> class Vec2< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class Vec2< T >