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

@Generated(value={"Immutables.generator","Vector3DType"})
public final class Vector3D
extends Object
implements Vector3DType

The type of 3D double-typed vectors.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Vector3D.Builder	builder() Creates a builder for Vector3D.
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.
double	x()
double	y()
double	z()

Methods inherited from class java.lang.Object

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

Method Detail

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

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

builder

public static Vector3D.Builder builder()

Creates a builder for Vector3D.

Returns:

A new Vector3D builder