Package civitas.celestis.math.decimal

Class Decimal2

java.lang.Object

civitas.celestis.util.tuple.Object2<BigDecimal>

civitas.celestis.math.decimal.Decimal2

All Implemented Interfaces:

DecimalVector<Decimal2,Vector2>, BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>, BaseTuple<BigDecimal>, Tuple<BigDecimal>, Serializable, Iterable<BigDecimal>

public class Decimal2
extends Object2<BigDecimal>
implements DecimalVector<Decimal2,Vector2>

An immutable two-dimensional decimal vector.

See Also:

• DecimalVector
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Decimal2	NEGATIVE_A	The negative A unit vector.
static final Decimal2	NEGATIVE_B	The negative B unit vector.
static final Decimal2	POSITIVE_A	The positive A unit vector.
static final Decimal2	POSITIVE_B	The positive B unit vector.
static final Decimal2	ZERO	A vector of no direction or magnitude.

Fields inherited from class civitas.celestis.util.tuple.Object2

a, b

Constructor Summary

Constructors

Constructor	Description
Decimal2(Vector2 v)	Creates a new vector.
Decimal2(Tuple<? extends BigDecimal> t)	Creates a new vector.
Decimal2(BigDecimal[] components)	Creates a new vector.
Decimal2(BigDecimal a, BigDecimal b)	Creates a new vector.

Method Summary

Modifier and Type	Method	Description
Decimal2	add(Decimal2 v)	Adds another vector to this vector, then returns the resulting vector.
Decimal2	add(BigDecimal s)	Adds a scalar to this vector component-wise, then returns the resulting vector.
Integer2	bigIntegerValue()	Converts this vector into a big integer vector.
Decimal2	clamp(Decimal2 min, Decimal2 max)	Between this vector and the provided boundary vectors min and max, this returns a new vector whose components are clamped to respect the range of [min, max].
BigDecimal	distance(Decimal2 v)	Returns the Euclidean distance between this vector and the provided vector v.
BigDecimal	distance2(Decimal2 v)	Returns the squared Euclidean distance between this vector and the provided vector v.
BigDecimal	distanceManhattan(Decimal2 v)	Returns the Manhattan distance between this vector and the provided vector v.
Decimal2	divide(BigDecimal s)	Divides this vector by a scalar component-wise, then returns the resulting vector.
BigDecimal	dot(Decimal2 v)	Returns the dot product between this vector and the provided vector v.
boolean	equals(Decimal2 v)	Checks for equality between this vector and the provided vector v.
Decimal2	max(Decimal2 v)	Between this vector and the provided boundary vector v, this takes the maximum of each corresponding pair of components, then returns a new vector whose components are populated from that of the maximum values between each pair of components.
Decimal2	merge(Decimal2 v, BinaryOperator<BigDecimal> f)	Between this vector and the provided vector v, this applies the merger function f to each corresponding pair of components, then returns a new vector whose components are populated from the return values of the function f.
Decimal2	min(Decimal2 v)	Between this vector and the provided boundary vector v, this takes the minimum of each corresponding pair of components, then returns a new vector whose components are populated from that of the minimum values between each pair of components.
Decimal2	multiply(BigDecimal s)	Multiplies this vector by a scalar component-wise, then returns the resulting vector.
Decimal2	negate()	Negates all components of this vector, then returns the resulting vector.
BigDecimal	norm()	Returns the Euclidean norm (the magnitude) of this vector.
BigDecimal	norm2()	Returns the squared Euclidean norm (the squared magnitude) of this vector.
Decimal2	normalize()	Normalizes this vector to have a Euclidean norm (magnitude) of 1.
Decimal2	normalizeOrDefault(Decimal2 v)	Normalizes this vector to have a Euclidean norm (magnitude) of 1.
Decimal2	normalizeOrZero()	Normalizes this vector ot have a Euclidean norm (magnitude) of 1.
BigDecimal	normManhattan()	Returns the Manhattan norm of this vector.
Vector2	primValue()	Converts this vector into a primitive vector.
protected final void	requireNonNull()	Requires that all components of this vector are non-null.
Decimal2	rotate(BigDecimal t)	Rotates this vector counter-clockwise by the provided angle t.
Decimal2	subtract(Decimal2 v)	Subtracts another vector from this vector, then returns the resulting vector.
Decimal2	subtract(BigDecimal s)	Subtracts this vector by a scalar component-wise, then returns the resulting vector.
Decimal2	transform(UnaryOperator<BigDecimal> f)	Applies the provided transformation function f to each component of this vector, then returns a new vector containing the return values of the function f.

Methods inherited from class civitas.celestis.util.tuple.Object2

a, array, b, contains, containsAll, equals, forEach, forEach, get, hashCode, iterator, list, map, mapToDouble, mapToFloat, mapToInt, mapToLong, merge, size, stream, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

spliterator

Methods inherited from interface civitas.celestis.util.tuple.Tuple

array, contains, containsAll, equals, filter, forEach, forEach, get, iterator, list, map, mapToDouble, mapToFloat, mapToInt, mapToLong, merge, safeArray, size, stream, toString

Field Details

ZERO

public static final Decimal2 ZERO

A vector of no direction or magnitude. Represents origin.

POSITIVE_A

public static final Decimal2 POSITIVE_A

The positive A unit vector.

POSITIVE_B

public static final Decimal2 POSITIVE_B

The positive B unit vector.

NEGATIVE_A

public static final Decimal2 NEGATIVE_A

The negative A unit vector.

NEGATIVE_B

public static final Decimal2 NEGATIVE_B

The negative B unit vector.

Constructor Details

Decimal2

public Decimal2(@Nonnull
 BigDecimal a,
 @Nonnull
 BigDecimal b)

Creates a new vector.

Parameters:

a - The A component of this vector

b - The B component of this vector

Decimal2

public Decimal2(@Nonnull
 BigDecimal[] components)

Creates a new vector.

Parameters:

components - An array containing the components of this vector in AB order

Throws:

IllegalArgumentException - When the provided array's length is not 3

Decimal2

public Decimal2(@Nonnull
 Tuple<? extends BigDecimal> t)

Creates a new vector.

Parameters:

t - The tuple of which to copy component values from

Throws:

IllegalArgumentException - When the provided tuple t's size is not 3

Decimal2

public Decimal2(@Nonnull
 Vector2 v)

Creates a new vector.

Parameters:

v - The vector of which to copy component values from

Method Details

requireNonNull

protected final void requireNonNull()

Requires that all components of this vector are non-null.

norm

@Nonnull
public BigDecimal norm()

Returns the Euclidean norm (the magnitude) of this vector.

Specified by:

norm in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Returns:

The Euclidean norm of this vector

norm2

@Nonnull
public BigDecimal norm2()

Returns the squared Euclidean norm (the squared magnitude) of this vector.

Specified by:

norm2 in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Returns:

The squared Euclidean norm of this vector

normManhattan

@Nonnull
public BigDecimal normManhattan()

Returns the Manhattan norm of this vector.

Specified by:

normManhattan in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Returns:

The Manhattan norm of this vector

add

@Nonnull
public Decimal2 add(@Nonnull
 BigDecimal s)

Adds a scalar to this vector component-wise, then returns the resulting vector.

Specified by:

add in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

s - The scalar of which to add to each component of this vector

Returns:

The resulting vector

subtract

@Nonnull
public Decimal2 subtract(@Nonnull
 BigDecimal s)

Subtracts this vector by a scalar component-wise, then returns the resulting vector.

Specified by:

subtract in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

s - The scalar of which to subtract from each component of this vector

Returns:

The resulting vector

multiply

@Nonnull
public Decimal2 multiply(@Nonnull
 BigDecimal s)

Multiplies this vector by a scalar component-wise, then returns the resulting vector.

Specified by:

multiply in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

s - The scalar of which to multiply each component of this vector by

Returns:

The resulting vector

divide

@Nonnull
public Decimal2 divide(@Nonnull
 BigDecimal s)
                throws ArithmeticException

Divides this vector by a scalar component-wise, then returns the resulting vector.

Specified by:

divide in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

s - The scalar of which to divide each component of this vector by

Returns:

The resulting vector

Throws:

ArithmeticException - When the denominator s is zero

add

@Nonnull
public Decimal2 add(@Nonnull
 Decimal2 v)

Adds another vector to this vector, then returns the resulting vector.

Specified by:

add in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The vector of which to add to this vector

Returns:

The resulting vector

subtract

@Nonnull
public Decimal2 subtract(@Nonnull
 Decimal2 v)

Subtracts another vector from this vector, then returns the resulting vector.

Specified by:

subtract in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The vector of which to subtract from this vector

Returns:

The resulting vector

dot

@Nonnull
public BigDecimal dot(@Nonnull
 Decimal2 v)

Returns the dot product between this vector and the provided vector v.

Specified by:

dot in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The vector of which to get the dot product between

Returns:

The dot product between the two vectors

normalize

@Nonnull
public Decimal2 normalize()
                   throws ArithmeticException

Normalizes this vector to have a Euclidean norm (magnitude) of 1.

Specified by:

normalize in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Returns:

The normalized vector of this vector

Throws:

ArithmeticException - When the Euclidean norm of this vector is zero

normalizeOrZero

@Nonnull
public Decimal2 normalizeOrZero()

Normalizes this vector ot have a Euclidean norm (magnitude) of 1. If this vector's Euclidean norm is zero, this will return itself. (which is guaranteed to be a vector where all components are zero, as only zero vectors have a Euclidean norm of zero)

Specified by:

normalizeOrZero in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Returns:

The normalized vector of this vector if successful, zero otherwise

normalizeOrDefault

@Nonnull
public Decimal2 normalizeOrDefault(@Nonnull
 Decimal2 v)

Normalizes this vector to have a Euclidean norm (magnitude) of 1. If this vector's Euclidean norm is zero, this will return the provided fallback value v.

Specified by:

normalizeOrDefault in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The value of which to return in case of division by zero

Returns:

The normalized vector of this vector if successful, the fallback value v otherwise

negate

@Nonnull
public Decimal2 negate()

Negates all components of this vector, then returns the resulting vector.

Specified by:

negate in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Returns:

The negation of this vector

min

@Nonnull
public Decimal2 min(@Nonnull
 Decimal2 v)

Between this vector and the provided boundary vector v, this takes the minimum of each corresponding pair of components, then returns a new vector whose components are populated from that of the minimum values between each pair of components.

Specified by:

min in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The boundary vector of which to compare to

Returns:

The minimum vector of the two vectors

max

@Nonnull
public Decimal2 max(@Nonnull
 Decimal2 v)

Between this vector and the provided boundary vector v, this takes the maximum of each corresponding pair of components, then returns a new vector whose components are populated from that of the maximum values between each pair of components.

Specified by:

max in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The boundary vector of which to compare to

Returns:

The maximum vector of the two vectors

clamp

@Nonnull
public Decimal2 clamp(@Nonnull
 Decimal2 min,
 @Nonnull
 Decimal2 max)

Between this vector and the provided boundary vectors min and max, this returns a new vector whose components are clamped to respect the range of [min, max]. This is the equivalent of clamping each component to the corresponding pair of minimum and maximum values.

Specified by:

clamp in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

min - The minimum boundary vector to compare to

max - The maximum boundary vector to compare to

Returns:

The clamped vector which respects the boundaries of [min, max]

distance

@Nonnull
public BigDecimal distance(@Nonnull
 Decimal2 v)

Returns the Euclidean distance between this vector and the provided vector v.

Specified by:

distance in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The vector of which get the Euclidean distance between

Returns:

The Euclidean distance between the two vectors

distance2

@Nonnull
public BigDecimal distance2(@Nonnull
 Decimal2 v)

Returns the squared Euclidean distance between this vector and the provided vector v.

Specified by:

distance2 in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The vector of which to get the squared Euclidean distance between

Returns:

The squared Euclidean distance between the two vectors

distanceManhattan

@Nonnull
public BigDecimal distanceManhattan(@Nonnull
 Decimal2 v)

Returns the Manhattan distance between this vector and the provided vector v.

Specified by:

distanceManhattan in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The vector of which to get the Manhattan distance between

Returns:

The Manhattan distance between the two vectors

transform

@Nonnull
public Decimal2 transform(@Nonnull
 UnaryOperator<BigDecimal> f)

Applies the provided transformation function f to each component of this vector, then returns a new vector containing the return values of the function f.

Specified by:

transform in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

f - The function of which to apply to each component of this vector

Returns:

The resulting vector

merge

@Nonnull
public Decimal2 merge(@Nonnull
 Decimal2 v,
 @Nonnull
 BinaryOperator<BigDecimal> f)

Between this vector and the provided vector v, this applies the merger function f to each corresponding pair of components, then returns a new vector whose components are populated from the return values of the function f.

Specified by:

merge in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The vector of which to merge this vector with

f - The merger function to handle the merging of the two vectors

Returns:

The resulting vector

rotate

@Nonnull
public Decimal2 rotate(@Nonnull
 BigDecimal t)

Rotates this vector counter-clockwise by the provided angle t. Angle is denoted in radians.

Parameters:

t - The angle of rotation to apply in radians

Returns:

The rotated vector

See Also:

• Math.toRadians(double)

primValue

@Nonnull
public Vector2 primValue()

Converts this vector into a primitive vector. Precision and/or scale may be lost.

Specified by:

primValue in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Returns:

The primitive representation of this vector

bigIntegerValue

@Nonnull
public Integer2 bigIntegerValue()

Converts this vector into a big integer vector.

Specified by:

bigIntegerValue in interface DecimalVector<Decimal2,Vector2>

Returns:

The big integer representation of this vector

equals

public boolean equals(@Nullable
 Decimal2 v)

Checks for equality between this vector and the provided vector v.

Specified by:

equals in interface BigVector<BigDecimal,BigDecimal,Decimal2,Decimal2,Vector2>

Parameters:

v - The vector to compare to

Returns:

true if the component values are equal