Class Vector3D.Sum
- java.lang.Object
-
- org.apache.commons.geometry.euclidean.EuclideanVectorSum<Vector3D>
-
- org.apache.commons.geometry.euclidean.threed.Vector3D.Sum
-
- All Implemented Interfaces:
java.util.function.Consumer<Vector3D>
,java.util.function.Supplier<Vector3D>
- Enclosing class:
- Vector3D
public static final class Vector3D.Sum extends EuclideanVectorSum<Vector3D>
Class used to create high-accuracy sums of vectors. Each vector component is summed using an instance ofSum
.This class is mutable and not thread-safe.
- See Also:
Sum
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Vector3D.Sum
add(Vector3D vec)
Add a vector to this instance.Vector3D.Sum
addScaled(double scale, Vector3D vec)
Add a scaled vector to this instance.static Vector3D.Sum
create()
Create a new instance with an initial value set to thezero vector
.Vector3D
get()
static Vector3D.Sum
of(Vector3D initial)
Construct a new instance with an initial value set to the argument.static Vector3D.Sum
of(Vector3D first, Vector3D... more)
Construct a new instance from multiple values.-
Methods inherited from class org.apache.commons.geometry.euclidean.EuclideanVectorSum
accept
-
-
-
-
Constructor Detail
-
Sum
Sum(Vector3D initial)
Construct a new instance with the given initial value.- Parameters:
initial
- initial value
-
-
Method Detail
-
add
public Vector3D.Sum add(Vector3D vec)
Add a vector to this instance.- Specified by:
add
in classEuclideanVectorSum<Vector3D>
- Parameters:
vec
- vector to add- Returns:
- this instance
-
addScaled
public Vector3D.Sum addScaled(double scale, Vector3D vec)
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<Vector3D>
- Parameters:
scale
- scale factorvec
- vector to scale and add- Returns:
- this instance
-
get
public Vector3D get()
-
create
public static Vector3D.Sum create()
Create a new instance with an initial value set to thezero vector
.- Returns:
- new instance set to zero
-
of
public static Vector3D.Sum of(Vector3D initial)
Construct a new instance with an initial value set to the argument.- Parameters:
initial
- initial sum value- Returns:
- new instance
-
of
public static Vector3D.Sum of(Vector3D first, Vector3D... more)
Construct a new instance from multiple values.- Parameters:
first
- first vectormore
- additional vectors- Returns:
- new instance
-
-