====== Tuple2 ======

===== Description =====

tTuple2.h provides a 2 element tuple represented by a user-provided type, which is commonly a floating or fixed point type.

The type is immutable, meaning that once constructed, no methods modify the members.

===== Methods =====

Trivial operations are provided via operator overloading.
^ Operation ^ Math ^
| Negation | <m 9>vec{a} = -vec{b}</m> |
| Subtraction | <m 9>vec{a} = vec{b} - vec{c}</m> |
| Addition | <m 9>vec{a} = vec{b} + vec{c}</m> |
| Scalar Multiplication | <m 9>vec{a} = s vec{b}</m>|

<code cpp>inline const tTuple2 tTuple2::absolute() const;</code>
**absolute** returns the following: <m 9><delim{|}{x}{|}, delim{|}{y}{|}></m>

<code cpp>inline const tTuple2 tTuple2::clamp(T minval, T maxval) const;</code>
**clamp** ensures each component is within the range <m 9>delim{[}{minval, maxval}{]}</m>

<code cpp>inline T tPoint2::distance(const tPoint2 &other) const;</code>
**distance** calculates the distance between two points, a and b: <m 9>sqrt{(a_x - b_x)^2 + (a_y - b_y)^2}</m>

<code cpp>inline T tPoint2::distanceSquared(const tPoint2 &other) const;</code>
**distanceSquared** calculates the square of the distance between two points, a and b: <m 9>(a_x - b_x)^2 + (a_y - b_y)^2</m>

<code cpp>inline T tVector2::angle(const tVector2 &other) const;</code>
**angle** calculates the angle between two vectors(in radians): <m 9>theta = cos^{-1}({a dot b}/{delim{vert}{a}{vert} delim{vert}{b}{vert}})</m>

<code cpp>inline T tVector2::dot(const tVector2 &other) const;</code>
**dot** calculates the dot/inner/scalar product: <m 9>a dot b = a_x b_x + a_y b_y = delim{vert}{a}{vert} delim{vert}{b}{vert} cos(theta)</m>

<code cpp>inline T tVector2::length() const;</code>
**length** calculates the length/magnitude of the vector: <m 9>delim{vert}{a}{vert} = sqrt{{a_x}^2 + {a_y}^2}</m>

<code cpp>inline T tVector2::lengthSquared() const;</code>
**lengthSquared** calculates the square of the length/magnitude of the vector: <m 9>{delim{vert}{a}{vert}}^2 = {a_x}^2 + {a_y}^2</m>

<code cpp>inline const tVector2 tVector2::unit() const;</code>
**unit** returns the unit vector for this vector: <m 9>{1/{delim{vert}{a}{vert}}}a</m>

===== Typedefs =====

<code cpp>
typedef tTuple2<tFloat32> tTuple2f;
typedef tPoint2<tFloat32> tPoint2f;
typedef tVector2<tFloat32> tVector2f;
typedef tTexCoord2<tFloat32> tTexCoord2f;
</code>

===== Notes =====

  * None