Class Vector2D.Sum
java.lang.Object
org.apache.commons.geometry.euclidean.EuclideanVectorSum<Vector2D>
org.apache.commons.geometry.euclidean.twod.Vector2D.Sum
- Enclosing class:
Vector2D
Class used to create high-accuracy sums of vectors. Each vector component is
summed using an instance of
Sum
.
This class is mutable and not thread-safe.
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd a vector to this instance.Add a scaled vector to this instance.static Vector2D.Sum
create()
Create a new instance with an initial value set to thezero vector
.get()
static Vector2D.Sum
Construct a new instance with an initial value set to the argument.static Vector2D.Sum
Construct a new instance from multiple values.Methods inherited from class org.apache.commons.geometry.euclidean.EuclideanVectorSum
accept
-
Field Details
-
xsum
private final org.apache.commons.numbers.core.Sum xsumX component sum. -
ysum
private final org.apache.commons.numbers.core.Sum ysumY component sum.
-
-
Constructor Details
-
Sum
Sum(Vector2D initial) Construct a new instance with the given initial value.- Parameters:
initial
- initial value
-
-
Method Details
-
add
Add a vector to this instance.- Specified by:
add
in classEuclideanVectorSum<Vector2D>
- Parameters:
vec
- vector to add- Returns:
- this instance
-
addScaled
Add a scaled vector to this instance. In general, the result produced by this method will be more accurate than if the vector was scaled first and then added directly. In other words,sum.addScale(scale, vec)
will generally produce a better result thansum.add(vec.multiply(scale))
.- Specified by:
addScaled
in classEuclideanVectorSum<Vector2D>
- Parameters:
scale
- scale factorvec
- vector to scale and add- Returns:
- this instance
-
get
-
create
Create a new instance with an initial value set to thezero vector
.- Returns:
- new instance set to zero
-
of
Construct a new instance with an initial value set to the argument.- Parameters:
initial
- initial sum value- Returns:
- new instance
-
of
Construct a new instance from multiple values.- Parameters:
first
- first vectormore
- additional vectors- Returns:
- new instance
-