Class Vector1D.Sum
- java.lang.Object
-
- org.apache.commons.geometry.euclidean.EuclideanVectorSum<Vector1D>
-
- org.apache.commons.geometry.euclidean.oned.Vector1D.Sum
-
- All Implemented Interfaces:
java.util.function.Consumer<Vector1D>
,java.util.function.Supplier<Vector1D>
- Enclosing class:
- Vector1D
public static final class Vector1D.Sum extends EuclideanVectorSum<Vector1D>
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
-
-
Field Summary
Fields Modifier and Type Field Description private org.apache.commons.numbers.core.Sum
xsum
X component sum.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Vector1D.Sum
add(Vector1D vec)
Add a vector to this instance.Vector1D.Sum
addScaled(double scale, Vector1D vec)
Add a scaled vector to this instance.static Vector1D.Sum
create()
Create a new instance with an initial value set to thezero vector
.Vector1D
get()
static Vector1D.Sum
of(Vector1D initial)
Construct a new instance with an initial value set to the argument.static Vector1D.Sum
of(Vector1D first, Vector1D... more)
Construct a new instance from multiple values.-
Methods inherited from class org.apache.commons.geometry.euclidean.EuclideanVectorSum
accept
-
-
-
-
Constructor Detail
-
Sum
Sum(Vector1D initial)
Construct a new instance with the given initial value.- Parameters:
initial
- initial value
-
-
Method Detail
-
add
public Vector1D.Sum add(Vector1D vec)
Add a vector to this instance.- Specified by:
add
in classEuclideanVectorSum<Vector1D>
- Parameters:
vec
- vector to add- Returns:
- this instance
-
addScaled
public Vector1D.Sum addScaled(double scale, Vector1D 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<Vector1D>
- Parameters:
scale
- scale factorvec
- vector to scale and add- Returns:
- this instance
-
get
public Vector1D get()
-
create
public static Vector1D.Sum create()
Create a new instance with an initial value set to thezero vector
.- Returns:
- new instance set to zero
-
of
public static Vector1D.Sum of(Vector1D initial)
Construct a new instance with an initial value set to the argument.- Parameters:
initial
- initial sum value- Returns:
- new instance
-
of
public static Vector1D.Sum of(Vector1D first, Vector1D... more)
Construct a new instance from multiple values.- Parameters:
first
- first vectormore
- additional vectors- Returns:
- new instance
-
-