## Uses of Interface
com.io7m.jtensors.VectorReadable2DType

- Packages that use VectorReadable2DType
  Package | Description
  --- | ---
  com.io7m.jtensors |

- - ### Uses of VectorReadable2DType in com.io7m.jtensors

    Subinterfaces of VectorReadable2DType in com.io7m.jtensors
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `QuaternionReadable4DType` 'Read' interface to four-dimensional quaternions with double precision elements.
    `interface` | `VectorReadable3DType` 'Read' interface to three-dimensional vectors with double precision elements.
    `interface` | `VectorReadable4DType` 'Read' interface to four-dimensional vectors with double precision elements.

    Classes in com.io7m.jtensors that implement VectorReadable2DType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `QuaternionI4D` A four-dimensional immutable quaternion type with double precision elements.
    `class` | `QuaternionM4D` A four-dimensional mutable quaternion type with double precision elements.
    `class` | `VectorI2D` A two-dimensional immutable vector type with double precision elements.
    `class` | `VectorI3D` A three-dimensional immutable vector type with double precision elements.
    `class` | `VectorI4D` A four-dimensional immutable vector type with double precision elements.
    `class` | `VectorM2D` A two-dimensional mutable vector type with double precision elements.
    `class` | `VectorM3D` A three-dimensional mutable vector type with double precision elements.
    `class` | `VectorM4D` A four-dimensional mutable vector type with double precision elements.

    Methods in com.io7m.jtensors with parameters of type VectorReadable2DType
    Modifier and Type | Method and Description
    --- | ---
    `static VectorI2D` | VectorI2D.`absolute(VectorReadable2DType v)` Calculate the absolute value of the vector `v`.
    `static VectorM2D` | VectorM2D.`absolute(VectorReadable2DType v, VectorM2D out)` Calculate the absolute values of the elements in vector `v`, saving the result to `out`.
    `static VectorI2D` | VectorI2D.`add(VectorReadable2DType v0, VectorReadable2DType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`.
    `static VectorM2D` | VectorM2D.`add(VectorReadable2DType v0, VectorReadable2DType v1, VectorM2D out)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `out`.
    `static VectorM2D` | VectorM2D.`addInPlace(VectorM2D v0, VectorReadable2DType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `v0`.
    `static VectorI2D` | VectorI2D.`addScaled(VectorReadable2DType v0, VectorReadable2DType v1, double r)` Calculate the element-wise sum of the vectors `v0` and the element-wise product of `v1` and `r`.
    `static VectorM2D` | VectorM2D.`addScaled(VectorReadable2DType v0, VectorReadable2DType v1, double r, VectorM2D out)` Calculate the element-wise sum of the vectors `v0` and the element-wise product of `v1` and `r`, saving the result to `out`.
    `static VectorM2D` | VectorM2D.`addScaledInPlace(VectorM2D v0, VectorReadable2DType v1, double r)` Calculate the element-wise sum of the vectors `v0` and the element-wise product of `v1` and `r`, saving the result to `v0`.
    `static boolean` | VectorM2D.`almostEqual(com.io7m.jequality.AlmostEqualDouble.ContextRelative context, VectorReadable2DType qa, VectorReadable2DType qb)` Determine whether or not the vectors `qa` and `qb` are equal to within the degree of error given in `context`.
    `static boolean` | VectorI2D.`almostEqual(com.io7m.jequality.AlmostEqualDouble.ContextRelative context, VectorReadable2DType qa, VectorReadable2DType qb)` Determine whether or not the vectors `qa` and `qb` are equal to within the degree of error given in `context`.
    `static double` | VectorM2D.`angle(VectorReadable2DType v0, VectorReadable2DType v1)` Calculate the angle between vectors `v0` and `v1`, in radians.
    `static double` | VectorI2D.`angle(VectorReadable2DType v0, VectorReadable2DType v1)` Calculate the angle between the vectors `v0` and `v1` in radians.
    `static VectorI2D` | VectorI2D.`clamp(VectorReadable2DType v, double minimum, double maximum)` Clamp the elements of the vector `v` to the range `[minimum ..`
    `static VectorM2D` | VectorM2D.`clamp(VectorReadable2DType v, double minimum, double maximum, VectorM2D out)` Clamp the elements of the vector `v` to the range `[minimum ..`
    `static VectorI2D` | VectorI2D.`clampByVector(VectorReadable2DType v, VectorReadable2DType minimum, VectorReadable2DType maximum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum` and `maximum`.
    `static VectorM2D` | VectorM2D.`clampByVector(VectorReadable2DType v, VectorReadable2DType minimum, VectorReadable2DType maximum, VectorM2D out)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum` and `maximum`, saving the result to `out`.
    `static VectorM2D` | VectorM2D.`clampByVectorInPlace(VectorM2D v, VectorReadable2DType minimum, VectorReadable2DType maximum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum` and `maximum`, saving the result to `v`.
    `static VectorI2D` | VectorI2D.`clampMaximum(VectorReadable2DType v, double maximum)` Clamp the elements of the vector `v` to the range `[-Infinity ..`
    `static VectorM2D` | VectorM2D.`clampMaximum(VectorReadable2DType v, double maximum, VectorM2D out)` Clamp the elements of the vector `v` to the range `[-Infinity ..`
    `static VectorI2D` | VectorI2D.`clampMaximumByVector(VectorReadable2DType v, VectorReadable2DType maximum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `maximum`.
    `static VectorM2D` | VectorM2D.`clampMaximumByVector(VectorReadable2DType v, VectorReadable2DType maximum, VectorM2D out)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `maximum`, saving the result to `out`.
    `static VectorM2D` | VectorM2D.`clampMaximumByVectorInPlace(VectorM2D v, VectorReadable2DType maximum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `maximum`, saving the result to `v`.
    `static VectorI2D` | VectorI2D.`clampMinimum(VectorReadable2DType v, double minimum)` Clamp the elements of the vector `v` to the range `[minimum ..`
    `static VectorM2D` | VectorM2D.`clampMinimum(VectorReadable2DType v, double minimum, VectorM2D out)` Clamp the elements of the vector `v` to the range `[minimum ..`
    `static VectorI2D` | VectorI2D.`clampMinimumByVector(VectorReadable2DType v, VectorReadable2DType minimum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum`.
    `static VectorM2D` | VectorM2D.`clampMinimumByVector(VectorReadable2DType v, VectorReadable2DType minimum, VectorM2D out)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum`, saving the result to `out`.
    `static VectorM2D` | VectorM2D.`clampMinimumByVectorInPlace(VectorM2D v, VectorReadable2DType minimum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum`, saving the result to `v`.
    `static VectorWritable2DType` | VectorM2D.`copy(VectorReadable2DType input, VectorWritable2DType output)` Copy all elements of the vector `input` to the vector `output`.
    `void` | VectorWritable2DType.`copyFrom2D(VectorReadable2DType in_v)` Set the current vector to the contents of the input vector.
    `void` | VectorM4D.`copyFrom2D(VectorReadable2DType in_v)`
    `void` | VectorM3D.`copyFrom2D(VectorReadable2DType in_v)`
    `void` | VectorM2D.`copyFrom2D(VectorReadable2DType in_v)`
    `void` | QuaternionM4D.`copyFrom2D(VectorReadable2DType in_v)`
    `static double` | VectorM2D.`distance(VectorReadable2DType v0, VectorReadable2DType v1)` Calculate the distance between the two vectors `v0` and `v1`.
    `static double` | VectorI2D.`distance(VectorReadable2DType v0, VectorReadable2DType v1)` Calculate the distance between the two vectors `v0` and `v1`.
    `static double` | VectorM2D.`dotProduct(VectorReadable2DType v0, VectorReadable2DType v1)` Calculate the scalar product of the vectors `v0` and `v1`.
    `static double` | VectorI2D.`dotProduct(VectorReadable2DType v0, VectorReadable2DType v1)` Calculate the scalar product of the vectors `v0` and `v1`.
    `static VectorI2D` | VectorI2D.`interpolateLinear(VectorReadable2DType v0, VectorReadable2DType v1, double alpha)` Linearly interpolate between `v0` and `v1` by the amount `alpha`.
    `static VectorM2D` | VectorM2D.`interpolateLinear(VectorReadable2DType v0, VectorReadable2DType v1, double alpha, VectorM2D r)` Linearly interpolate between `v0` and `v1` by the amount `alpha`, saving the result to `r`.
    `static double` | VectorM2D.`magnitude(VectorReadable2DType v)` Calculate the magnitude of the vector `v`.
    `static double` | VectorI2D.`magnitude(VectorReadable2DType v)` Calculate the magnitude of the vector `v`.
    `static double` | VectorM2D.`magnitudeSquared(VectorReadable2DType v)` Calculate the squared magnitude of the vector `v`.
    `static double` | VectorI2D.`magnitudeSquared(VectorReadable2DType v)` Calculate the squared magnitude of the vector `v`.
    `static MatrixM3x3D` | MatrixM3x3D.`makeTranslation2D(VectorReadable2DType v, MatrixM3x3D out)` Create a translation matrix that represents a translation by the vector `v`, writing the resulting matrix to `out`.
    `static VectorM2D` | MatrixM2x2D.`multiplyVector2D(MatrixReadable2x2DType m, VectorReadable2DType v, VectorM2D out)` Multiply the matrix `m` with the vector `v`, writing the resulting vector to `out`.
    `static VectorI2D` | VectorI2D.`normalize(VectorReadable2DType v)` Normalize the vector `v`, preserving its direction but reducing it to unit length.
    `static VectorM2D` | VectorM2D.`normalize(VectorReadable2DType v, VectorM2D out)` Returns a vector with the same orientation as `v` but with magnitude equal to `1.0` in `out`.
    `static com.io7m.jfunctional.Pair<VectorM2D,VectorM2D>` | VectorM2D.`orthoNormalize(VectorReadable2DType v0, VectorReadable2DType v1)` Orthonormalize and return the vectors `v0` and `v1` .
    `static com.io7m.jfunctional.Pair<VectorI2D,VectorI2D>` | VectorI2D.`orthoNormalize(VectorReadable2DType v0, VectorReadable2DType v1)` Orthonormalize and return the vectors `v0` and `v1` .
    `static VectorI2D` | VectorI2D.`projection(VectorReadable2DType p, VectorReadable2DType q)` Calculate the projection of the vector `p` onto the vector `q`.
    `static VectorM2D` | VectorM2D.`projection(VectorReadable2DType p, VectorReadable2DType q, VectorM2D r)` Calculate the projection of the vector `p` onto the vector `q`, saving the result in `r`.
    `static VectorI2D` | VectorI2D.`scale(VectorReadable2DType v, double r)` Scale the vector `v` by the scalar `r`.
    `static VectorM2D` | VectorM2D.`scale(VectorReadable2DType v, double r, VectorM2D out)` Scale the vector `v` by the scalar `r`, saving the result to `out`.
    `static VectorI2D` | VectorI2D.`subtract(VectorReadable2DType v0, VectorReadable2DType v1)` Subtract the vector `v1` from the vector `v0`.
    `static VectorM2D` | VectorM2D.`subtract(VectorReadable2DType v0, VectorReadable2DType v1, VectorM2D out)` Subtract the vector `v1` from the vector `v0`, saving the result to `out`.
    `static VectorM2D` | VectorM2D.`subtractInPlace(VectorM2D v0, VectorReadable2DType v1)` Subtract the vector `v1` from the vector `v0`, saving the result to `v0`.
    `static MatrixM3x3D` | MatrixM3x3D.`translateByVector2D(MatrixReadable3x3DType m, VectorReadable2DType v, MatrixM3x3D out)` Translate the matrix `m` by the vector `v`, storing the resulting matrix in `out`.
    `static MatrixM4x4D` | MatrixM4x4D.`translateByVector2D(MatrixReadable4x4DType m, VectorReadable2DType v, MatrixM4x4D out)` Translate the matrix `m` by the vector `v`, storing the resulting matrix in `out`.
    `static MatrixM3x3D` | MatrixM3x3D.`translateByVector2DInPlace(MatrixM3x3D m, VectorReadable2DType v)` Translate the matrix `m` by the vector `v`, storing the resulting matrix in `m`.
    `static MatrixM4x4D` | MatrixM4x4D.`translateByVector2DInPlace(MatrixM4x4D m, VectorReadable2DType v)` Translate the matrix `m` by the vector `v`, storing the resulting matrix in `m`.

    Constructors in com.io7m.jtensors with parameters of type VectorReadable2DType
    Constructor and Description
    `VectorI2D(VectorReadable2DType in_v)` Construct a vector initialized with the values given in the vector `v`.
    `VectorM2D(VectorReadable2DType in_x)` Construct a vector initialized with the values given in the vector `in_x`.

Copyright © 2014 <code@io7m.com> http://io7m.com