java.lang.Object

com.io7m.jtensors.core.parameterized.vectors.PVector4D<T>

Type Parameters:: T - A phantom type parameter

All Implemented Interfaces:: PVector4DType<T>, PVectorReadable2DType<T>, PVectorReadable3DType<T>, PVectorReadable4DType<T>, VectorReadable2DType, VectorReadable3DType, VectorReadable4DType, VectorComputationalType

public final class PVector4D<T>
extends java.lang.Object
implements PVector4DType<T>

The type of 4D double-typed vectors.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class PVector4D.Builder<T>
Builds instances of type PVector4D.

Method Summary

Modifier and Type	Method	Description
`static <T> PVector4D.Builder<T>`	`builder()`	Creates a builder for `PVector4D`.
`static <T> PVector4D<T>`	`copyOf(PVector4DType<T> instance)`	Creates an immutable copy of a `PVector4DType` value.
`boolean`	`equals(java.lang.Object another)`	This instance is equal to all instances of `PVector4D` that have equal attribute values.
`int`	`hashCode()`	Computes a hash code from attributes: `x`, `y`, `z`, `w`.
`static <T> PVector4D<T>`	`of(double x, double y, double z, double w)`	Construct a new immutable `PVector4D` instance.
`java.lang.String`	`toString()`	Prints the immutable value `PVector4D` with attribute values.
`double`	`w()`
`PVector4D<T>`	`withW(double value)`	Copy the current immutable object by setting a value for the `w` attribute.
`PVector4D<T>`	`withX(double value)`	Copy the current immutable object by setting a value for the `x` attribute.
`PVector4D<T>`	`withY(double value)`	Copy the current immutable object by setting a value for the `y` attribute.
`PVector4D<T>`	`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 PVector4DType<T>
  
  Specified by:
  
  x in interface VectorReadable2DType
  
  Returns:
  
  The value of the x attribute
- y
  
  public double y()
  
  Specified by:
  
  y in interface PVector4DType<T>
  
  Specified by:
  
  y in interface VectorReadable2DType
  
  Returns:
  
  The value of the y attribute
- z
  
  public double z()
  
  Specified by:
  
  z in interface PVector4DType<T>
  
  Specified by:
  
  z in interface VectorReadable3DType
  
  Returns:
  
  The value of the z attribute
- w
  
  public double w()
  
  Specified by:
  
  w in interface PVector4DType<T>
  
  Specified by:
  
  w in interface VectorReadable4DType
  
  Returns:
  
  The value of the w attribute
- withX
  
  public final PVector4D<T> 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 PVector4D<T> 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 PVector4D<T> 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
- withW
  
  public final PVector4D<T> withW(double value)
  
  Copy the current immutable object by setting a value for the w attribute. A value strict bits equality used to prevent copying of the same value by returning this.
  
  Parameters:
  
  value - A new value for w
  
  Returns:
  
  A modified copy of the this object
- equals
  
  public boolean equals(java.lang.Object another)
  
  This instance is equal to all instances of PVector4D that have equal attribute values.
  
  Overrides:
  
  equals in class java.lang.Object
  
  Returns:
  
  true if this is equal to another instance
- hashCode
  
  public int hashCode()
  
  Computes a hash code from attributes: x, y, z, w.
  
  Overrides:
  
  hashCode in class java.lang.Object
  
  Returns:
  
  hashCode value
- toString
  
  public java.lang.String toString()
  
  Prints the immutable value PVector4D with attribute values.
  
  Overrides:
  
  toString in class java.lang.Object
  
  Returns:
  
  A string representation of the value
- of
  
  public static <T> PVector4D<T> of(double x, double y, double z, double w)
  
  Construct a new immutable PVector4D instance.
  
  Type Parameters:
  
  T - generic parameter T
  
  Parameters:
  
  x - The value for the x attribute
  
  y - The value for the y attribute
  
  z - The value for the z attribute
  
  w - The value for the w attribute
  
  Returns:
  
  An immutable PVector4D instance
- copyOf
  
  public static <T> PVector4D<T> copyOf(PVector4DType<T> instance)
  
  Creates an immutable copy of a PVector4DType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
  
  Type Parameters:
  
  T - generic parameter T
  
  Parameters:
  
  instance - The instance to copy
  
  Returns:
  
  A copied immutable PVector4D instance
- builder
  
  public static <T> PVector4D.Builder<T> builder()
  Creates a builder for PVector4D.
  PVector4D.<T>builder() .setX(double) // required x .setY(double) // required y .setZ(double) // required z .setW(double) // required w .build();
  Type Parameters:
  
  T - generic parameter T
  
  Returns:
  
  A new PVector4D builder

Class PVector4D<T>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Details