Package com.io7m.jtensors.core.unparameterized.vectors

Class Vector3D

java.lang.Object
com.io7m.jtensors.core.unparameterized.vectors.Vector3D
All Implemented Interfaces:
Vector3DType, VectorReadable2DType, VectorReadable3DType, VectorComputationalType
public final class Vector3D extends Object implements Vector3DType
The type of 3D double-typed vectors.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Vector3D.Builder
    Builds instances of type Vector3D.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Vector3D.Builder
    builder()
    Creates a builder for Vector3D.
    static Vector3D
    copyOf(Vector3DType instance)
    Creates an immutable copy of a Vector3DType value.
    boolean
    equals(Object another)
    This instance is equal to all instances of Vector3D that have equal attribute values.
    int
    hashCode()
    Computes a hash code from attributes: x, y, z.
    static Vector3D
    of(double x, double y, double z)
    Construct a new immutable Vector3D instance.
    String
    toString()
    Prints the immutable value Vector3D with attribute values.
    final Vector3D
    withX(double value)
    Copy the current immutable object by setting a value for the x attribute.
    final Vector3D
    withY(double value)
    Copy the current immutable object by setting a value for the y attribute.
    final Vector3D
    withZ(double value)
    Copy the current immutable object by setting a value for the z attribute.
    double
    x()
     
    double
    y()
     
    double
    z()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • x

      public double x()
      Specified by:
      x in interface Vector3DType
      Specified by:
      x in interface VectorReadable2DType
      Returns:
      The value of the x attribute

    • y

      public double y()
      Specified by:
      y in interface Vector3DType
      Specified by:
      y in interface VectorReadable2DType
      Returns:
      The value of the y attribute

    • z

      public double z()
      Specified by:
      z in interface Vector3DType
      Specified by:
      z in interface VectorReadable3DType
      Returns:
      The value of the z attribute

    • withX

      public final Vector3D withX(double value)
      Copy the current immutable object by setting a value for the x attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for x
      Returns:
      A modified copy of the this object

    • withY

      public final Vector3D withY(double value)
      Copy the current immutable object by setting a value for the y attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for y
      Returns:
      A modified copy of the this object

    • withZ

      public final Vector3D withZ(double value)
      Copy the current immutable object by setting a value for the z attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for z
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of Vector3D that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: x, y, z.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value Vector3D with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • of

      public static Vector3D of(double x, double y, double z)
      Construct a new immutable Vector3D instance.
      Parameters:
      x - The value for the x attribute
      y - The value for the y attribute
      z - The value for the z attribute
      Returns:
      An immutable Vector3D instance

    • copyOf

      public static Vector3D copyOf(Vector3DType instance)
      Creates an immutable copy of a Vector3DType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable Vector3D instance

    • builder

      public static Vector3D.Builder builder()
      Creates a builder for Vector3D. 
       Vector3D.builder()
    .setX(double) // required x
    .setY(double) // required y
    .setZ(double) // required z
    .build();
      Returns:
      A new Vector3D builder