Module com.io7m.jtensors.core

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

Class Vector2D

java.lang.Object

com.io7m.jtensors.core.unparameterized.vectors.Vector2D

All Implemented Interfaces:

Vector2DType, VectorReadable2DType, VectorComputationalType

public final class Vector2D
extends Object
implements Vector2DType

The type of 2D double-typed vectors.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Vector2D.Builder	builder()	Creates a builder for Vector2D.
boolean	equals(Object another)	This instance is equal to all instances of Vector2D that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: x, y.
static Vector2D	of(double x, double y)	Construct a new immutable Vector2D instance.
String	toString()	Prints the immutable value Vector2D with attribute values.
double	x()
double	y()

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 Vector2DType

Specified by:

x in interface VectorReadable2DType

Returns:

The value of the x attribute

y

public double y()

Specified by:

y in interface Vector2DType

Specified by:

y in interface VectorReadable2DType

Returns:

The value of the y attribute

equals

public boolean equals(Object another)

This instance is equal to all instances of Vector2D 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.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Vector2D with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static Vector2D of(double x,
                          double y)

Construct a new immutable Vector2D instance.

Parameters:

x - The value for the x attribute

y - The value for the y attribute

Returns:

An immutable Vector2D instance

builder

public static Vector2D.Builder builder()

Creates a builder for Vector2D.

Returns:

A new Vector2D builder