Class Vector2F
java.lang.Object
com.io7m.jtensors.core.unparameterized.vectors.Vector2F
- All Implemented Interfaces:
Vector2FType
,VectorReadable2FType
,VectorComputationalType
public final class Vector2F extends java.lang.Object implements Vector2FType
The type of 2D
float
-typed vectors.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Vector2F.Builder
Builds instances of typeVector2F
. -
Method Summary
Modifier and Type Method Description static Vector2F.Builder
builder()
Creates a builder forVector2F
.static Vector2F
copyOf(Vector2FType instance)
Creates an immutable copy of aVector2FType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVector2F
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:x
,y
.static Vector2F
of(float x, float y)
Construct a new immutableVector2F
instance.java.lang.String
toString()
Prints the immutable valueVector2F
with attribute values.Vector2F
withX(float value)
Copy the current immutable object by setting a value for thex
attribute.Vector2F
withY(float value)
Copy the current immutable object by setting a value for they
attribute.float
x()
float
y()
-
Method Details
-
x
public float x()- Specified by:
x
in interfaceVector2FType
- Specified by:
x
in interfaceVectorReadable2FType
- Returns:
- The value of the
x
attribute
-
y
public float y()- Specified by:
y
in interfaceVector2FType
- Specified by:
y
in interfaceVectorReadable2FType
- Returns:
- The value of the
y
attribute
-
withX
Copy the current immutable object by setting a value for thex
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for x- Returns:
- A modified copy of the
this
object
-
withY
Copy the current immutable object by setting a value for they
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for y- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)This instance is equal to all instances ofVector2F
that have equal attribute values.- Overrides:
equals
in classjava.lang.Object
- Returns:
true
ifthis
is equal toanother
instance
-
hashCode
public int hashCode()Computes a hash code from attributes:x
,y
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()Prints the immutable valueVector2F
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
Construct a new immutableVector2F
instance.- Parameters:
x
- The value for thex
attributey
- The value for they
attribute- Returns:
- An immutable Vector2F instance
-
copyOf
Creates an immutable copy of aVector2FType
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 Vector2F instance
-
builder
Creates a builder forVector2F
.Vector2F.builder() .setX(float) // required
x
.setY(float) // requiredy
.build();- Returns:
- A new Vector2F builder
-