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

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

    Subinterfaces of VectorReadable2LType in com.io7m.jtensors
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Vector2LType` The type of two-element vectors that are both readable and writable, and have `long` elements
    `interface` | `Vector3LType` The type of three-element vectors that are both readable and writable, and have `long` elements
    `interface` | `Vector4LType` The type of four-element vectors that are both readable and writable, and have `long` elements
    `interface` | `VectorReadable3LType` 'Read' interface to three-dimensional vectors with integer elements.
    `interface` | `VectorReadable4LType` 'Read' interface to four-dimensional vectors with integer elements.

    Classes in com.io7m.jtensors that implement VectorReadable2LType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `VectorI2L` A two-dimensional immutable vector type with integer elements.
    `class` | `VectorI3L` A three-dimensional immutable vector type with integer elements.
    `class` | `VectorI4L` A four-dimensional immutable vector type with integer elements.
    `class` | `VectorM2L` A two-dimensional mutable vector type with integer elements.
    `class` | `VectorM3L` A three-dimensional mutable vector type with integer elements.
    `class` | `VectorM4L` A four-dimensional mutable vector type with integer elements.

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

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

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

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

    Subinterfaces of VectorReadable2LType in com.io7m.jtensors.bytebuffered
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `VectorByteBuffered2LType` The type of `Vector2LType` values that are also byte buffered.
    `interface` | `VectorByteBuffered3LType` The type of `Vector3LType` values that are also byte buffered.
    `interface` | `VectorByteBuffered4LType` The type of `Vector4LType` values that are also byte buffered.

    Classes in com.io7m.jtensors.bytebuffered that implement VectorReadable2LType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `VectorByteBufferedM2L` A three-element vector type with `long` elements, packed into a `ByteBuffer`.
    `class` | `VectorByteBufferedM3L` A three-element vector type with `long` elements, packed into a `ByteBuffer`.
    `class` | `VectorByteBufferedM4L` A four-element vector type with `long` elements, packed into a `ByteBuffer`.

    Methods in com.io7m.jtensors.bytebuffered with parameters of type VectorReadable2LType
    Modifier and Type | Method and Description
    --- | ---
    `void` | VectorByteBufferedM4L.`copyFrom2L(VectorReadable2LType in_v)`
    `void` | VectorByteBufferedM3L.`copyFrom2L(VectorReadable2LType in_v)`
    `void` | VectorByteBufferedM2L.`copyFrom2L(VectorReadable2LType in_v)`

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

    Subinterfaces of VectorReadable2LType in com.io7m.jtensors.bytebuffered.parameterized
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PVectorByteBuffered2LType<T>` The type of `PVector2LType` values that are also byte buffered.
    `interface` | `PVectorByteBuffered3LType<T>` The type of `PVector3LType` values that are also byte buffered.
    `interface` | `PVectorByteBuffered4LType<T>` The type of `PVector4LType` values that are also byte buffered.

    Classes in com.io7m.jtensors.bytebuffered.parameterized that implement VectorReadable2LType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PVectorByteBufferedM2L<T>` A three-element vector type with `long` elements, packed into a `ByteBuffer`.
    `class` | `PVectorByteBufferedM3L<T>` A three-element vector type with `long` elements, packed into a `ByteBuffer`.
    `class` | `PVectorByteBufferedM4L<T>` A four-element vector type with `long` elements, packed into a `ByteBuffer`.

    Methods in com.io7m.jtensors.bytebuffered.parameterized with parameters of type VectorReadable2LType
    Modifier and Type | Method and Description
    --- | ---
    `void` | PVectorByteBufferedM4L.`copyFrom2L(VectorReadable2LType in_v)`
    `void` | PVectorByteBufferedM3L.`copyFrom2L(VectorReadable2LType in_v)`
    `void` | PVectorByteBufferedM2L.`copyFrom2L(VectorReadable2LType in_v)`

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

    Subinterfaces of VectorReadable2LType in com.io7m.jtensors.parameterized
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PVector2LType<T>` The type of two-element vectors that are both readable and writable, and have `long` elements
    `interface` | `PVector3LType<T>` The type of three-element vectors that are both readable and writable, and have `long` elements
    `interface` | `PVector4LType<T>` The type of four-element vectors that are both readable and writable, and have `long` elements
    `interface` | `PVectorReadable2LType<T>` 'Read' interface to phantom-typed two-dimensional vectors with long integer elements.
    `interface` | `PVectorReadable3LType<T>` 'Read' interface to phantom-typed three-dimensional vectors with long integer elements.
    `interface` | `PVectorReadable4LType<T>` 'Read' interface to phantom-typed four-dimensional vectors with long integer elements.

    Classes in com.io7m.jtensors.parameterized that implement VectorReadable2LType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PVectorI2L<T>` A two-dimensional immutable vector type with integer elements.
    `class` | `PVectorI3L<T>` A three-dimensional immutable vector type with integer elements.
    `class` | `PVectorI4L<T>` A four-dimensional immutable vector type with integer elements.
    `class` | `PVectorM2L<T>` A two-dimensional mutable vector type with integer elements.
    `class` | `PVectorM3L<T>` A three-dimensional mutable vector type with integer elements.
    `class` | `PVectorM4L<T>` A four-dimensional mutable vector type with integer elements.

    Methods in com.io7m.jtensors.parameterized with parameters of type VectorReadable2LType
    Modifier and Type | Method and Description
    --- | ---
    `void` | PVectorM4L.`copyFrom2L(VectorReadable2LType in_v)`
    `void` | PVectorM3L.`copyFrom2L(VectorReadable2LType in_v)`
    `void` | PVectorM2L.`copyFrom2L(VectorReadable2LType in_v)`

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