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

- Packages that use VectorReadable4FType
  Package | Description
  --- | ---
  com.io7m.jtensors | Core vector and matrix types.
  com.io7m.jtensors.bytebuffered | `ByteBuffer` backed tensors.
  com.io7m.jtensors.bytebuffered.parameterized | `ByteBuffer` backed parameterized tensors.
  com.io7m.jtensors.parameterized | Parameterized vector and matrix types.

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

    Subinterfaces of VectorReadable4FType in com.io7m.jtensors
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Quaternion4FType` The type of mutable quaternions with `float` elements.
    `interface` | `QuaternionReadable4FType` 'Read' interface to four-dimensional quaternions with `float` elements.
    `interface` | `Vector4FType` The type of four-element vectors that are both readable and writable, and have `float` elements

    Classes in com.io7m.jtensors that implement VectorReadable4FType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `QuaternionI4F` A four-dimensional immutable quaternion type with `float` elements.
    `class` | `QuaternionM4F` A four-dimensional mutable quaternion type with `float` elements.
    `class` | `VectorI4F` A four-dimensional immutable vector type with `float` elements.
    `class` | `VectorM4F` A four-dimensional mutable vector type with `float` elements.

    Methods in com.io7m.jtensors with type parameters of type VectorReadable4FType
    Modifier and Type | Method and Description
    --- | ---
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`absoluteInPlace(V v)` Calculate the absolute values of the elements in vector `v`, modifying the vector in-place.
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`addInPlace(V v0, VectorReadable4FType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `v0`.
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`addScaledInPlace(V v0, VectorReadable4FType 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 <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampByVectorInPlace(V v, VectorReadable4FType minimum, VectorReadable4FType 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 <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampInPlace(V v, float minimum, float maximum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampMaximumByVectorInPlace(V v, VectorReadable4FType 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 <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampMaximumInPlace(V v, float maximum)` Clamp the elements of the vector `v` to the range {@code [-Infinity ..
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampMinimumByVectorInPlace(V v, VectorReadable4FType 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 <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampMinimumInPlace(V v, float minimum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`normalizeInPlace(V v)` Returns a vector with the same orientation as `v` but with magnitude equal to `1.0` in `v`.
    `static <V extends VectorReadable4FType,U extends VectorWritable4FType> void` | VectorM4F.`orthoNormalize(VectorM4F.ContextVM4F c, VectorReadable4FType v0, U v0_out, VectorReadable4FType v1, U v1_out)` Orthonormalize and return the vectors `v0` and `v1` .
    `static <V extends VectorWritable4FType & VectorReadable4FType,W extends VectorWritable4FType & VectorReadable4FType> void` | VectorM4F.`orthoNormalizeInPlace(VectorM4F.ContextVM4F c, V v0, W v1)` Orthonormalize and the vectors `v0` and `v1`.
    `static <V extends VectorWritable4FType & VectorReadable4FType,W extends VectorWritable4FType & VectorReadable4FType> void` | VectorM4F.`orthoNormalizeInPlace(VectorM4F.ContextVM4F c, V v0, W v1)` Orthonormalize and the vectors `v0` and `v1`.
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`scaleInPlace(V v, double r)` Scale the vector `v` by the scalar `r`, saving the result to `v`.
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`subtractInPlace(V v0, VectorReadable4FType v1)` Subtract the vector `v1` from the vector `v0`, saving the result to `v0`.

    Methods in com.io7m.jtensors with parameters of type VectorReadable4FType
    Modifier and Type | Method and Description
    --- | ---
    `static VectorI4F` | VectorI4F.`absolute(VectorReadable4FType v)` Calculate the absolute value of the vector `v`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`absolute(VectorReadable4FType v, V out)` Calculate the absolute values of the elements in vector `v`, saving the result to `out`.
    `static VectorI4F` | VectorI4F.`add(VectorReadable4FType v0, VectorReadable4FType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`add(VectorReadable4FType v0, VectorReadable4FType v1, V out)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `out`.
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`addInPlace(V v0, VectorReadable4FType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `v0`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`addScaled(VectorReadable4FType v0, VectorReadable4FType v1, double r, V 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 VectorI4F` | VectorI4F.`addScaled(VectorReadable4FType v0, VectorReadable4FType v1, float r)` Calculate the element-wise sum of the vectors `v0` and the element-wise product of `v1` and `r`.
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`addScaledInPlace(V v0, VectorReadable4FType 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` | VectorM4F.`almostEqual(com.io7m.jequality.AlmostEqualFloat.ContextRelative context, VectorReadable4FType va, VectorReadable4FType vb)` Determine whether or not the vectors `va` and `vb` are equal to within the degree of error given in `context`.
    `static boolean` | VectorI4F.`almostEqual(com.io7m.jequality.AlmostEqualFloat.ContextRelative context, VectorReadable4FType va, VectorReadable4FType vb)` Determine whether or not the vectors `va` and `vb` are equal to within the degree of error given in `context`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`clamp(VectorReadable4FType v, double minimum, double maximum, V out)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static VectorI4F` | VectorI4F.`clamp(VectorReadable4FType v, float minimum, float maximum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static VectorI4F` | VectorI4F.`clampByVector(VectorReadable4FType v, VectorReadable4FType minimum, VectorReadable4FType maximum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum` and `maximum`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`clampByVector(VectorReadable4FType v, VectorReadable4FType minimum, VectorReadable4FType maximum, V 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 <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampByVectorInPlace(V v, VectorReadable4FType minimum, VectorReadable4FType 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 VectorI4F` | VectorI4F.`clampMaximum(VectorReadable4FType v, float maximum)` Clamp the elements of the vector `v` to the range {@code [-Infinity ..
    `static <V extends VectorWritable4FType> V` | VectorM4F.`clampMaximum(VectorReadable4FType v, float maximum, V out)` Clamp the elements of the vector `v` to the range {@code [-Infinity ..
    `static VectorI4F` | VectorI4F.`clampMaximumByVector(VectorReadable4FType v, VectorReadable4FType maximum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `maximum`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`clampMaximumByVector(VectorReadable4FType v, VectorReadable4FType maximum, V 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 <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampMaximumByVectorInPlace(V v, VectorReadable4FType 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 VectorI4F` | VectorI4F.`clampMinimum(VectorReadable4FType v, float minimum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable4FType> V` | VectorM4F.`clampMinimum(VectorReadable4FType v, float minimum, V out)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static VectorI4F` | VectorI4F.`clampMinimumByVector(VectorReadable4FType v, VectorReadable4FType minimum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`clampMinimumByVector(VectorReadable4FType v, VectorReadable4FType minimum, V 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 <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`clampMinimumByVectorInPlace(V v, VectorReadable4FType 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 <V extends VectorWritable4FType> V` | VectorM4F.`copy(VectorReadable4FType input, V output)` Copy all elements of the vector `input` to the vector `output`.
    `void` | VectorWritable4FType.`copyFrom4F(VectorReadable4FType in_v)` Set the current vector to the contents of the input vector.
    `void` | VectorM4F.`copyFrom4F(VectorReadable4FType in_v)`
    `void` | QuaternionM4F.`copyFrom4F(VectorReadable4FType in_v)`
    `static double` | VectorM4F.`distance(VectorM4F.ContextVM4F c, VectorReadable4FType v0, VectorReadable4FType v1)` Calculate the distance between the two vectors `v0` and `v1`.
    `static float` | VectorI4F.`distance(VectorReadable4FType v0, VectorReadable4FType v1)` Calculate the distance between the two vectors `v0` and `v1`.
    `static double` | VectorM4F.`dotProduct(VectorReadable4FType v0, VectorReadable4FType v1)` Calculate the scalar product of the vectors `v0` and `v1`.
    `static float` | VectorI4F.`dotProduct(VectorReadable4FType v0, VectorReadable4FType v1)` Calculate the scalar product of the vectors `v0` and `v1`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`interpolateLinear(VectorM4F.ContextVM4F c, VectorReadable4FType v0, VectorReadable4FType v1, double alpha, V r)` Linearly interpolate between `v0` and `v1` by the amount `alpha`, saving the result to `r`.
    `static VectorI4F` | VectorI4F.`interpolateLinear(VectorReadable4FType v0, VectorReadable4FType v1, float alpha)` Linearly interpolate between `v0` and `v1` by the amount `alpha`.
    `static double` | VectorM4F.`magnitude(VectorReadable4FType v)` Calculate the magnitude of the vector `v`.
    `static float` | VectorI4F.`magnitude(VectorReadable4FType v)` Calculate the magnitude of the vector `v`.
    `static double` | VectorM4F.`magnitudeSquared(VectorReadable4FType v)` Calculate the squared magnitude of the vector `v`.
    `static float` | VectorI4F.`magnitudeSquared(VectorReadable4FType v)` Calculate the squared magnitude of the vector `v`.
    `static <V extends VectorWritable4FType> V` | MatrixM4x4F.`multiplyVector4F(MatrixM4x4F.ContextMM4F context, MatrixReadable4x4FType m, VectorReadable4FType v, V out)` Multiply the matrix `m` with the vector `v`, writing the resulting vector to `out`.
    `static MatrixI4x4F` | MatrixI4x4F.`newFromColumns(VectorReadable4FType column_0, VectorReadable4FType column_1, VectorReadable4FType column_2, VectorReadable4FType column_3)` Construct a new immutable 4x4 matrix from the given columns.
    `static VectorI4F` | VectorI4F.`normalize(VectorReadable4FType v)` Normalize the vector `v`, preserving its direction but reducing it to unit length.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`normalize(VectorReadable4FType v, V out)` Returns a vector with the same orientation as `v` but with magnitude equal to `1.0` in `out`.
    `static <V extends VectorReadable4FType,U extends VectorWritable4FType> void` | VectorM4F.`orthoNormalize(VectorM4F.ContextVM4F c, VectorReadable4FType v0, U v0_out, VectorReadable4FType v1, U v1_out)` Orthonormalize and return the vectors `v0` and `v1` .
    `static com.io7m.jfunctional.Pair<VectorI4F,VectorI4F>` | VectorI4F.`orthoNormalize(VectorReadable4FType v0, VectorReadable4FType v1)` Orthonormalize and return the vectors `v0` and `v1` .
    `static VectorI4F` | VectorI4F.`projection(VectorReadable4FType p, VectorReadable4FType q)` Calculate the projection of the vector `p` onto the vector `q`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`projection(VectorReadable4FType p, VectorReadable4FType q, V r)` Calculate the projection of the vector `p` onto the vector `q`, saving the result in `r`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`scale(VectorReadable4FType v, double r, V out)` Scale the vector `v` by the scalar `r`, saving the result to `out`.
    `static VectorI4F` | VectorI4F.`scale(VectorReadable4FType v, float r)` Scale the vector `v` by the scalar `r`.
    `void` | MatrixWritable4x4FType.`setRow0With4F(VectorReadable4FType v)` Set row 0 to `v`.
    `void` | MatrixHeapArrayM4x4F.`setRow0With4F(VectorReadable4FType v)`
    `void` | MatrixDirectM4x4F.`setRow0With4F(VectorReadable4FType v)`
    `void` | MatrixWritable4x4FType.`setRow1With4F(VectorReadable4FType v)` Set row 1 to `v`.
    `void` | MatrixHeapArrayM4x4F.`setRow1With4F(VectorReadable4FType v)`
    `void` | MatrixDirectM4x4F.`setRow1With4F(VectorReadable4FType v)`
    `void` | MatrixWritable4x4FType.`setRow2With4F(VectorReadable4FType v)` Set row 2 to `v`.
    `void` | MatrixHeapArrayM4x4F.`setRow2With4F(VectorReadable4FType v)`
    `void` | MatrixDirectM4x4F.`setRow2With4F(VectorReadable4FType v)`
    `void` | MatrixWritable4x4FType.`setRow3With4F(VectorReadable4FType v)` Set row 3 to `v`.
    `void` | MatrixHeapArrayM4x4F.`setRow3With4F(VectorReadable4FType v)`
    `void` | MatrixDirectM4x4F.`setRow3With4F(VectorReadable4FType v)`
    `void` | MatrixWritable4x4FType.`setRowWith4F(int row, VectorReadable4FType v)` Set row `row` of the matrix to `v`.
    `void` | MatrixHeapArrayM4x4F.`setRowWith4F(int row, VectorReadable4FType v)`
    `void` | MatrixDirectM4x4F.`setRowWith4F(int row, VectorReadable4FType v)`
    `void` | MatrixWritable4x4FType.`setRowWith4FUnsafe(int row, VectorReadable4FType v)` Set row `row` of the matrix to `v`.
    `void` | MatrixHeapArrayM4x4F.`setRowWith4FUnsafe(int row, VectorReadable4FType v)`
    `void` | MatrixDirectM4x4F.`setRowWith4FUnsafe(int row, VectorReadable4FType v)`
    `static VectorI4F` | VectorI4F.`subtract(VectorReadable4FType v0, VectorReadable4FType v1)` Subtract the vector `v1` from the vector `v0`.
    `static <V extends VectorWritable4FType> V` | VectorM4F.`subtract(VectorReadable4FType v0, VectorReadable4FType v1, V out)` Subtract the vector `v1` from the vector `v0`, saving the result to `out`.
    `static <V extends VectorWritable4FType & VectorReadable4FType> V` | VectorM4F.`subtractInPlace(V v0, VectorReadable4FType v1)` Subtract the vector `v1` from the vector `v0`, saving the result to `v0`.

    Constructors in com.io7m.jtensors with parameters of type VectorReadable4FType
    Constructor and Description
    `VectorI4F(VectorReadable4FType in_v)` Construct a vector initialized with the values given in the vector `in_v`.
    `VectorM4F(VectorReadable4FType in_v)` Construct a vector initialized with the values given in the vector `in_v`.

  - ### Uses of VectorReadable4FType in com.io7m.jtensors.bytebuffered

    Subinterfaces of VectorReadable4FType in com.io7m.jtensors.bytebuffered
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `QuaternionByteBuffered4FType` The type of `Quaternion4FType` values that are also byte buffered.
    `interface` | `VectorByteBuffered4FType` The type of `Vector4FType` values that are also byte buffered.

    Classes in com.io7m.jtensors.bytebuffered that implement VectorReadable4FType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `QuaternionByteBufferedM4F` A quaternion type with `float` elements, packed into a `ByteBuffer`.
    `class` | `VectorByteBufferedM4F` A four-element vector type with `float` elements, packed into a `ByteBuffer`.

    Methods in com.io7m.jtensors.bytebuffered with parameters of type VectorReadable4FType
    Modifier and Type | Method and Description
    --- | ---
    `void` | VectorByteBufferedM4F.`copyFrom4F(VectorReadable4FType in_v)`
    `void` | QuaternionByteBufferedM4F.`copyFrom4F(VectorReadable4FType in_v)`
    `void` | MatrixByteBufferedM4x4F.`setRow0With4F(VectorReadable4FType v)`
    `void` | MatrixByteBufferedM4x4F.`setRow1With4F(VectorReadable4FType v)`
    `void` | MatrixByteBufferedM4x4F.`setRow2With4F(VectorReadable4FType v)`
    `void` | MatrixByteBufferedM4x4F.`setRow3With4F(VectorReadable4FType v)`
    `void` | MatrixByteBufferedM4x4F.`setRowWith4F(int row, VectorReadable4FType v)`
    `void` | MatrixByteBufferedM4x4F.`setRowWith4FUnsafe(int row, VectorReadable4FType v)`

  - ### Uses of VectorReadable4FType in com.io7m.jtensors.bytebuffered.parameterized

    Subinterfaces of VectorReadable4FType in com.io7m.jtensors.bytebuffered.parameterized
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PVectorByteBuffered4FType<T>` The type of `PVector4FType` values that are also byte buffered.

    Classes in com.io7m.jtensors.bytebuffered.parameterized that implement VectorReadable4FType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PVectorByteBufferedM4F<T>` A four-element vector type with `float` elements, packed into a `ByteBuffer`.

    Methods in com.io7m.jtensors.bytebuffered.parameterized with parameters of type VectorReadable4FType
    Modifier and Type | Method and Description
    --- | ---
    `void` | PVectorByteBufferedM4F.`copyFrom4F(VectorReadable4FType in_v)`
    `void` | PMatrixByteBufferedM4x4F.`setRow0With4F(VectorReadable4FType v)`
    `void` | PMatrixByteBufferedM4x4F.`setRow1With4F(VectorReadable4FType v)`
    `void` | PMatrixByteBufferedM4x4F.`setRow2With4F(VectorReadable4FType v)`
    `void` | PMatrixByteBufferedM4x4F.`setRow3With4F(VectorReadable4FType v)`
    `void` | PMatrixByteBufferedM4x4F.`setRowWith4F(int row, VectorReadable4FType v)`
    `void` | PMatrixByteBufferedM4x4F.`setRowWith4FUnsafe(int row, VectorReadable4FType v)`

  - ### Uses of VectorReadable4FType in com.io7m.jtensors.parameterized

    Subinterfaces of VectorReadable4FType in com.io7m.jtensors.parameterized
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PVector4FType<T>` The type of four-element vectors that are both readable and writable, and have `float` elements
    `interface` | `PVectorReadable4FType<T>` 'Read' interface to phantom-typed four-dimensional vectors with single precision elements.

    Classes in com.io7m.jtensors.parameterized that implement VectorReadable4FType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PVectorI4F<T>` A four-dimensional immutable vector type with `float` elements.
    `class` | `PVectorM4F<T>` A four-dimensional mutable vector type with `float` elements.

    Methods in com.io7m.jtensors.parameterized with parameters of type VectorReadable4FType
    Modifier and Type | Method and Description
    --- | ---
    `void` | PVectorM4F.`copyFrom4F(VectorReadable4FType in_v)`
    `static <T0,T1> PMatrixI4x4F<T0,T1>` | PMatrixI4x4F.`newFromColumns(VectorReadable4FType column_0, VectorReadable4FType column_1, VectorReadable4FType column_2, VectorReadable4FType column_3)` Construct a new immutable 4x4 matrix from the given columns.
    `void` | PMatrixHeapArrayM4x4F.`setRow0With4F(VectorReadable4FType v)`
    `void` | PMatrixDirectM4x4F.`setRow0With4F(VectorReadable4FType v)`
    `void` | PMatrixHeapArrayM4x4F.`setRow1With4F(VectorReadable4FType v)`
    `void` | PMatrixDirectM4x4F.`setRow1With4F(VectorReadable4FType v)`
    `void` | PMatrixHeapArrayM4x4F.`setRow2With4F(VectorReadable4FType v)`
    `void` | PMatrixDirectM4x4F.`setRow2With4F(VectorReadable4FType v)`
    `void` | PMatrixHeapArrayM4x4F.`setRow3With4F(VectorReadable4FType v)`
    `void` | PMatrixDirectM4x4F.`setRow3With4F(VectorReadable4FType v)`
    `void` | PMatrixHeapArrayM4x4F.`setRowWith4F(int row, VectorReadable4FType v)`
    `void` | PMatrixDirectM4x4F.`setRowWith4F(int row, VectorReadable4FType v)`
    `void` | PMatrixHeapArrayM4x4F.`setRowWith4FUnsafe(int row, VectorReadable4FType v)`
    `void` | PMatrixDirectM4x4F.`setRowWith4FUnsafe(int row, VectorReadable4FType v)`

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