Package org.joml

Class Vector2L

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Vector2Lc
    public class Vector2L
extends java.lang.Object
implements java.io.Externalizable, java.lang.Cloneable, Vector2Lc
    Contains the definition of a vector comprising 2 longs and associated transformations.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      long x
      The x component of the vector.
      long y
      The y component of the vector.

    • Constructor Summary

      Constructors 
      Constructor Description
      Vector2L()
      Create a new Vector2L and initialize its components to zero.
      Vector2L​(double x, double y, int mode)
      Create a new Vector2L and initialize its component values and round using the given RoundingMode.
      Vector2L​(float x, float y, int mode)
      Create a new Vector2L and initialize its component values and round using the given RoundingMode.
      Vector2L​(int index, java.nio.ByteBuffer buffer)
      Create a new Vector2L and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
      Vector2L​(int index, java.nio.LongBuffer buffer)
      Create a new Vector2L and read this vector from the supplied LongBuffer starting at the specified absolute buffer position/index.
      Vector2L​(long s)
      Create a new Vector2L and initialize both of its components with the given value.
      Vector2L​(long[] xy)
      Create a new Vector2L and initialize its two components from the first two elements of the given array.
      Vector2L​(long x, long y)
      Create a new Vector2L and initialize its components to the given values.
      Vector2L​(java.nio.ByteBuffer buffer)
      Create a new Vector2L and read this vector from the supplied ByteBuffer at the current buffer position.
      Vector2L​(java.nio.LongBuffer buffer)
      Create a new Vector2L and read this vector from the supplied LongBuffer at the current buffer position.
      Vector2L​(Vector2dc v, int mode)
      Create a new Vector2L and initialize its components to the rounded value of the given vector.
      Vector2L​(Vector2fc v, int mode)
      Create a new Vector2L and initialize its components to the rounded value of the given vector.
      Vector2L​(Vector2ic v)
      Create a new Vector2L and initialize its components to the one of the given vector.
      Vector2L​(Vector2Lc v)
      Create a new Vector2L and initialize its components to the one of the given vector.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Vector2L absolute()
      Set this vector's components to their respective absolute values.
      Vector2L absolute​(Vector2L dest)
      Compute the absolute of each of this vector's components and store the result into dest.
      Vector2L add​(long x, long y)
      Increment the components of this vector by the given values.
      Vector2L add​(long x, long y, Vector2L dest)
      Increment the components of this vector by the given values and store the result in dest.
      Vector2L add​(Vector2ic v)
      Add v to this vector.
      Vector2L add​(Vector2ic v, Vector2L dest)  
      Vector2L add​(Vector2Lc v)
      Add v to this vector.
      Vector2L add​(Vector2Lc v, Vector2L dest)
      Add the supplied vector to this one and store the result in dest.
      java.lang.Object clone()  
      double distance​(long x, long y)
      Return the distance between this vector and (x, y).
      static double distance​(long x1, long y1, long x2, long y2)
      Return the distance between (x1, y1) and (x2, y2).
      double distance​(Vector2Lc v)
      Return the distance between this Vector and v.
      long distanceSquared​(long x, long y)
      Return the square of the distance between this vector and (x, y).
      static long distanceSquared​(long x1, long y1, long x2, long y2)
      Return the squared distance between (x1, y1) and (x2, y2).
      long distanceSquared​(Vector2Lc v)
      Return the square of the distance between this vector and v.
      Vector2L div​(float scalar)
      Divide all components of this vector by the given scalar value.
      Vector2L div​(float scalar, Vector2L dest)
      Divide all components of this vector by the given scalar value and store the result in dest.
      Vector2L div​(long scalar)
      Divide all components of this vector by the given scalar value.
      Vector2L div​(long scalar, Vector2L dest)
      Divide all components of this vector by the given scalar value and store the result in dest.
      boolean equals​(long x, long y)
      Compare the vector components of this vector with the given (x, y) 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.
      Vector2Lc getToAddress​(long address)
      Store this vector at the given off-heap memory address.
      long gridDistance​(long x, long y)
      Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance) (x, y).
      long gridDistance​(Vector2Lc 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)
      Get the length of a 2-dimensional single-precision vector.
      long lengthSquared()
      Return the length squared of this vector.
      static long lengthSquared​(long x, long y)
      Get the length squared of a 2-dimensional single-precision vector.
      Vector2L max​(Vector2Lc v)
      Set the components of this vector to be the component-wise maximum of this and the other vector.
      Vector2L max​(Vector2Lc v, Vector2L dest)
      Set the components of dest to be the component-wise maximum of this and the other vector.
      long maxComponent()
      Determine the component with the biggest absolute value.
      Vector2L min​(Vector2Lc v)
      Set the components of this vector to be the component-wise minimum of this and the other vector.
      Vector2L min​(Vector2Lc v, Vector2L dest)
      Set the components of dest to be the component-wise minimum of this and the other vector.
      long minComponent()
      Determine the component with the smallest (towards zero) absolute value.
      Vector2L mul​(long scalar)
      Multiply all components of this vector by the given scalar value.
      Vector2L mul​(long x, long y)
      Multiply the components of this vector by the given values.
      Vector2L mul​(long x, long y, Vector2L dest)
      Multiply the components of this vector by the given values and store the result in dest.
      Vector2L mul​(long scalar, Vector2L dest)
      Multiply all components of this Vector2Lc by the given scalar value and store the result in dest.
      Vector2L mul​(Vector2ic v)
      Add the supplied vector by this one.
      Vector2L mul​(Vector2ic v, Vector2L dest)  
      Vector2L mul​(Vector2Lc v)
      Add the supplied vector by this one.
      Vector2L mul​(Vector2Lc v, Vector2L dest)
      Multiply the supplied vector by this one and store the result in dest.
      Vector2L negate()
      Negate this vector.
      Vector2L negate​(Vector2L dest)
      Negate this vector and store the result in dest.
      void readExternal​(java.io.ObjectInput in)  
      Vector2L set​(int index, java.nio.ByteBuffer buffer)
      Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
      Vector2L set​(int index, java.nio.LongBuffer buffer)
      Read this vector from the supplied LongBuffer starting at the specified absolute buffer position/index.
      Vector2L set​(long s)
      Set the x and y components to the supplied value.
      Vector2L set​(long[] xy)
      Set the two components of this vector to the first two elements of the given array.
      Vector2L set​(long x, long y)
      Set the x and y components to the supplied values.
      Vector2L set​(java.nio.ByteBuffer buffer)
      Read this vector from the supplied ByteBuffer at the current buffer position.
      Vector2L set​(java.nio.LongBuffer buffer)
      Read this vector from the supplied LongBuffer at the current buffer position.
      Vector2L set​(Vector2dc v)
      Set this vector to the values of v using RoundingMode.TRUNCATE rounding.
      Vector2L set​(Vector2dc v, int mode)
      Set this vector to the values of v using the given RoundingMode.
      Vector2L set​(Vector2fc v, int mode)
      Set this vector to the values of v using the given RoundingMode.
      Vector2L set​(Vector2ic v)
      Set this vector to the values of v.
      Vector2L set​(Vector2Lc v)
      Set this vector to the values of v.
      Vector2L setComponent​(int component, long value)
      Set the value of the specified component of this vector.
      Vector2L setFromAddress​(long address)
      Set the values of this vector by reading 2 integer values from off-heap memory, starting at the given address.
      Vector2L sub​(long x, long y)
      Decrement the components of this vector by the given values.
      Vector2L sub​(long x, long y, Vector2L dest)
      Decrement the components of this vector by the given values and store the result in dest.
      Vector2L sub​(Vector2ic v)
      Subtract the supplied vector from this one and store the result in this.
      Vector2L sub​(Vector2ic v, Vector2L dest)  
      Vector2L sub​(Vector2Lc v)
      Subtract the supplied vector from this one and store the result in this.
      Vector2L sub​(Vector2Lc v, Vector2L 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.
      void writeExternal​(java.io.ObjectOutput out)  
      long x()  
      long y()  
      Vector2L 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.

    • Constructor Detail

      • Vector2L

        public Vector2L()
        Create a new Vector2L and initialize its components to zero.

      • Vector2L

        public Vector2L​(long s)
        Create a new Vector2L and initialize both of its components with the given value.
        Parameters:
        s - the value of both components

      • Vector2L

        public Vector2L​(long x,
                long y)
        Create a new Vector2L and initialize its components to the given values.
        Parameters:
        x - the x component
        y - the y component

      • Vector2L

        public Vector2L​(float x,
                float y,
                int mode)
        Create a new Vector2L and initialize its component values and round using the given RoundingMode.
        Parameters:
        x - the x component
        y - the y component
        mode - the RoundingMode to use

      • Vector2L

        public Vector2L​(double x,
                double y,
                int mode)
        Create a new Vector2L and initialize its component values and round using the given RoundingMode.
        Parameters:
        x - the x component
        y - the y component
        mode - the RoundingMode to use

      • Vector2L

        public Vector2L​(Vector2Lc v)
        Create a new Vector2L and initialize its components to the one of the given vector.
        Parameters:
        v - the Vector2Lc to copy the values from

      • Vector2L

        public Vector2L​(Vector2ic v)
        Create a new Vector2L and initialize its components to the one of the given vector.
        Parameters:
        v - the Vector2ic to copy the values from

      • Vector2L

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

      • Vector2L

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

      • Vector2L

        public Vector2L​(long[] xy)
        Create a new Vector2L and initialize its two components from the first two elements of the given array.
        Parameters:
        xy - the array containing at least three elements

      • Vector2L

        public Vector2L​(java.nio.ByteBuffer buffer)
        Create a new Vector2L 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 Vector2L(int, ByteBuffer), taking the absolute position as parameter.

        Parameters:
        buffer - values will be read in x, y order
        See Also:
        Vector2L(int, ByteBuffer)

      • Vector2L

        public Vector2L​(int index,
                java.nio.ByteBuffer buffer)
        Create a new Vector2L 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 order

      • Vector2L

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

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

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

        Parameters:
        buffer - values will be read in x, y order
        See Also:
        Vector2L(int, LongBuffer)

      • Vector2L

        public Vector2L​(int index,
                java.nio.LongBuffer buffer)
        Create a new Vector2L 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 IntBuffer.

        Parameters:
        index - the absolute position into the IntBuffer
        buffer - values will be read in x, y order

    • Method Detail

      • x

        public long x()
        Specified by:
        x in interface Vector2Lc
        Returns:
        the value of the x component

      • y

        public long y()
        Specified by:
        y in interface Vector2Lc
        Returns:
        the value of the y component

      • set

        public Vector2L set​(long s)
        Set the x and y components to the supplied value.
        Parameters:
        s - scalar value of both components
        Returns:
        this

      • set

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

      • set

        public Vector2L set​(Vector2Lc v)
        Set this vector to the values of v.
        Parameters:
        v - the vector to copy from
        Returns:
        this

      • set

        public Vector2L set​(Vector2ic v)
        Set this vector to the values of v.
        Parameters:
        v - the vector to copy from
        Returns:
        this

      • set

        public Vector2L set​(Vector2dc 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 Vector2L set​(Vector2dc 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 Vector2L set​(Vector2fc 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 Vector2L set​(long[] xy)
        Set the two components of this vector to the first two elements of the given array.
        Parameters:
        xy - the array containing at least two elements
        Returns:
        this

      • set

        public Vector2L 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 order
        Returns:
        this
        See Also:
        set(int, ByteBuffer)

      • set

        public Vector2L 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 order
        Returns:
        this

      • set

        public Vector2L 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 IntBuffer.

        In order to specify the offset into the IntBuffer 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 order
        Returns:
        this
        See Also:
        set(int, LongBuffer)

      • set

        public Vector2L 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 IntBuffer.

        Parameters:
        index - the absolute position into the IntBuffer
        buffer - values will be read in x, y order
        Returns:
        this

      • setFromAddress

        public Vector2L setFromAddress​(long address)
        Set the values of this vector by reading 2 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: Vector2Lc
        Get the value of the specified component of this vector.
        Specified by:
        get in interface Vector2Lc
        Parameters:
        component - the component, within [0..1]
        Returns:
        the value
        Throws:
        java.lang.IllegalArgumentException - if component is not within [0..1]

      • setComponent

        public Vector2L 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..1]
        value - the value to set
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException - if component is not within [0..1]

      • get

        public java.nio.ByteBuffer get​(java.nio.ByteBuffer buffer)
        Description copied from interface: Vector2Lc
        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 Vector2Lc.get(int, ByteBuffer), taking the absolute position as parameter.

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

      • get

        public java.nio.ByteBuffer get​(int index,
                               java.nio.ByteBuffer buffer)
        Description copied from interface: Vector2Lc
        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 Vector2Lc
        Parameters:
        index - the absolute position into the ByteBuffer
        buffer - will receive the values of this vector in x, y order
        Returns:
        the passed in buffer

      • get

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

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

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

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

      • get

        public java.nio.LongBuffer get​(int index,
                               java.nio.LongBuffer buffer)
        Description copied from interface: Vector2Lc
        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 IntBuffer.

        Specified by:
        get in interface Vector2Lc
        Parameters:
        index - the absolute position into the IntBuffer
        buffer - will receive the values of this vector in x, y order
        Returns:
        the passed in buffer

      • getToAddress

        public Vector2Lc getToAddress​(long address)
        Description copied from interface: Vector2Lc
        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 Vector2Lc
        Parameters:
        address - the off-heap address where to store this vector
        Returns:
        this

      • sub

        public Vector2L sub​(Vector2Lc v)
        Subtract the supplied vector from this one and store the result in this.
        Parameters:
        v - the vector to subtract
        Returns:
        this

      • sub

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

      • sub

        public Vector2L sub​(Vector2ic v)
        Subtract the supplied vector from this one and store the result in this.
        Parameters:
        v - the vector to subtract
        Returns:
        this

      • sub

        public Vector2L sub​(long x,
                    long y)
        Decrement the components of this vector by the given values.
        Parameters:
        x - the x component to subtract
        y - the y component to subtract
        Returns:
        this

      • sub

        public Vector2L sub​(long x,
                    long y,
                    Vector2L dest)
        Description copied from interface: Vector2Lc
        Decrement the components of this vector by the given values and store the result in dest.
        Specified by:
        sub in interface Vector2Lc
        Parameters:
        x - the x component to subtract
        y - the y component to subtract
        dest - will hold the result
        Returns:
        dest

      • lengthSquared

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

      • lengthSquared

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

      • length

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

      • length

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

      • distance

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

      • distance

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

      • distanceSquared

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

      • distanceSquared

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

      • gridDistance

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

      • gridDistance

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

      • distance

        public static double distance​(long x1,
                              long y1,
                              long x2,
                              long y2)
        Return the distance between (x1, y1) and (x2, y2).
        Parameters:
        x1 - the x component of the first vector
        y1 - the y component of the first vector
        x2 - the x component of the second vector
        y2 - the y component of the second vector
        Returns:
        the euclidean distance

      • distanceSquared

        public static long distanceSquared​(long x1,
                                   long y1,
                                   long x2,
                                   long y2)
        Return the squared distance between (x1, y1) and (x2, y2).
        Parameters:
        x1 - the x component of the first vector
        y1 - the y component of the first vector
        x2 - the x component of the second vector
        y2 - the y component of the second vector
        Returns:
        the euclidean distance squared

      • add

        public Vector2L add​(Vector2Lc v)
        Add v to this vector.
        Parameters:
        v - the vector to add
        Returns:
        this

      • add

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

      • add

        public Vector2L add​(Vector2ic v)
        Add v to this vector.
        Parameters:
        v - the vector to add
        Returns:
        this

      • add

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

      • add

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

      • mul

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

      • mul

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

      • mul

        public Vector2L mul​(Vector2Lc v)
        Add the supplied vector by this one.
        Parameters:
        v - the vector to multiply
        Returns:
        this

      • mul

        public Vector2L mul​(Vector2Lc v,
                    Vector2L dest)
        Description copied from interface: Vector2Lc
        Multiply the supplied vector by this one and store the result in dest.
        Specified by:
        mul in interface Vector2Lc
        Parameters:
        v - the vector to multiply
        dest - will hold the result
        Returns:
        dest

      • mul

        public Vector2L mul​(Vector2ic v)
        Add the supplied vector by this one.
        Parameters:
        v - the vector to multiply
        Returns:
        this

      • mul

        public Vector2L mul​(long x,
                    long y)
        Multiply the components of this vector by the given values.
        Parameters:
        x - the x component to multiply
        y - the y component to multiply
        Returns:
        this

      • mul

        public Vector2L mul​(long x,
                    long y,
                    Vector2L dest)
        Description copied from interface: Vector2Lc
        Multiply the components of this vector by the given values and store the result in dest.
        Specified by:
        mul in interface Vector2Lc
        Parameters:
        x - the x component to multiply
        y - the y component to multiply
        dest - will hold the result
        Returns:
        dest

      • div

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

      • div

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

      • div

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

      • div

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

      • zero

        public Vector2L zero()
        Set all components to zero.
        Returns:
        this

      • 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

      • negate

        public Vector2L negate()
        Negate this vector.
        Returns:
        this

      • negate

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

      • min

        public Vector2L min​(Vector2Lc 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 Vector2L min​(Vector2Lc v,
                    Vector2L dest)
        Description copied from interface: Vector2Lc
        Set the components of dest to be the component-wise minimum of this and the other vector.
        Specified by:
        min in interface Vector2Lc
        Parameters:
        v - the other vector
        dest - will hold the result
        Returns:
        dest

      • max

        public Vector2L max​(Vector2Lc 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 Vector2L max​(Vector2Lc v,
                    Vector2L dest)
        Description copied from interface: Vector2Lc
        Set the components of dest to be the component-wise maximum of this and the other vector.
        Specified by:
        max in interface Vector2Lc
        Parameters:
        v - the other vector
        dest - will hold the result
        Returns:
        dest

      • maxComponent

        public long maxComponent()
        Description copied from interface: Vector2Lc
        Determine the component with the biggest absolute value.
        Specified by:
        maxComponent in interface Vector2Lc
        Returns:
        the component index, within [0..1]

      • minComponent

        public long minComponent()
        Description copied from interface: Vector2Lc
        Determine the component with the smallest (towards zero) absolute value.
        Specified by:
        minComponent in interface Vector2Lc
        Returns:
        the component index, within [0..1]

      • absolute

        public Vector2L absolute()
        Set this vector's components to their respective absolute values.
        Returns:
        this

      • absolute

        public Vector2L absolute​(Vector2L dest)
        Description copied from interface: Vector2Lc
        Compute the absolute of each of this vector's components and store the result into dest.
        Specified by:
        absolute in interface Vector2Lc
        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)
        Description copied from interface: Vector2Lc
        Compare the vector components of this vector with the given (x, y) and return whether all of them are equal.
        Specified by:
        equals in interface Vector2Lc
        Parameters:
        x - the x component to compare to
        y - the y component to compare to
        Returns:
        true if all the vector components are equal

      • 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

      • clone

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