Module org.arakhne.afc.core.mathgeom

Package org.arakhne.afc.math.geometry.d1

Interface UnmodifiableVector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Type Parameters:

RP - is the type of point that can be returned by this point.

RV - is the type of vector that can be returned by this point.

RS - is the type of segment that can be returned by this point.

All Superinterfaces:

Cloneable, Comparable<Vector1D<?,?,?>>, JsonableObject, Serializable, Tuple2D<RV>, UnmodifiableTuple2D<RV>, Vector1D<RV,RP,RS>

All Known Implementing Classes:

ImmutableVector1D

public interface UnmodifiableVector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>
extends UnmodifiableTuple2D<RV>, Vector1D<RV,RP,RS>

Unmodifiable Vector.

Since:

14.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Method Summary

Modifier and Type	Method	Description
default void	add(Vector1D<?,?,?> vector)	Sets the value of this tuple to the sum of itself and the given vector.
default void	add(Vector1D<?,?,?> vector1, Vector1D<?,?,?> vector2)	Sets the value of this tuple to the sum of tuples vector1 and vector2.
default void	normalize()	Normalizes this vector in place.
default void	normalize(Vector1D<?,?,?> vector)	Sets the value of this vector to the normalization of vector vector.
default void	scaleAdd(double scale, Vector1D<?,?,?> vector)	Sets the value of this tuple to the scalar multiplication of itself and then adds tuple vector (this = s*this + vector).
default void	scaleAdd(double scale, Vector1D<?,?,?> vector1, Vector1D<?,?,?> vector2)	Sets the value of this tuple to the scalar multiplication of the tuple vector1 plus the tuple vector2 (this = s*vector1 + vector2).
default void	scaleAdd(int scale, Vector1D<?,?,?> vector)	Sets the value of this tuple to the scalar multiplication of itself and then adds tuple vector (this = s*this + vector).
default void	scaleAdd(int scale, Vector1D<?,?,?> t1, Vector1D<?,?,?> t2)	Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
default void	setLength(double newLength)	Change the length of the vector.
default void	sub(Point1D<?,?,?> point1, Point1D<?,?,?> point2)	Sets the value of this tuple to the difference of tuples point1 and point2 (this = point1 - point2).
default void	sub(Vector1D<?,?,?> vector)	Sets the value of this tuple to the difference of itself and vector (this = this - vector).
default void	sub(Vector1D<?,?,?> vector1, Vector1D<?,?,?> vector2)	Sets the value of this tuple to the difference of tuples vector1 and vector2 (this = vector1 - vector2).
default UnmodifiableVector1D<RV,RP,RS>	toUnmodifiable()	Replies an unmodifiable copy of this vector.

Methods inherited from interface org.arakhne.afc.vmutil.json.JsonableObject

toJson

Methods inherited from interface org.arakhne.afc.math.geometry.d2.Tuple2D

clone, epsilonEquals, equals, get, get, get, getX, getY, hashCode, ix, iy

Methods inherited from interface org.arakhne.afc.math.geometry.d2.UnmodifiableTuple2D

absolute, absolute, add, add, addX, addX, addY, addY, clamp, clamp, clamp, clamp, clampMax, clampMax, clampMax, clampMax, clampMin, clampMin, clampMin, clampMin, interpolate, interpolate, negate, negate, scale, scale, scale, scale, set, set, set, set, set, setX, setX, setY, setY, sub, sub, subX, subX, subY, subY

Methods inherited from interface org.arakhne.afc.math.geometry.d1.Vector1D

$div, $minus, $minus, $minus, $minus, $plus, $plus, $plus, $times, compareTo, equals, equals, getGeomFactory, getLength, getLengthSquared, getSegment, isUnitVector, operator_add, operator_divide, operator_elvis, operator_equals, operator_minus, operator_minus, operator_minus, operator_minus, operator_multiply, operator_notEquals, operator_plus, operator_plus, operator_plus, operator_remove, toUnitVector

Method Detail

add

default void add(Vector1D<?,?,?> vector1,
                 Vector1D<?,?,?> vector2)

Description copied from interface: Vector1D

Sets the value of this tuple to the sum of tuples vector1 and vector2.

Specified by:

add in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

vector1 - the first tuple

vector2 - the second tuple

add

default void add(Vector1D<?,?,?> vector)

Description copied from interface: Vector1D

Sets the value of this tuple to the sum of itself and the given vector.

Specified by:

add in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

vector - the other tuple

scaleAdd

default void scaleAdd(int scale,
                      Vector1D<?,?,?> t1,
                      Vector1D<?,?,?> t2)

Description copied from interface: Vector1D

Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).

Specified by:

scaleAdd in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

scale - the scalar value

t1 - the tuple to be multipled

t2 - the tuple to be added

scaleAdd

default void scaleAdd(double scale,
                      Vector1D<?,?,?> vector1,
                      Vector1D<?,?,?> vector2)

Description copied from interface: Vector1D

Sets the value of this tuple to the scalar multiplication of the tuple vector1 plus the tuple vector2 (this = s*vector1 + vector2).

Specified by:

scaleAdd in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

scale - the scalar value

vector1 - the tuple to be multipled

vector2 - the tuple to be added

scaleAdd

default void scaleAdd(int scale,
                      Vector1D<?,?,?> vector)

Description copied from interface: Vector1D

Sets the value of this tuple to the scalar multiplication of itself and then adds tuple vector (this = s*this + vector).

Specified by:

scaleAdd in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

scale - the scalar value

vector - the tuple to be added

scaleAdd

default void scaleAdd(double scale,
                      Vector1D<?,?,?> vector)

Description copied from interface: Vector1D

Sets the value of this tuple to the scalar multiplication of itself and then adds tuple vector (this = s*this + vector).

Specified by:

scaleAdd in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

scale - the scalar value

vector - the tuple to be added

sub

default void sub(Vector1D<?,?,?> vector1,
                 Vector1D<?,?,?> vector2)

Description copied from interface: Vector1D

Sets the value of this tuple to the difference of tuples vector1 and vector2 (this = vector1 - vector2).

Specified by:

sub in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

vector1 - the first tuple

vector2 - the second tuple

sub

default void sub(Point1D<?,?,?> point1,
                 Point1D<?,?,?> point2)

Description copied from interface: Vector1D

Sets the value of this tuple to the difference of tuples point1 and point2 (this = point1 - point2).

Specified by:

sub in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

point1 - the first tuple

point2 - the second tuple

sub

default void sub(Vector1D<?,?,?> vector)

Description copied from interface: Vector1D

Sets the value of this tuple to the difference of itself and vector (this = this - vector).

Specified by:

sub in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

vector - the other tuple

normalize

default void normalize()

Description copied from interface: Vector1D

Normalizes this vector in place.

If the length of the vector is zero, x and y are set to zero.

Specified by:

normalize in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

normalize

default void normalize(Vector1D<?,?,?> vector)

Description copied from interface: Vector1D

Sets the value of this vector to the normalization of vector vector.

Specified by:

normalize in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

vector - the un-normalized vector

setLength

default void setLength(double newLength)

Description copied from interface: Vector1D

Change the length of the vector. The direction of the vector is unchanged.

Specified by:

setLength in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Parameters:

newLength - - the new length.

toUnmodifiable

default UnmodifiableVector1D<RV,RP,RS> toUnmodifiable()

Description copied from interface: Vector1D

Replies an unmodifiable copy of this vector.

Specified by:

toUnmodifiable in interface Vector1D<RV extends Vector1D<? super RV,? super RP,? super RS>,RP extends Point1D<? super RP,? super RV,? super RS>,RS extends Segment1D<?,?>>

Returns:

an unmodifiable copy.