Class Orthonormalized3D
java.lang.Object
com.io7m.jtensors.orthonormalization.Orthonormalized3D
- All Implemented Interfaces:
Orthonormalized3DType
public final class Orthonormalized3D extends java.lang.Object implements Orthonormalized3DType
A set of vectors that are orthogonal to each other and are normalized.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Orthonormalized3D.Builder
Builds instances of typeOrthonormalized3D
. -
Method Summary
Modifier and Type Method Description static Orthonormalized3D.Builder
builder()
Creates a builder forOrthonormalized3D
.static Orthonormalized3D
copyOf(Orthonormalized3DType instance)
Creates an immutable copy of aOrthonormalized3DType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofOrthonormalized3D
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:v0
,v1
,v2
.static Orthonormalized3D
of(Vector3D v0, Vector3D v1, Vector3D v2)
Construct a new immutableOrthonormalized3D
instance.java.lang.String
toString()
Prints the immutable valueOrthonormalized3D
with attribute values.Vector3D
v0()
Vector3D
v1()
Vector3D
v2()
Orthonormalized3D
withV0(Vector3D value)
Copy the current immutable object by setting a value for thev0
attribute.Orthonormalized3D
withV1(Vector3D value)
Copy the current immutable object by setting a value for thev1
attribute.Orthonormalized3D
withV2(Vector3D value)
Copy the current immutable object by setting a value for thev2
attribute.
-
Method Details
-
v0
- Specified by:
v0
in interfaceOrthonormalized3DType
- Returns:
- Vector 0
-
v1
- Specified by:
v1
in interfaceOrthonormalized3DType
- Returns:
- Vector 1
-
v2
- Specified by:
v2
in interfaceOrthonormalized3DType
- Returns:
- Vector 2
-
withV0
Copy the current immutable object by setting a value for thev0
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for v0- Returns:
- A modified copy of the
this
object
-
withV1
Copy the current immutable object by setting a value for thev1
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for v1- Returns:
- A modified copy of the
this
object
-
withV2
Copy the current immutable object by setting a value for thev2
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for v2- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)This instance is equal to all instances ofOrthonormalized3D
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:v0
,v1
,v2
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()Prints the immutable valueOrthonormalized3D
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
Construct a new immutableOrthonormalized3D
instance.- Parameters:
v0
- The value for thev0
attributev1
- The value for thev1
attributev2
- The value for thev2
attribute- Returns:
- An immutable Orthonormalized3D instance
-
copyOf
Creates an immutable copy of aOrthonormalized3DType
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 Orthonormalized3D instance
-
builder
Creates a builder forOrthonormalized3D
.Orthonormalized3D.builder() .setV0(com.io7m.jtensors.core.unparameterized.vectors.Vector3D) // required
v0
.setV1(com.io7m.jtensors.core.unparameterized.vectors.Vector3D) // requiredv1
.setV2(com.io7m.jtensors.core.unparameterized.vectors.Vector3D) // requiredv2
.build();- Returns:
- A new Orthonormalized3D builder
-