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

- Packages that use VectorReadable3IType
  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 VectorReadable3IType in com.io7m.jtensors

    Subinterfaces of VectorReadable3IType in com.io7m.jtensors
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Vector3IType` The type of three-element vectors that are both readable and writable, and have `int` elements
    `interface` | `Vector4IType` The type of four-element vectors that are both readable and writable, and have `int` elements
    `interface` | `VectorReadable4IType` 'Read' interface to four-dimensional vectors with integer elements.

    Classes in com.io7m.jtensors that implement VectorReadable3IType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `VectorI3I` A three-dimensional immutable vector type with integer elements.
    `class` | `VectorI4I` A four-dimensional immutable vector type with integer elements.
    `class` | `VectorM3I` A three-dimensional mutable vector type with integer elements.
    `class` | `VectorM4I` A four-dimensional mutable vector type with integer elements.

    Methods in com.io7m.jtensors with type parameters of type VectorReadable3IType
    Modifier and Type | Method and Description
    --- | ---
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`absoluteInPlace(V v)` Calculate the absolute values of the elements in vector `v`, saving the result to `v`.
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`addInPlace(V v0, VectorReadable3IType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `v0`.
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`addScaledInPlace(V v0, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampByVectorInPlace(V v, VectorReadable3IType minimum, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampInPlace(V v, int minimum, int maximum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampMaximumByVectorInPlace(V v, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampMaximumInPlace(V v, int maximum)` Clamp the elements of the vector `v` to the range {@code [-Infinity ..
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampMinimumByVectorInPlace(V v, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampMinimumInPlace(V v, int minimum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`scaleInPlace(V v, int r)` Scale the vector `v` by the scalar `r`, saving the result to `v`.
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`subtractInPlace(V v0, VectorReadable3IType v1)` Subtract the vector `v1` from the vector `v0`, saving the result to `v0`.

    Methods in com.io7m.jtensors with parameters of type VectorReadable3IType
    Modifier and Type | Method and Description
    --- | ---
    `static VectorI3I` | VectorI3I.`absolute(VectorReadable3IType v)` Calculate the absolute values of the elements in vector `v`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`absolute(VectorReadable3IType v, V out)` Calculate the absolute values of the elements in vector `v`, saving the result to `out`.
    `static VectorI3I` | VectorI3I.`add(VectorReadable3IType v0, VectorReadable3IType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`add(VectorReadable3IType v0, VectorReadable3IType v1, V out)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `out`.
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`addInPlace(V v0, VectorReadable3IType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `v0`.
    `static VectorI3I` | VectorI3I.`addScaled(VectorReadable3IType v0, VectorReadable3IType v1, double r)` Calculate the element-wise sum of the vectors `v0` and the element-wise product of `v1` and `r`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`addScaled(VectorReadable3IType v0, VectorReadable3IType 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 <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`addScaledInPlace(V v0, VectorReadable3IType 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 VectorI3I` | VectorI3I.`clamp(VectorReadable3IType v, int minimum, int maximum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable3IType> V` | VectorM3I.`clamp(VectorReadable3IType v, int minimum, int maximum, V out)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static VectorI3I` | VectorI3I.`clampByVector(VectorReadable3IType v, VectorReadable3IType minimum, VectorReadable3IType maximum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum` and `maximum`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`clampByVector(VectorReadable3IType v, VectorReadable3IType minimum, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampByVectorInPlace(V v, VectorReadable3IType minimum, VectorReadable3IType 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 VectorI3I` | VectorI3I.`clampMaximum(VectorReadable3IType v, int maximum)` Clamp the elements of the vector `v` to the range {@code [-Infinity ..
    `static <V extends VectorWritable3IType> V` | VectorM3I.`clampMaximum(VectorReadable3IType v, int maximum, V out)` Clamp the elements of the vector `v` to the range {@code [-Infinity ..
    `static VectorI3I` | VectorI3I.`clampMaximumByVector(VectorReadable3IType v, VectorReadable3IType maximum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `maximum`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`clampMaximumByVector(VectorReadable3IType v, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampMaximumByVectorInPlace(V v, VectorReadable3IType 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 VectorI3I` | VectorI3I.`clampMinimum(VectorReadable3IType v, int minimum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable3IType> V` | VectorM3I.`clampMinimum(VectorReadable3IType v, int minimum, V out)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static VectorI3I` | VectorI3I.`clampMinimumByVector(VectorReadable3IType v, VectorReadable3IType minimum)` Clamp the elements of the vector `v` to the inclusive range given by the corresponding elements in `minimum`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`clampMinimumByVector(VectorReadable3IType v, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`clampMinimumByVectorInPlace(V v, VectorReadable3IType 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 VectorWritable3IType> V` | VectorM3I.`copy(VectorReadable3IType input, V output)` Copy all elements of the vector `input` to the vector `output`.
    `void` | VectorWritable3IType.`copyFrom3I(VectorReadable3IType in_v)` Set the current vector to the contents of the input vector.
    `void` | VectorM4I.`copyFrom3I(VectorReadable3IType in_v)`
    `void` | VectorM3I.`copyFrom3I(VectorReadable3IType in_v)`
    `static int` | VectorM3I.`distance(VectorM3I.ContextVM3I c, VectorReadable3IType v0, VectorReadable3IType v1)` Calculate the distance between the two vectors `v0` and `v1`.
    `static int` | VectorI3I.`distance(VectorReadable3IType v0, VectorReadable3IType v1)` Calculate the distance between the two vectors `v0` and `v1`.
    `static int` | VectorM3I.`dotProduct(VectorReadable3IType v0, VectorReadable3IType v1)` Calculate the scalar product of the vectors `v0` and `v1`.
    `static int` | VectorI3I.`dotProduct(VectorReadable3IType v0, VectorReadable3IType v1)` Calculate the scalar product of the vectors `v0` and `v1`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`interpolateLinear(VectorM3I.ContextVM3I c, VectorReadable3IType v0, VectorReadable3IType v1, double alpha, V r)` Linearly interpolate between `v0` and `v1` by the amount `alpha`, saving the result to `r`.
    `static VectorI3I` | VectorI3I.`interpolateLinear(VectorReadable3IType v0, VectorReadable3IType v1, double alpha)` Linearly interpolate between `v0` and `v1` by the amount `alpha`.
    `static int` | VectorM3I.`magnitude(VectorReadable3IType v)` Calculate the magnitude of the vector `v`.
    `static int` | VectorI3I.`magnitude(VectorReadable3IType v)` Calculate the magnitude of the vector `v`.
    `static int` | VectorM3I.`magnitudeSquared(VectorReadable3IType v)` Calculate the squared magnitude of the vector `v`.
    `static int` | VectorI3I.`magnitudeSquared(VectorReadable3IType v)` Calculate the squared magnitude of the vector `v`.
    `static <M extends MatrixWritable4x4DType> M` | MatrixM4x4D.`makeTranslation3I(VectorReadable3IType v, M out)` Generate a matrix that represents a translation of `(v.x, v.y, v.z)` from the origin, and save to `out`.
    `static <M extends MatrixWritable4x4FType> M` | MatrixM4x4F.`makeTranslation3I(VectorReadable3IType v, M out)` Generate a matrix that represents a translation of `(v.x, v.y, v.z)` from the origin, and save to `out`.
    `static VectorI3I` | VectorI3I.`projection(VectorReadable3IType p, VectorReadable3IType q)` Calculate the projection of the vector `p` onto the vector `q`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`projection(VectorReadable3IType p, VectorReadable3IType q, V r)` Calculate the projection of the vector `p` onto the vector `q`, saving the result in `r`.
    `static VectorI3I` | VectorI3I.`scale(VectorReadable3IType v, double r)` Scale the vector `v` by the scalar `r`, saving the result to `out`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`scale(VectorReadable3IType v, double r, V out)` Scale the vector `v` by the scalar `r`, saving the result to `out`.
    `static VectorI3I` | VectorI3I.`subtract(VectorReadable3IType v0, VectorReadable3IType v1)` Subtract the vector `v1` from the vector `v0`.
    `static <V extends VectorWritable3IType> V` | VectorM3I.`subtract(VectorReadable3IType v0, VectorReadable3IType v1, V out)` Subtract the vector `v1` from the vector `v0`, saving the result to `out`.
    `static <V extends VectorWritable3IType & VectorReadable3IType> V` | VectorM3I.`subtractInPlace(V v0, VectorReadable3IType v1)` Subtract the vector `v1` from the vector `v0`, saving the result to `v0`.

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

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

    Subinterfaces of VectorReadable3IType in com.io7m.jtensors.bytebuffered
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `VectorByteBuffered3IType` The type of `Vector3IType` values that are also byte buffered.
    `interface` | `VectorByteBuffered4IType` The type of `Vector4IType` values that are also byte buffered.

    Classes in com.io7m.jtensors.bytebuffered that implement VectorReadable3IType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `VectorByteBufferedM3I` A three-element vector type with `int` elements, packed into a `ByteBuffer`.
    `class` | `VectorByteBufferedM4I` A four-element vector type with `int` elements, packed into a `ByteBuffer`.

    Methods in com.io7m.jtensors.bytebuffered with parameters of type VectorReadable3IType
    Modifier and Type | Method and Description
    --- | ---
    `void` | VectorByteBufferedM4I.`copyFrom3I(VectorReadable3IType in_v)`
    `void` | VectorByteBufferedM3I.`copyFrom3I(VectorReadable3IType in_v)`

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

    Subinterfaces of VectorReadable3IType in com.io7m.jtensors.bytebuffered.parameterized
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PVectorByteBuffered3IType<T>` The type of `PVector3IType` values that are also byte buffered.
    `interface` | `PVectorByteBuffered4IType<T>` The type of `PVector4IType` values that are also byte buffered.

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

    Methods in com.io7m.jtensors.bytebuffered.parameterized with parameters of type VectorReadable3IType
    Modifier and Type | Method and Description
    --- | ---
    `void` | PVectorByteBufferedM4I.`copyFrom3I(VectorReadable3IType in_v)`
    `void` | PVectorByteBufferedM3I.`copyFrom3I(VectorReadable3IType in_v)`

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

    Subinterfaces of VectorReadable3IType in com.io7m.jtensors.parameterized
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PVector3IType<T>` The type of three-element vectors that are both readable and writable, and have `int` elements
    `interface` | `PVector4IType<T>` The type of four-element vectors that are both readable and writable, and have `int` elements
    `interface` | `PVectorReadable3IType<T>` 'Read' interface to phantom-typed three-dimensional vectors with integer elements.
    `interface` | `PVectorReadable4IType<T>` 'Read' interface to phantom-typed four-dimensional vectors with integer elements.

    Classes in com.io7m.jtensors.parameterized that implement VectorReadable3IType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PVectorI3I<T>` A three-dimensional immutable vector type with integer elements.
    `class` | `PVectorI4I<T>` A four-dimensional immutable vector type with integer elements.
    `class` | `PVectorM3I<T>` A three-dimensional mutable vector type with integer elements.
    `class` | `PVectorM4I<T>` A four-dimensional mutable vector type with integer elements.

    Methods in com.io7m.jtensors.parameterized with parameters of type VectorReadable3IType
    Modifier and Type | Method and Description
    --- | ---
    `void` | PVectorM4I.`copyFrom3I(VectorReadable3IType in_v)`
    `void` | PVectorM3I.`copyFrom3I(VectorReadable3IType in_v)`

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