PVectors2I (com.io7m.jtensors.documentation 8.1.0 API)

java.lang.Object
- com.io7m.jtensors.core.parameterized.vectors.PVectors2I

```
public final class PVectors2I
extends Object
```
Functions over PVector2I values.

See "Mathematics for 3D Game Programming and Computer Graphics" 2nd Ed for the derivations of most of the code in this class (ISBN: 1-58450-277-0).

Since:

8.0.0

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> PVector2I<T>`	`absolute(PVector2I<T> v0)` Calculate the absolute of `v0`.
`static <T> PVector2I<T>`	`add(PVector2I<T> v0, PVector2I<T> v1)` Add `v0` to `v1`.
`static <T> PVector2I<T>`	`addScaled(PVector2I<T> v0, PVector2I<T> v1, double r)` Add `v0` to `v1 * r`.
`static <T> double`	`angle(PVector2I<T> v0, PVector2I<T> v1)` Calculate the angle between the vectors `v0` and `v1` in radians.
`static <T> PVector2I<T>`	`clamp(PVector2I<T> v, PVector2I<T> v_min, PVector2I<T> v_max)` Clamp the values in `v` by `v_min` and `v_max`.
`static <T> long`	`distance(PVector2I<T> v0, PVector2I<T> v1)` Calculate the distance between `v0` and `v1`.
`static <T> long`	`dotProduct(PVector2I<T> v0, PVector2I<T> v1)` Calculate the scalar product of the vectors `v0` and `v1`.
`static <T> PVector2I<T>`	`interpolateLinear(PVector2I<T> v0, PVector2I<T> v1, double alpha)` Linearly interpolate between `v0` and `v1` by the amount `alpha`.
`static <T> double`	`magnitude(PVector2I<T> v0)` Calculate the magnitude of the vector `v0`.
`static <T> long`	`magnitudeSquared(PVector2I<T> v0)` Calculate the squared magnitude of the vector `v0`.
`static <T> PVector2I<T>`	`negate(PVector2I<T> v)` Calculate the negation of `v`.
`static <T> PVector2I<T>`	`scale(PVector2I<T> v0, double r)` Scale `v0` by `r`.
`static <T> PVector2I<T>`	`subtract(PVector2I<T> v0, PVector2I<T> v1)` Subtract `v1` from `v0`.
`static <A> PVector2I<A>`	`toParameterized(Vector2I v)`
`static <A> Vector2I`	`toUnparameterized(PVector2I<A> v)`
`static <T> PVector2I<T>`	`zero()` The zero vector.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - absolute
```
public static <T> PVector2I<T> absolute(PVector2I<T> v0)
```
    Calculate the absolute of v0.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The vector
    
    Returns:
    
    (abs v0.x, abs v0.y)
  - add
```
public static <T> PVector2I<T> add(PVector2I<T> v0,
                                   PVector2I<T> v1)
```
    Add v0 to v1.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The left vector
    
    Parameters:
    
    v1 - The right vector
    
    Returns:
    
    (v0.x + v1.x, v0.y + v0.y)
  - addScaled
```
public static <T> PVector2I<T> addScaled(PVector2I<T> v0,
                                         PVector2I<T> v1,
                                         double r)
```
    Add v0 to v1 * r.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The left vector
    
    Parameters:
    
    v1 - The right vector
    
    r - The scaling value
    
    Returns:
    
    (v0.x + (v1.x * r), v0.y + (v0.y * r))
  - angle
```
public static <T> double angle(PVector2I<T> v0,
                               PVector2I<T> v1)
```
    Calculate the angle between the vectors v0 and v1 in radians.
    
    Type Parameters:
    
    T - A phantom type parameter * @return The angle between the two vectors, in radians.
    
    Parameters:
    
    v0 - The left input vector
    
    v1 - The right input vector
  - clamp
```
public static <T> PVector2I<T> clamp(PVector2I<T> v,
                                     PVector2I<T> v_min,
                                     PVector2I<T> v_max)
```
    Clamp the values in v by v_min and v_max.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v The source vector
    
    Parameters:
    
    v_min - The minimum vector
    
    v_max - The maximum vector
    
    Returns:
    
    (max(min(v.x, v_max.x()), v_min.x()), max(min(v.y, v_max.y()), v_min.y()))
  - distance
```
public static <T> long distance(PVector2I<T> v0,
                                PVector2I<T> v1)
```
    Calculate the distance between v0 and v1.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The left vector
    
    Parameters:
    
    v1 - The right vector
    
    Returns:
    
    The distance between v0 and v1.
  - dotProduct
```
public static <T> long dotProduct(PVector2I<T> v0,
                                  PVector2I<T> v1)
```
    Calculate the scalar product of the vectors v0 and v1.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The left vector
    
    Parameters:
    
    v1 - The right vector
    
    Returns:
    
    The scalar product of the two vectors
  - interpolateLinear
```
public static <T> PVector2I<T> interpolateLinear(PVector2I<T> v0,
                                                 PVector2I<T> v1,
                                                 double alpha)
```
    Linearly interpolate between v0 and v1 by the amount alpha.
    
    The alpha parameter controls the degree of interpolation, such that:
    - interpolateLinear(v0, v1, 0.0) = v0
    - interpolateLinear(v0, v1, 1.0) = v1
    Type Parameters:
    
    T - A phantom type parameter * @return ((1 - alpha) * v0) + (alpha * v1)
    
    Parameters:
    
    v0 - The left input vector
    
    v1 - The right input vector
    
    alpha - The interpolation value in the range [0, 1]
  - magnitudeSquared
```
public static <T> long magnitudeSquared(PVector2I<T> v0)
```
    Calculate the squared magnitude of the vector v0.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The vector
    
    Returns:
    
    The squared magnitude of the vector
  - magnitude
```
public static <T> double magnitude(PVector2I<T> v0)
```
    Calculate the magnitude of the vector v0.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The vector
    
    Returns:
    
    The magnitude of the vector
  - negate
```
public static <T> PVector2I<T> negate(PVector2I<T> v)
```
    Calculate the negation of v.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v The vector
    
    Returns:
    
    (-v.x, -v.y)
  - scale
```
public static <T> PVector2I<T> scale(PVector2I<T> v0,
                                     double r)
```
    Scale v0 by r.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The left vector
    
    Parameters:
    
    r - The scaling value
    
    Returns:
    
    (v0.x * r, v0.y * r)
  - subtract
```
public static <T> PVector2I<T> subtract(PVector2I<T> v0,
                                        PVector2I<T> v1)
```
    Subtract v1 from v0.
    
    Type Parameters:
    
    T - A phantom type parameter * @param v0 The left vector
    
    Parameters:
    
    v1 - The right vector
    
    Returns:
    
    (v0.x - v1.x, v0.y - v0.y)
  - zero
```
public static <T> PVector2I<T> zero()
```
    The zero vector.
    
    Type Parameters:
    
    T - A phantom type parameter
    
    Returns:
    
    (0, 0)
  - toUnparameterized
```
public static <A> Vector2I toUnparameterized(PVector2I<A> v)
```
    Type Parameters:
    
    A - A phantom type parameter (possibly representing a coordinate system)
    
    Parameters:
    
    v - The input vector
    
    Returns:
    
    A vector equal to m but without type parameters
  - toParameterized
```
public static <A> PVector2I<A> toParameterized(Vector2I v)
```
    Type Parameters:
    
    A - A phantom type parameter (possibly representing a coordinate system)
    
    Parameters:
    
    v - The input vector
    
    Returns:
    
    A vector equal to v with type parameters

Class PVectors2I

Method Summary

Methods inherited from class java.lang.Object

Method Detail

absolute

add

addScaled

angle

clamp

distance

dotProduct

interpolateLinear

magnitudeSquared

magnitude

negate

scale

subtract

zero

toUnparameterized

toParameterized