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

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

    Subinterfaces of VectorReadable4IType in com.io7m.jtensors
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Vector4IType` The type of four-element vectors that are both readable and writable, and have `int` elements

    Classes in com.io7m.jtensors that implement VectorReadable4IType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `VectorI4I` A four-dimensional immutable 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 VectorReadable4IType
    Modifier and Type | Method and Description
    --- | ---
    `static <V extends VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`absoluteInPlace(V v)` Calculate the absolute values of the elements in vector `v`, saving the result to `v`.
    `static <V extends VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`addInPlace(V v0, VectorReadable4IType v1)` Calculate the element-wise sum of the vectors `v0` and `v1`, saving the result to `v0`.
    `static <V extends VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`addScaledInPlace(V v0, VectorReadable4IType 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 VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`clampByVectorInPlace(V v, VectorReadable4IType minimum, VectorReadable4IType 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 VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`clampInPlace(V v, int minimum, int maximum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`clampMaximumByVectorInPlace(V v, VectorReadable4IType 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 VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`clampMaximumInPlace(V v, int maximum)` Clamp the elements of the vector `v` to the range {@code [-Infinity ..
    `static <V extends VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`clampMinimumByVectorInPlace(V v, VectorReadable4IType 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 VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`clampMinimumInPlace(V v, int minimum)` Clamp the elements of the vector `v` to the range {@code [minimum ..
    `static <V extends VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`scaleInPlace(V v, int r)` Scale the vector `v` by the scalar `r`, saving the result to `v`.
    `static <V extends VectorWritable4IType & VectorReadable4IType> V` | VectorM4I.`subtractInPlace(V v0, VectorReadable4IType v1)` Subtract the vector `v1` from the vector `v0`, saving the result to `v0`.

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

    Constructors in com.io7m.jtensors with parameters of type VectorReadable4IType
    Constructor and Description
    `VectorI4I(VectorReadable4IType in_v)` Construct a vector initialized with the values given in the vector `in_v`.
    `VectorM4I(VectorReadable4IType in_v)` Construct a vector initialized with the values given in the vector `v`.

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

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

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

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

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

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

    Classes in com.io7m.jtensors.bytebuffered.parameterized that implement VectorReadable4IType
    Modifier and Type | Class and Description
    --- | ---
    `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 VectorReadable4IType
    Modifier and Type | Method and Description
    --- | ---
    `void` | PVectorByteBufferedM4I.`copyFrom4I(VectorReadable4IType in_v)`

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

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

    Classes in com.io7m.jtensors.parameterized that implement VectorReadable4IType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PVectorI4I<T>` A four-dimensional immutable 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 VectorReadable4IType
    Modifier and Type | Method and Description
    --- | ---
    `void` | PVectorM4I.`copyFrom4I(VectorReadable4IType in_v)`

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