Package org.joml

Class Vector4L

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Vector4Lc

    public class Vector4L
    extends java.lang.Object
    implements java.io.Externalizable, java.lang.Cloneable, Vector4Lc
    Contains the definition of a vector comprising 4 longs and associated transformations.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      long w
      The w component of the vector.
      long x
      The x component of the vector.
      long y
      The y component of the vector.
      long z
      The z component of the vector.
    • Constructor Summary

      Constructors 
      Constructor Description
      Vector4L()
      Create a new Vector4L of (0, 0, 0, 1).
      Vector4L​(int[] xyzw)
      Create a new Vector4L and initialize its four components from the first four elements of the given array.
      Vector4L​(int index, java.nio.ByteBuffer buffer)
      Create a new Vector4L and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
      Vector4L​(int index, java.nio.LongBuffer buffer)
      Create a new Vector4L and read this vector from the supplied LongBuffer starting at the specified absolute buffer position/index.
      Vector4L​(long s)
      Create a new Vector4L and initialize all four components with the given value.
      Vector4L​(long x, long y, long z, long w)
      Create a new Vector4L with the given component values.
      Vector4L​(java.nio.ByteBuffer buffer)
      Create a new Vector4L and read this vector from the supplied ByteBuffer at the current buffer position.
      Vector4L​(java.nio.LongBuffer buffer)
      Create a new Vector4L and read this vector from the supplied LongBuffer at the current buffer position.
      Vector4L​(Vector2ic v, long z, long w)
      Create a new Vector4L with the first two components from the given v and the given z, and w.
      Vector4L​(Vector2Lc v, long z, long w)
      Create a new Vector4L with the first two components from the given v and the given z, and w.
      Vector4L​(Vector3fc v, float w, int mode)
      Create a new Vector4L with the first three components from the given v and the given w and round using the given RoundingMode.
      Vector4L​(Vector3ic v, long w)
      Create a new Vector4L with the first three components from the given v and the given w.
      Vector4L​(Vector3Lc v, long w)
      Create a new Vector4L with the first three components from the given v and the given w.
      Vector4L​(Vector4dc v, int mode)
      Create a new Vector4L and initialize its components to the rounded value of the given vector.
      Vector4L​(Vector4fc v, int mode)
      Create a new Vector4L and initialize its components to the rounded value of the given vector.
      Vector4L​(Vector4ic v)
      Create a new Vector4L with the same values as v.
      Vector4L​(Vector4Lc v)
      Create a new Vector4L with the same values as v.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Vector4L absolute()
      Compute the absolute of each of this vector's components.
      Vector4L absolute​(Vector4L dest)
      Compute the absolute of each of this vector's components and store the result into dest.
      Vector4L add​(long x, long y, long z, long w)
      Increment the components of this vector by the given values.
      Vector4L add​(long x, long y, long z, long w, Vector4L dest)
      Increment the components of this vector by the given values and store the result in dest.
      Vector4L add​(Vector4ic v)
      Add the supplied vector to this one.
      Vector4L add​(Vector4ic v, Vector4L dest)
      Add the supplied vector to this one and store the result in dest.
      Vector4L add​(Vector4Lc v)
      Add the supplied vector to this one.
      Vector4L add​(Vector4Lc v, Vector4L dest)
      Add the supplied vector to this one and store the result in dest.
      java.lang.Object clone()  
      double distance​(long x, long y, long z, long w)
      Return the distance between this vector and (x, y, z, w).
      static double distance​(long x1, long y1, long z1, long w1, long x2, long y2, long z2, long w2)
      Return the distance between (x1, y1, z1, w1) and (x2, y2, z2, w2).
      double distance​(Vector4ic v)
      Return the distance between this Vector and v.
      double distance​(Vector4Lc v)
      Return the distance between this Vector and v.
      long distanceSquared​(long x, long y, long z, long w)
      Return the square of the distance between this vector and (x, y, z, w).
      static long distanceSquared​(long x1, long y1, long z1, long w1, long x2, long y2, long z2, long w2)
      Return the squared distance between (x1, y1, z1, w1) and (x2, y2, z2, w2).
      long distanceSquared​(Vector4ic v)
      Return the square of the distance between this vector and v.
      long distanceSquared​(Vector4Lc v)
      Return the square of the distance between this vector and v.
      Vector4L div​(float scalar)
      Divide all components of this vector by the given scalar value.
      Vector4L div​(float scalar, Vector4L dest)
      Divide all components of this vector by the given scalar value and store the result in dest.
      Vector4L div​(long scalar)
      Divide all components of this vector by the given scalar value.
      Vector4L div​(long scalar, Vector4L dest)
      Divide all components of this vector by the given scalar value and store the result in dest.
      Vector4L div​(Vector4ic v)
      Divide this Vector4L component-wise by another vector.
      Vector4L div​(Vector4ic v, Vector4L dest)
      Divide this Vector4L component-wise by another Vector4ic and store the result in dest.
      Vector4L div​(Vector4Lc v)
      Divide this Vector4L component-wise by another vector.
      Vector4L div​(Vector4Lc v, Vector4L dest)
      Divide this Vector4L component-wise by another Vector4Lc and store the result in dest.
      long dot​(Vector4ic v)
      Compute the dot product (inner product) of this vector and v.
      long dot​(Vector4Lc v)
      Compute the dot product (inner product) of this vector and v.
      boolean equals​(long x, long y, long z, long w)
      Compare the vector components of this vector with the given (x, y, z, w) and return whether all of them are equal.
      boolean equals​(java.lang.Object obj)  
      long get​(int component)
      Get the value of the specified component of this vector.
      java.nio.ByteBuffer get​(int index, java.nio.ByteBuffer buffer)
      Store this vector into the supplied ByteBuffer starting at the specified absolute buffer position/index.
      java.nio.LongBuffer get​(int index, java.nio.LongBuffer buffer)
      Store this vector into the supplied LongBuffer starting at the specified absolute buffer position/index.
      java.nio.ByteBuffer get​(java.nio.ByteBuffer buffer)
      Store this vector into the supplied ByteBuffer at the current buffer position.
      java.nio.LongBuffer get​(java.nio.LongBuffer buffer)
      Store this vector into the supplied LongBuffer at the current buffer position.
      Vector4Lc getToAddress​(long address)
      Store this vector at the given off-heap memory address.
      long gridDistance​(long x, long y, long z, long w)
      Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance) (x, y).
      long gridDistance​(Vector4ic v)
      Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance) (x, y).
      long gridDistance​(Vector4Lc v)
      Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance) (x, y).
      int hashCode()  
      double length()
      Return the length of this vector.
      static double length​(long x, long y, long z, long w)
      Get the length of a 4-dimensional single-precision vector.
      long lengthSquared()
      Return the length squared of this vector.
      static long lengthSquared​(long x, long y, long z, long w)
      Get the length squared of a 4-dimensional single-precision vector.
      Vector4L max​(Vector4Lc v)
      Set the components of this vector to be the component-wise maximum of this and the other vector.
      Vector4L max​(Vector4Lc v, Vector4L dest)
      Set the components of dest to be the component-wise maximum of this and the other vector.
      int maxComponent()
      Determine the component with the biggest absolute value.
      Vector4L min​(Vector4Lc v)
      Set the components of this vector to be the component-wise minimum of this and the other vector.
      Vector4L min​(Vector4Lc v, Vector4L dest)
      Set the components of dest to be the component-wise minimum of this and the other vector.
      int minComponent()
      Determine the component with the smallest (towards zero) absolute value.
      Vector4L mul​(long scalar)
      Multiply all components of this vector by the given scalar value.
      Vector4L mul​(long scalar, Vector4L dest)
      Multiply all components of this vector by the given scalar value and store the result in dest.
      Vector4L mul​(Vector4ic v)
      Multiply this Vector4L component-wise by another vector.
      Vector4L mul​(Vector4ic v, Vector4L dest)
      Multiply this Vector4L component-wise by another Vector4ic and store the result in dest.
      Vector4L mul​(Vector4Lc v)
      Multiply this Vector4L component-wise by another vector.
      Vector4L mul​(Vector4Lc v, Vector4L dest)
      Multiply this Vector4L component-wise by another Vector4Lc and store the result in dest.
      Vector4L negate()
      Negate this vector.
      Vector4L negate​(Vector4L dest)
      Negate this vector and store the result in dest.
      void readExternal​(java.io.ObjectInput in)  
      Vector4L set​(int[] xyzw)
      Set the four components of this vector to the first four elements of the given array.
      Vector4L set​(int index, java.nio.ByteBuffer buffer)
      Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
      Vector4L set​(int index, java.nio.LongBuffer buffer)
      Read this vector from the supplied LongBuffer starting at the specified absolute buffer position/index.
      Vector4L set​(long s)
      Set the x, y, z, and w components to the supplied value.
      Vector4L set​(long x, long y, long z, long w)
      Set the x, y, z, and w components to the supplied values.
      Vector4L set​(java.nio.ByteBuffer buffer)
      Read this vector from the supplied ByteBuffer at the current buffer position.
      Vector4L set​(java.nio.LongBuffer buffer)
      Read this vector from the supplied LongBuffer at the current buffer position.
      Vector4L set​(Vector2ic v, long z, long w)
      Sets the first two components of this to the components of given v and last two components to the given z, and w.
      Vector4L set​(Vector3ic v, long w)
      Set the first three components of this to the components of v and the last component to w.
      Vector4L set​(Vector4dc v)
      Set this vector to the values of v using RoundingMode.TRUNCATE rounding.
      Vector4L set​(Vector4dc v, int mode)
      Set this vector to the values of v using the given RoundingMode.
      Vector4L set​(Vector4fc v, int mode)
      Set this vector to the values of v using the given RoundingMode.
      Vector4L set​(Vector4ic v)
      Set this vector to the values of the given v.
      Vector4L set​(Vector4Lc v)
      Set this vector to the values of the given v.
      Vector4L setComponent​(int component, long value)
      Set the value of the specified component of this vector.
      Vector4L setFromAddress​(long address)
      Set the values of this vector by reading 4 integer values from off-heap memory, starting at the given address.
      Vector4L sub​(long x, long y, long z, long w)
      Subtract (x, y, z, w) from this.
      Vector4L sub​(long x, long y, long z, long w, Vector4L dest)
      Subtract (x, y, z, w) from this and store the result in dest.
      Vector4L sub​(Vector4ic v)
      Subtract the supplied vector from this one.
      Vector4L sub​(Vector4ic v, Vector4L dest)
      Subtract the supplied vector from this one and store the result in dest.
      Vector4L sub​(Vector4Lc v)
      Subtract the supplied vector from this one.
      Vector4L sub​(Vector4Lc v, Vector4L dest)
      Subtract the supplied vector from this one and store the result in dest.
      java.lang.String toString()
      Return a string representation of this vector.
      java.lang.String toString​(java.text.NumberFormat formatter)
      Return a string representation of this vector by formatting the vector components with the given NumberFormat.
      long w()  
      void writeExternal​(java.io.ObjectOutput out)  
      long x()  
      Vector2d xy​(Vector2d dest)
      Copy the (x, y) components of this into the supplied dest vector and return it.
      Vector2f xy​(Vector2f dest)
      Copy the (x, y) components of this into the supplied dest vector and return it.
      Vector2L xy​(Vector2L dest)
      Copy the (x, y) components of this into the supplied dest vector and return it.
      Vector3d xyz​(Vector3d dest)
      Copy the (x, y, z) components of this into the supplied dest vector and return it.
      Vector3f xyz​(Vector3f dest)
      Copy the (x, y, z) components of this into the supplied dest vector and return it.
      Vector3L xyz​(Vector3L dest)
      Copy the (x, y, z) components of this into the supplied dest vector and return it.
      long y()  
      long z()  
      Vector4L zero()
      Set all components to zero.
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • x

        public long x
        The x component of the vector.
      • y

        public long y
        The y component of the vector.
      • z

        public long z
        The z component of the vector.
      • w

        public long w
        The w component of the vector.
    • Constructor Detail

      • Vector4L

        public Vector4L()
        Create a new Vector4L of (0, 0, 0, 1).
      • Vector4L

        public Vector4L​(Vector4Lc v)
        Create a new Vector4L with the same values as v.
        Parameters:
        v - the Vector4Lc to copy the values from
      • Vector4L

        public Vector4L​(Vector4ic v)
        Create a new Vector4L with the same values as v.
        Parameters:
        v - the Vector4ic to copy the values from
      • Vector4L

        public Vector4L​(Vector3Lc v,
                        long w)
        Create a new Vector4L with the first three components from the given v and the given w.
        Parameters:
        v - the Vector3Lc
        w - the w component
      • Vector4L

        public Vector4L​(Vector3ic v,
                        long w)
        Create a new Vector4L with the first three components from the given v and the given w.
        Parameters:
        v - the Vector3ic
        w - the w component
      • Vector4L

        public Vector4L​(Vector2Lc v,
                        long z,
                        long w)
        Create a new Vector4L with the first two components from the given v and the given z, and w.
        Parameters:
        v - the Vector2ic
        z - the z component
        w - the w component
      • Vector4L

        public Vector4L​(Vector2ic v,
                        long z,
                        long w)
        Create a new Vector4L with the first two components from the given v and the given z, and w.
        Parameters:
        v - the Vector2ic
        z - the z component
        w - the w component
      • Vector4L

        public Vector4L​(Vector3fc v,
                        float w,
                        int mode)
        Create a new Vector4L with the first three components from the given v and the given w and round using the given RoundingMode.
        Parameters:
        v - the Vector3fc to copy the values from
        w - the w component
        mode - the RoundingMode to use
      • Vector4L

        public Vector4L​(Vector4fc v,
                        int mode)
        Create a new Vector4L and initialize its components to the rounded value of the given vector.
        Parameters:
        v - the Vector4fc to round and copy the values from
        mode - the RoundingMode to use
      • Vector4L

        public Vector4L​(Vector4dc v,
                        int mode)
        Create a new Vector4L and initialize its components to the rounded value of the given vector.
        Parameters:
        v - the Vector4dc to round and copy the values from
        mode - the RoundingMode to use
      • Vector4L

        public Vector4L​(long s)
        Create a new Vector4L and initialize all four components with the given value.
        Parameters:
        s - scalar value of all four components
      • Vector4L

        public Vector4L​(long x,
                        long y,
                        long z,
                        long w)
        Create a new Vector4L with the given component values.
        Parameters:
        x - the x component
        y - the y component
        z - the z component
        w - the w component
      • Vector4L

        public Vector4L​(int[] xyzw)
        Create a new Vector4L and initialize its four components from the first four elements of the given array.
        Parameters:
        xyzw - the array containing at least four elements
      • Vector4L

        public Vector4L​(java.nio.ByteBuffer buffer)
        Create a new Vector4L and read this vector from the supplied ByteBuffer at the current buffer position.

        This method will not increment the position of the given ByteBuffer.

        In order to specify the offset into the ByteBuffer at which the vector is read, use Vector4L(int, ByteBuffer), taking the absolute position as parameter.

        Parameters:
        buffer - values will be read in x, y, z, w order
        See Also:
        Vector4L(int, ByteBuffer)
      • Vector4L

        public Vector4L​(int index,
                        java.nio.ByteBuffer buffer)
        Create a new Vector4L and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.

        This method will not increment the position of the given ByteBuffer.

        Parameters:
        index - the absolute position into the ByteBuffer
        buffer - values will be read in x, y, z, w order
      • Vector4L

        public Vector4L​(java.nio.LongBuffer buffer)
        Create a new Vector4L and read this vector from the supplied LongBuffer at the current buffer position.

        This method will not increment the position of the given LongBuffer.

        In order to specify the offset into the LongBuffer at which the vector is read, use Vector4L(int, LongBuffer), taking the absolute position as parameter.

        Parameters:
        buffer - values will be read in x, y, z, w order
        See Also:
        Vector4L(int, LongBuffer)
      • Vector4L

        public Vector4L​(int index,
                        java.nio.LongBuffer buffer)
        Create a new Vector4L and read this vector from the supplied LongBuffer starting at the specified absolute buffer position/index.

        This method will not increment the position of the given LongBuffer.

        Parameters:
        index - the absolute position into the LongBuffer
        buffer - values will be read in x, y, z, w order
    • Method Detail

      • x

        public long x()
        Specified by:
        x in interface Vector4Lc
        Returns:
        the value of the x component
      • y

        public long y()
        Specified by:
        y in interface Vector4Lc
        Returns:
        the value of the y component
      • z

        public long z()
        Specified by:
        z in interface Vector4Lc
        Returns:
        the value of the z component
      • w

        public long w()
        Specified by:
        w in interface Vector4Lc
        Returns:
        the value of the w component
      • xyz

        public Vector3f xyz​(Vector3f dest)
        Copy the (x, y, z) components of this into the supplied dest vector and return it.
        Parameters:
        dest - will hold the result
        Returns:
        dest
      • xyz

        public Vector3d xyz​(Vector3d dest)
        Copy the (x, y, z) components of this into the supplied dest vector and return it.
        Parameters:
        dest - will hold the result
        Returns:
        dest
      • xyz

        public Vector3L xyz​(Vector3L dest)
        Copy the (x, y, z) components of this into the supplied dest vector and return it.
        Parameters:
        dest - will hold the result
        Returns:
        dest
      • xy

        public Vector2f xy​(Vector2f dest)
        Copy the (x, y) components of this into the supplied dest vector and return it.
        Parameters:
        dest - will hold the result
        Returns:
        dest
      • xy

        public Vector2d xy​(Vector2d dest)
        Copy the (x, y) components of this into the supplied dest vector and return it.
        Parameters:
        dest - will hold the result
        Returns:
        dest
      • xy

        public Vector2L xy​(Vector2L dest)
        Copy the (x, y) components of this into the supplied dest vector and return it.
        Parameters:
        dest - will hold the result
        Returns:
        dest
      • set

        public Vector4L set​(Vector4Lc v)
        Set this vector to the values of the given v.
        Parameters:
        v - the vector whose values will be copied into this
        Returns:
        this
      • set

        public Vector4L set​(Vector4ic v)
        Set this vector to the values of the given v.
        Parameters:
        v - the vector whose values will be copied into this
        Returns:
        this
      • set

        public Vector4L set​(Vector4dc v)
        Set this vector to the values of v using RoundingMode.TRUNCATE rounding.

        Note that due to the given vector v storing the components in double-precision, there is the possibility to lose precision.

        Parameters:
        v - the vector to copy from
        Returns:
        this
      • set

        public Vector4L set​(Vector4dc v,
                            int mode)
        Set this vector to the values of v using the given RoundingMode.

        Note that due to the given vector v storing the components in double-precision, there is the possibility to lose precision.

        Parameters:
        v - the vector to copy from
        mode - the RoundingMode to use
        Returns:
        this
      • set

        public Vector4L set​(Vector4fc v,
                            int mode)
        Set this vector to the values of v using the given RoundingMode.

        Note that due to the given vector v storing the components in double-precision, there is the possibility to lose precision.

        Parameters:
        v - the vector to copy from
        mode - the RoundingMode to use
        Returns:
        this
      • set

        public Vector4L set​(Vector3ic v,
                            long w)
        Set the first three components of this to the components of v and the last component to w.
        Parameters:
        v - the Vector3ic to copy
        w - the w component
        Returns:
        this
      • set

        public Vector4L set​(Vector2ic v,
                            long z,
                            long w)
        Sets the first two components of this to the components of given v and last two components to the given z, and w.
        Parameters:
        v - the Vector2ic
        z - the z component
        w - the w component
        Returns:
        this
      • set

        public Vector4L set​(long s)
        Set the x, y, z, and w components to the supplied value.
        Parameters:
        s - the value of all four components
        Returns:
        this
      • set

        public Vector4L set​(long x,
                            long y,
                            long z,
                            long w)
        Set the x, y, z, and w components to the supplied values.
        Parameters:
        x - the x component
        y - the y component
        z - the z component
        w - the w component
        Returns:
        this
      • set

        public Vector4L set​(int[] xyzw)
        Set the four components of this vector to the first four elements of the given array.
        Parameters:
        xyzw - the array containing at least four elements
        Returns:
        this
      • set

        public Vector4L set​(java.nio.ByteBuffer buffer)
        Read this vector from the supplied ByteBuffer at the current buffer position.

        This method will not increment the position of the given ByteBuffer.

        In order to specify the offset into the ByteBuffer at which the vector is read, use set(int, ByteBuffer), taking the absolute position as parameter.

        Parameters:
        buffer - values will be read in x, y, z, w order
        Returns:
        this
        See Also:
        set(int, ByteBuffer)
      • set

        public Vector4L set​(int index,
                            java.nio.ByteBuffer buffer)
        Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.

        This method will not increment the position of the given ByteBuffer.

        Parameters:
        index - the absolute position into the ByteBuffer
        buffer - values will be read in x, y, z, w order
        Returns:
        this
      • set

        public Vector4L set​(java.nio.LongBuffer buffer)
        Read this vector from the supplied LongBuffer at the current buffer position.

        This method will not increment the position of the given LongBuffer.

        In order to specify the offset into the LongBuffer at which the vector is read, use set(int, LongBuffer), taking the absolute position as parameter.

        Parameters:
        buffer - values will be read in x, y, z, w order
        Returns:
        this
        See Also:
        set(int, LongBuffer)
      • set

        public Vector4L set​(int index,
                            java.nio.LongBuffer buffer)
        Read this vector from the supplied LongBuffer starting at the specified absolute buffer position/index.

        This method will not increment the position of the given LongBuffer.

        Parameters:
        index - the absolute position into the LongBuffer
        buffer - values will be read in x, y, z, w order
        Returns:
        this
      • setFromAddress

        public Vector4L setFromAddress​(long address)
        Set the values of this vector by reading 4 integer values from off-heap memory, starting at the given address.

        This method will throw an UnsupportedOperationException when JOML is used with `-Djoml.nounsafe`.

        This method is unsafe as it can result in a crash of the JVM process when the specified address range does not belong to this process.

        Parameters:
        address - the off-heap memory address to read the vector values from
        Returns:
        this
      • get

        public long get​(int component)
                 throws java.lang.IllegalArgumentException
        Description copied from interface: Vector4Lc
        Get the value of the specified component of this vector.
        Specified by:
        get in interface Vector4Lc
        Parameters:
        component - the component, within [0..3]
        Returns:
        the value
        Throws:
        java.lang.IllegalArgumentException - if component is not within [0..3]
      • maxComponent

        public int maxComponent()
        Description copied from interface: Vector4Lc
        Determine the component with the biggest absolute value.
        Specified by:
        maxComponent in interface Vector4Lc
        Returns:
        the component index, within [0..3]
      • minComponent

        public int minComponent()
        Description copied from interface: Vector4Lc
        Determine the component with the smallest (towards zero) absolute value.
        Specified by:
        minComponent in interface Vector4Lc
        Returns:
        the component index, within [0..3]
      • setComponent

        public Vector4L setComponent​(int component,
                                     long value)
                              throws java.lang.IllegalArgumentException
        Set the value of the specified component of this vector.
        Parameters:
        component - the component whose value to set, within [0..3]
        value - the value to set
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException - if component is not within [0..3]
      • get

        public java.nio.LongBuffer get​(java.nio.LongBuffer buffer)
        Description copied from interface: Vector4Lc
        Store this vector into the supplied LongBuffer at the current buffer position.

        This method will not increment the position of the given LongBuffer.

        In order to specify the offset into the LongBuffer at which the vector is stored, use Vector4Lc.get(int, LongBuffer), taking the absolute position as parameter.

        Specified by:
        get in interface Vector4Lc
        Parameters:
        buffer - will receive the values of this vector in x, y, z, w order
        Returns:
        the passed in buffer
        See Also:
        Vector4Lc.get(int, LongBuffer)
      • get

        public java.nio.LongBuffer get​(int index,
                                       java.nio.LongBuffer buffer)
        Description copied from interface: Vector4Lc
        Store this vector into the supplied LongBuffer starting at the specified absolute buffer position/index.

        This method will not increment the position of the given LongBuffer.

        Specified by:
        get in interface Vector4Lc
        Parameters:
        index - the absolute position into the LongBuffer
        buffer - will receive the values of this vector in x, y, z, w order
        Returns:
        the passed in buffer
      • get

        public java.nio.ByteBuffer get​(java.nio.ByteBuffer buffer)
        Description copied from interface: Vector4Lc
        Store this vector into the supplied ByteBuffer at the current buffer position.

        This method will not increment the position of the given ByteBuffer.

        In order to specify the offset into the ByteBuffer at which the vector is stored, use Vector4Lc.get(int, ByteBuffer), taking the absolute position as parameter.

        Specified by:
        get in interface Vector4Lc
        Parameters:
        buffer - will receive the values of this vector in x, y, z, w order
        Returns:
        the passed in buffer
        See Also:
        Vector4Lc.get(int, ByteBuffer)
      • get

        public java.nio.ByteBuffer get​(int index,
                                       java.nio.ByteBuffer buffer)
        Description copied from interface: Vector4Lc
        Store this vector into the supplied ByteBuffer starting at the specified absolute buffer position/index.

        This method will not increment the position of the given ByteBuffer.

        Specified by:
        get in interface Vector4Lc
        Parameters:
        index - the absolute position into the ByteBuffer
        buffer - will receive the values of this vector in x, y, z, w order
        Returns:
        the passed in buffer
      • getToAddress

        public Vector4Lc getToAddress​(long address)
        Description copied from interface: Vector4Lc
        Store this vector at the given off-heap memory address.

        This method will throw an UnsupportedOperationException when JOML is used with `-Djoml.nounsafe`.

        This method is unsafe as it can result in a crash of the JVM process when the specified address range does not belong to this process.

        Specified by:
        getToAddress in interface Vector4Lc
        Parameters:
        address - the off-heap address where to store this vector
        Returns:
        this
      • sub

        public Vector4L sub​(Vector4Lc v)
        Subtract the supplied vector from this one.
        Parameters:
        v - the vector to subtract
        Returns:
        this
      • sub

        public Vector4L sub​(Vector4Lc v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Subtract the supplied vector from this one and store the result in dest.
        Specified by:
        sub in interface Vector4Lc
        Parameters:
        v - the vector to subtract from this
        dest - will hold the result
        Returns:
        dest
      • sub

        public Vector4L sub​(Vector4ic v)
        Subtract the supplied vector from this one.
        Parameters:
        v - the vector to subtract
        Returns:
        this
      • sub

        public Vector4L sub​(Vector4ic v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Subtract the supplied vector from this one and store the result in dest.
        Specified by:
        sub in interface Vector4Lc
        Parameters:
        v - the vector to subtract from this
        dest - will hold the result
        Returns:
        dest
      • sub

        public Vector4L sub​(long x,
                            long y,
                            long z,
                            long w)
        Subtract (x, y, z, w) from this.
        Parameters:
        x - the x component to subtract
        y - the y component to subtract
        z - the z component to subtract
        w - the w component to subtract
        Returns:
        this
      • sub

        public Vector4L sub​(long x,
                            long y,
                            long z,
                            long w,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Subtract (x, y, z, w) from this and store the result in dest.
        Specified by:
        sub in interface Vector4Lc
        Parameters:
        x - the x component to subtract
        y - the y component to subtract
        z - the z component to subtract
        w - the w component to subtract
        dest - will hold the result
        Returns:
        dest
      • add

        public Vector4L add​(Vector4Lc v)
        Add the supplied vector to this one.
        Parameters:
        v - the vector to add
        Returns:
        this
      • add

        public Vector4L add​(Vector4Lc v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Add the supplied vector to this one and store the result in dest.
        Specified by:
        add in interface Vector4Lc
        Parameters:
        v - the vector to add
        dest - will hold the result
        Returns:
        dest
      • add

        public Vector4L add​(Vector4ic v)
        Add the supplied vector to this one.
        Parameters:
        v - the vector to add
        Returns:
        this
      • add

        public Vector4L add​(Vector4ic v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Add the supplied vector to this one and store the result in dest.
        Specified by:
        add in interface Vector4Lc
        Parameters:
        v - the vector to add
        dest - will hold the result
        Returns:
        dest
      • add

        public Vector4L add​(long x,
                            long y,
                            long z,
                            long w)
        Increment the components of this vector by the given values.
        Parameters:
        x - the x component to add
        y - the y component to add
        z - the z component to add
        w - the w component to add
        Returns:
        this
      • add

        public Vector4L add​(long x,
                            long y,
                            long z,
                            long w,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Increment the components of this vector by the given values and store the result in dest.
        Specified by:
        add in interface Vector4Lc
        Parameters:
        x - the x component to add
        y - the y component to add
        z - the z component to add
        w - the w component to add
        dest - will hold the result
        Returns:
        dest
      • mul

        public Vector4L mul​(Vector4Lc v)
        Multiply this Vector4L component-wise by another vector.
        Parameters:
        v - the other vector
        Returns:
        this
      • mul

        public Vector4L mul​(Vector4Lc v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Multiply this Vector4L component-wise by another Vector4Lc and store the result in dest.
        Specified by:
        mul in interface Vector4Lc
        Parameters:
        v - the other vector
        dest - will hold the result
        Returns:
        dest
      • mul

        public Vector4L mul​(Vector4ic v)
        Multiply this Vector4L component-wise by another vector.
        Parameters:
        v - the other vector
        Returns:
        this
      • mul

        public Vector4L mul​(Vector4ic v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Multiply this Vector4L component-wise by another Vector4ic and store the result in dest.
        Specified by:
        mul in interface Vector4Lc
        Parameters:
        v - the other vector
        dest - will hold the result
        Returns:
        dest
      • div

        public Vector4L div​(Vector4Lc v)
        Divide this Vector4L component-wise by another vector.
        Parameters:
        v - the vector to divide by
        Returns:
        this
      • div

        public Vector4L div​(Vector4Lc v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Divide this Vector4L component-wise by another Vector4Lc and store the result in dest.
        Specified by:
        div in interface Vector4Lc
        Parameters:
        v - the vector to divide by
        dest - will hold the result
        Returns:
        dest
      • div

        public Vector4L div​(Vector4ic v)
        Divide this Vector4L component-wise by another vector.
        Parameters:
        v - the vector to divide by
        Returns:
        this
      • div

        public Vector4L div​(Vector4ic v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Divide this Vector4L component-wise by another Vector4ic and store the result in dest.
        Specified by:
        div in interface Vector4Lc
        Parameters:
        v - the vector to divide by
        dest - will hold the result
        Returns:
        dest
      • mul

        public Vector4L mul​(long scalar)
        Multiply all components of this vector by the given scalar value.
        Parameters:
        scalar - the scalar to multiply by
        Returns:
        this
      • mul

        public Vector4L mul​(long scalar,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Multiply all components of this vector by the given scalar value and store the result in dest.
        Specified by:
        mul in interface Vector4Lc
        Parameters:
        scalar - the scalar to multiply by
        dest - will hold the result
        Returns:
        dest
      • div

        public Vector4L div​(float scalar)
        Divide all components of this vector by the given scalar value.
        Parameters:
        scalar - the scalar to divide by
        Returns:
        this
      • div

        public Vector4L div​(float scalar,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Divide all components of this vector by the given scalar value and store the result in dest.
        Specified by:
        div in interface Vector4Lc
        Parameters:
        scalar - the scalar to divide by
        dest - will hold the result
        Returns:
        dest
      • div

        public Vector4L div​(long scalar)
        Divide all components of this vector by the given scalar value.
        Parameters:
        scalar - the scalar to divide by
        Returns:
        this
      • div

        public Vector4L div​(long scalar,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Divide all components of this vector by the given scalar value and store the result in dest.
        Specified by:
        div in interface Vector4Lc
        Parameters:
        scalar - the scalar to divide by
        dest - will hold the result
        Returns:
        dest
      • lengthSquared

        public long lengthSquared()
        Description copied from interface: Vector4Lc
        Return the length squared of this vector.
        Specified by:
        lengthSquared in interface Vector4Lc
        Returns:
        the length squared
      • lengthSquared

        public static long lengthSquared​(long x,
                                         long y,
                                         long z,
                                         long w)
        Get the length squared of a 4-dimensional single-precision vector.
        Parameters:
        x - The vector's x component
        y - The vector's y component
        z - The vector's z component
        w - The vector's w component
        Returns:
        the length squared of the given vector
      • length

        public double length()
        Description copied from interface: Vector4Lc
        Return the length of this vector.
        Specified by:
        length in interface Vector4Lc
        Returns:
        the length
      • length

        public static double length​(long x,
                                    long y,
                                    long z,
                                    long w)
        Get the length of a 4-dimensional single-precision vector.
        Parameters:
        x - The vector's x component
        y - The vector's y component
        z - The vector's z component
        w - The vector's w component
        Returns:
        the length squared of the given vector
      • distance

        public double distance​(Vector4Lc v)
        Description copied from interface: Vector4Lc
        Return the distance between this Vector and v.
        Specified by:
        distance in interface Vector4Lc
        Parameters:
        v - the other vector
        Returns:
        the distance
      • distance

        public double distance​(Vector4ic v)
        Description copied from interface: Vector4Lc
        Return the distance between this Vector and v.
        Specified by:
        distance in interface Vector4Lc
        Parameters:
        v - the other vector
        Returns:
        the distance
      • distance

        public double distance​(long x,
                               long y,
                               long z,
                               long w)
        Description copied from interface: Vector4Lc
        Return the distance between this vector and (x, y, z, w).
        Specified by:
        distance in interface Vector4Lc
        Parameters:
        x - the x component of the other vector
        y - the y component of the other vector
        z - the z component of the other vector
        w - the w component of the other vector
        Returns:
        the euclidean distance
      • gridDistance

        public long gridDistance​(Vector4Lc v)
        Description copied from interface: Vector4Lc
        Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance) (x, y).
        Specified by:
        gridDistance in interface Vector4Lc
        Parameters:
        v - the other vector
        Returns:
        the grid distance
      • gridDistance

        public long gridDistance​(Vector4ic v)
        Description copied from interface: Vector4Lc
        Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance) (x, y).
        Specified by:
        gridDistance in interface Vector4Lc
        Parameters:
        v - the other vector
        Returns:
        the grid distance
      • gridDistance

        public long gridDistance​(long x,
                                 long y,
                                 long z,
                                 long w)
        Description copied from interface: Vector4Lc
        Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance) (x, y).
        Specified by:
        gridDistance in interface Vector4Lc
        Parameters:
        x - the x component of the other vector
        y - the y component of the other vector
        z - the z component of the other vector
        w - the w component of the other vector
        Returns:
        the grid distance
      • distanceSquared

        public long distanceSquared​(Vector4Lc v)
        Description copied from interface: Vector4Lc
        Return the square of the distance between this vector and v.
        Specified by:
        distanceSquared in interface Vector4Lc
        Parameters:
        v - the other vector
        Returns:
        the squared of the distance
      • distanceSquared

        public long distanceSquared​(Vector4ic v)
        Description copied from interface: Vector4Lc
        Return the square of the distance between this vector and v.
        Specified by:
        distanceSquared in interface Vector4Lc
        Parameters:
        v - the other vector
        Returns:
        the squared of the distance
      • distanceSquared

        public long distanceSquared​(long x,
                                    long y,
                                    long z,
                                    long w)
        Description copied from interface: Vector4Lc
        Return the square of the distance between this vector and (x, y, z, w).
        Specified by:
        distanceSquared in interface Vector4Lc
        Parameters:
        x - the x component of the other vector
        y - the y component of the other vector
        z - the z component of the other vector
        w - the w component of the other vector
        Returns:
        the square of the distance
      • distance

        public static double distance​(long x1,
                                      long y1,
                                      long z1,
                                      long w1,
                                      long x2,
                                      long y2,
                                      long z2,
                                      long w2)
        Return the distance between (x1, y1, z1, w1) and (x2, y2, z2, w2).
        Parameters:
        x1 - the x component of the first vector
        y1 - the y component of the first vector
        z1 - the z component of the first vector
        w1 - the w component of the first vector
        x2 - the x component of the second vector
        y2 - the y component of the second vector
        z2 - the z component of the second vector
        w2 - the 2 component of the second vector
        Returns:
        the euclidean distance
      • distanceSquared

        public static long distanceSquared​(long x1,
                                           long y1,
                                           long z1,
                                           long w1,
                                           long x2,
                                           long y2,
                                           long z2,
                                           long w2)
        Return the squared distance between (x1, y1, z1, w1) and (x2, y2, z2, w2).
        Parameters:
        x1 - the x component of the first vector
        y1 - the y component of the first vector
        z1 - the z component of the first vector
        w1 - the w component of the first vector
        x2 - the x component of the second vector
        y2 - the y component of the second vector
        z2 - the z component of the second vector
        w2 - the w component of the second vector
        Returns:
        the euclidean distance squared
      • dot

        public long dot​(Vector4Lc v)
        Description copied from interface: Vector4Lc
        Compute the dot product (inner product) of this vector and v.
        Specified by:
        dot in interface Vector4Lc
        Parameters:
        v - the other vector
        Returns:
        the dot product
      • dot

        public long dot​(Vector4ic v)
        Description copied from interface: Vector4Lc
        Compute the dot product (inner product) of this vector and v.
        Specified by:
        dot in interface Vector4Lc
        Parameters:
        v - the other vector
        Returns:
        the dot product
      • zero

        public Vector4L zero()
        Set all components to zero.
        Returns:
        this
      • negate

        public Vector4L negate()
        Negate this vector.
        Returns:
        this
      • negate

        public Vector4L negate​(Vector4L dest)
        Description copied from interface: Vector4Lc
        Negate this vector and store the result in dest.
        Specified by:
        negate in interface Vector4Lc
        Parameters:
        dest - will hold the result
        Returns:
        dest
      • toString

        public java.lang.String toString()
        Return a string representation of this vector.

        This method creates a new DecimalFormat on every invocation with the format string "0.000E0;-".

        Overrides:
        toString in class java.lang.Object
        Returns:
        the string representation
      • toString

        public java.lang.String toString​(java.text.NumberFormat formatter)
        Return a string representation of this vector by formatting the vector components with the given NumberFormat.
        Parameters:
        formatter - the NumberFormat used to format the vector components with
        Returns:
        the string representation
      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                           throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException
      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException
      • min

        public Vector4L min​(Vector4Lc v)
        Set the components of this vector to be the component-wise minimum of this and the other vector.
        Parameters:
        v - the other vector
        Returns:
        this
      • min

        public Vector4L min​(Vector4Lc v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Set the components of dest to be the component-wise minimum of this and the other vector.
        Specified by:
        min in interface Vector4Lc
        Parameters:
        v - the other vector
        dest - will hold the result
        Returns:
        dest
      • max

        public Vector4L max​(Vector4Lc v)
        Set the components of this vector to be the component-wise maximum of this and the other vector.
        Parameters:
        v - the other vector
        Returns:
        this
      • max

        public Vector4L max​(Vector4Lc v,
                            Vector4L dest)
        Description copied from interface: Vector4Lc
        Set the components of dest to be the component-wise maximum of this and the other vector.
        Specified by:
        max in interface Vector4Lc
        Parameters:
        v - the other vector
        dest - will hold the result
        Returns:
        dest
      • absolute

        public Vector4L absolute()
        Compute the absolute of each of this vector's components.
        Returns:
        this
      • absolute

        public Vector4L absolute​(Vector4L dest)
        Description copied from interface: Vector4Lc
        Compute the absolute of each of this vector's components and store the result into dest.
        Specified by:
        absolute in interface Vector4Lc
        Parameters:
        dest - will hold the result
        Returns:
        dest
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • equals

        public boolean equals​(long x,
                              long y,
                              long z,
                              long w)
        Description copied from interface: Vector4Lc
        Compare the vector components of this vector with the given (x, y, z, w) and return whether all of them are equal.
        Specified by:
        equals in interface Vector4Lc
        Parameters:
        x - the x component to compare to
        y - the y component to compare to
        z - the z component to compare to
        w - the w component to compare to
        Returns:
        true if all the vector components are equal
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException