Package geomss.geom

Class MutablePoint

java.lang.Object

geomss.geom.AbstractGeomElement<GeomPoint>

geomss.geom.GeomPoint

geomss.geom.MutablePoint

All Implemented Interfaces:

GeomElement<GeomPoint>, PointGeometry<GeomPoint>, Transformable<GeomPoint>, XYPoint, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javolution.lang.Reusable, javolution.xml.XMLSerializable

public final class MutablePoint
extends GeomPoint

A mutable container that holds changeable coordinates of a point in n-dimensional space.

Modified by: Joseph A. Huwaldt

Version:

February 17, 2025

Author:

Joseph A. Huwaldt, Date: December 11, 1999

See Also:

Serialized Form

Field Summary

Fields inherited from class geomss.geom.GeomPoint

W, X, Y, Z

Fields inherited from class geomss.geom.AbstractGeomElement

RESOURCES

Method Summary

Modifier and Type	Method	Description
MutablePoint	copy()	Returns a copy of this MutablePoint instance allocated by the calling thread (possibly on the stack).
Point	copyToReal()	Return a copy of this object with any transformations or subranges removed (applied).
boolean	equals(java.lang.Object obj)	Compares this Point against the specified object for strict equality (same values and same units).
int	getPhyDimension()	Returns the number of physical dimensions of the geometry element.
javax.measure.unit.Unit<javax.measure.quantity.Length>	getUnit()	Returns the unit in which the values in this point are stated in.
double	getValue(int i)	Returns the value of a coordinate in this point as a double, stated in this point's unit.
double	getValue(int i, javax.measure.unit.Unit<javax.measure.quantity.Length> unit)	Returns the value of a coordinate in this point as a double, stated in the specified unit.
int	hashCode()	Returns the hash code for this parameter.
Point	immutable()	Return an immutable version of this point.
Point	minus(GeomPoint that)	Returns the difference between this point and the one specified.
Point	minus(Parameter<javax.measure.quantity.Length> that)	Subtracts the specified parameter from each component of this point.
static MutablePoint	newInstance(int dim)	Returns a MutablePoint instance of the specified dimension with zero meters for each coordinate value.
static MutablePoint	newInstance(int dim, javax.measure.unit.Unit<javax.measure.quantity.Length> unit)	Returns a Point instance of the specified dimension and units with zero for each coordinate value.
double	normSqValue()	Returns the square of the Euclidean norm, magnitude, or length value of the vector from the origin to this point (the dot product of the origin-to-this-point vector and itself).
Point	opposite()	Returns the negation of this point (all the values of each dimension negated).
Point	plus(GeomPoint that)	Returns the sum of this point with the one specified.
Point	plus(Parameter<javax.measure.quantity.Length> that)	Adds the specified parameter to each component of this point.
static void	recycle(MutablePoint instance)	Recycles a MutablePoint instance immediately (on the stack when executing in a StackContext).
void	set(int i, Parameter<javax.measure.quantity.Length> value)	Set the value of a point dimension to the specified Parameter.
void	set(GeomPoint p)	Set the value of elements of this point to the elements of the specified point.
void	set(GeomVector<?> vector)	Set the value of elements of this point to the elements of the specified vector of Parameter objects.
void	setValue(int i, double value)	Set the value of a point dimension to the specified double in the current point units.
Point	times(double k)	Returns the product of this point with the specified coefficient.
MutablePoint	to(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)	Returns the equivalent to this point but stated in the specified unit.
MutablePoint	toDimension(int newDim)	Return the equivalent of this point converted to the specified number of physical dimensions.
Float64Vector	toFloat64Vector()	Returns the values stored in this point, stated in this point's unit, as a Float64Vector.
static MutablePoint	valueOf(double... x)	Returns a MutablePoint instance holding the specified double value or values stated in meters.
static MutablePoint	valueOf(double x, double y, double z, javax.measure.unit.Unit<javax.measure.quantity.Length> unit)	Returns a 3D MutablePoint instance holding the specified double values stated in the specified units.
static MutablePoint	valueOf(double x, double y, javax.measure.unit.Unit<javax.measure.quantity.Length> unit)	Returns a 2D MutablePoint instance holding the specified double value stated in the specified units.
static MutablePoint	valueOf(double x, javax.measure.unit.Unit<javax.measure.quantity.Length> unit)	Returns a 1D MutablePoint instance holding the specified double values stated in the specified units.
static MutablePoint	valueOf(GeomPoint point)	Returns a MutablePoint instance containing the specified GeomPoint's data.
static MutablePoint	valueOf(GeomVector<?> vector)	Returns a MutablePoint instance that represents the direction elements of the specified GeomVector given in length or dimensionless units.
static MutablePoint	valueOf(Coordinate3D<javax.measure.quantity.Length> coord)	Returns a MutablePoint instance holding the specified @link jahuwaldt.js.param.Coordinate3D Coordinate3D values.
static MutablePoint	valueOf(Parameter<javax.measure.quantity.Length>... values)	Returns a MutablePoint instance holding the specified Parameter values.
static MutablePoint	valueOf(java.util.List<Parameter<javax.measure.quantity.Length>> values)	Returns a MutablePoint instance holding the specified Parameter values.
static MutablePoint	valueOf(javax.measure.unit.Unit<javax.measure.quantity.Length> unit, double... values)	Returns a MutablePoint instance holding the specified double values stated in the specified units.
static <Q extends javax.measure.quantity.Quantity> MutablePoint	valueOf(Vector<Parameter<Q>> vector)	Returns a MutablePoint instance containing the specified vector of Parameter values with length units.
static MutablePoint	valueOf(Vector<Float64> vector, javax.measure.unit.Unit<javax.measure.quantity.Length> unit)	Returns a MutablePoint instance containing the specified vector of Float64 values stated in the specified units.

Methods inherited from class geomss.geom.GeomPoint

distance, distanceSq, distanceSqValue, distanceValue, divide, divide, get, getBoundsMax, getBoundsMin, getLimitPoint, getNumberOfPoints, getParDimension, getTransformed, getX, getY, getZ, isApproxEqual, isApproxEqual, isValid, max, min, norm, normSq, normValue, size, times, toArray, toArray, toGeomVector, toParameterVector, toText, toVector3D

Methods inherited from class geomss.geom.AbstractGeomElement

addChangeListener, clone, compareTo, getAllUserData, getID, getName, getUserData, putAllUserData, putUserData, removeChangeListener, removeUserData, reset, setName, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface geomss.geom.GeomElement

addChangeListener, getAllUserData, getID, getName, getUserData, putAllUserData, putUserData, removeChangeListener, removeUserData, setName

Method Detail

newInstance

public static MutablePoint newInstance(int dim)

Returns a MutablePoint instance of the specified dimension with zero meters for each coordinate value.

Parameters:

dim - the physical dimension of the point to create.

Returns:

the point having the specified dimension and zero meters for values.

newInstance

public static MutablePoint newInstance(int dim,
                                       javax.measure.unit.Unit<javax.measure.quantity.Length> unit)

Returns a Point instance of the specified dimension and units with zero for each coordinate value.

Parameters:

dim - the physical dimension of the point to create.

unit - The unit for the point to create. May not be null.

Returns:

the point having the specified dimension & units and zero for values.

valueOf

public static MutablePoint valueOf(double... x)

Returns a MutablePoint instance holding the specified double value or values stated in meters.

Parameters:

x - the coordinate values stated in meters. May not be null.

Returns:

the point having the specified value.

valueOf

public static MutablePoint valueOf(double x,
                                   javax.measure.unit.Unit<javax.measure.quantity.Length> unit)

Returns a 1D MutablePoint instance holding the specified double values stated in the specified units.

Parameters:

x - the x value stated in the specified unit.

unit - the unit in which the coordinates are stated. May not be null.

Returns:

the point having the specified value.

valueOf

public static MutablePoint valueOf(double x,
                                   double y,
                                   javax.measure.unit.Unit<javax.measure.quantity.Length> unit)

Returns a 2D MutablePoint instance holding the specified double value stated in the specified units.

Parameters:

x - the x value stated in the specified unit.

y - the y value stated in the specified unit.

unit - the unit in which the coordinates are stated. May not be null.

Returns:

the point having the specified values.

valueOf

public static MutablePoint valueOf(double x,
                                   double y,
                                   double z,
                                   javax.measure.unit.Unit<javax.measure.quantity.Length> unit)

Returns a 3D MutablePoint instance holding the specified double values stated in the specified units.

Parameters:

x - the x value stated in the specified unit.

y - the y value stated in the specified unit.

z - the z value stated in the specified unit.

unit - the unit in which the coordinates are stated. May not be null.

Returns:

the point having the specified values.

valueOf

public static MutablePoint valueOf(javax.measure.unit.Unit<javax.measure.quantity.Length> unit,
                                   double... values)

Returns a MutablePoint instance holding the specified double values stated in the specified units.

Parameters:

unit - the length unit in which the coordinates are stated. May not be null.

values - the list of values stated in the specified unit. May not be null.

Returns:

the point having the specified values.

valueOf

public static MutablePoint valueOf(Parameter<javax.measure.quantity.Length>... values)

Returns a MutablePoint instance holding the specified Parameter values. All the values are converted to the same units as the 1st value.

Parameters:

values - The list of values to be stored. May not be null.

Returns:

the point having the specified values in the units of the 1st value.

valueOf

public static MutablePoint valueOf(java.util.List<Parameter<javax.measure.quantity.Length>> values)

Returns a MutablePoint instance holding the specified Parameter values. All the values are converted to the same units as the 1st value.

Parameters:

values - The list of values to be stored. May not be null.

Returns:

the point having the specified values in the units of the 1st value.

valueOf

public static MutablePoint valueOf(Coordinate3D<javax.measure.quantity.Length> coord)

Returns a MutablePoint instance holding the specified @link jahuwaldt.js.param.Coordinate3D Coordinate3D values.

Parameters:

coord - The Coordinate3D to be stored. May not be null.

Returns:

the point having the specified values.

valueOf

public static MutablePoint valueOf(Vector<Float64> vector,
                                   javax.measure.unit.Unit<javax.measure.quantity.Length> unit)

Returns a MutablePoint instance containing the specified vector of Float64 values stated in the specified units.

Parameters:

vector - the vector of Float64 values stated in the specified unit. May not be null.

unit - the unit in which the values are stated. May not be null.

Returns:

the point having the specified values.

valueOf

public static <Q extends javax.measure.quantity.Quantity> MutablePoint valueOf(Vector<Parameter<Q>> vector)

Returns a MutablePoint instance containing the specified vector of Parameter values with length units. All the values are converted to the same units as the 1st value.

Type Parameters:

Q - The Quantity (unit type) of this point.

Parameters:

vector - the vector of Parameter values stated in length or dimensionless units. If in dimensionless units, the values are interpreted as being in meters. May not be null.

Returns:

the point having the specified values.

Throws:

javax.measure.converter.ConversionException - if the input vector is not in length (or Dimensionless) units.

valueOf

public static MutablePoint valueOf(GeomVector<?> vector)

Returns a MutablePoint instance that represents the direction elements of the specified GeomVector given in length or dimensionless units. If the user wishes for the point to represent the end or tip of the vehicle they should use the following: MutablePoint p = MutablePoint.valueOf(vector).plus(vector.getOrigin());

Parameters:

vector - the GeomVector stated in length or dimensionless units. If in dimensionless units, the values are interpreted as being in meters. May not be null.

Returns:

the point having the specified values of the vector end point or tip.

Throws:

javax.measure.converter.ConversionException - if the input vector is not in length (or Dimensionless) units.

valueOf

public static MutablePoint valueOf(GeomPoint point)

Returns a MutablePoint instance containing the specified GeomPoint's data.

Parameters:

point - the GeomPoint to be copied into a new Point. May not be null.

Returns:

the point having the specified values.

recycle

public static void recycle(MutablePoint instance)

Recycles a MutablePoint instance immediately (on the stack when executing in a StackContext).

Parameters:

instance - The instance to be recycled.

getPhyDimension

public int getPhyDimension()

Returns the number of physical dimensions of the geometry element.

Returns:

The number of physical dimensions of the geometry element.

set

public void set(GeomPoint p)

Set the value of elements of this point to the elements of the specified point. If the input GeomPoint is of type "Point", then the data stored in this MutablePoint is set to the data stored in "p" without creating any new object instances (copy by value).

Parameters:

p - The new point to make this point equal to. May not be null.

Throws:

DimensionException - (p.getPhyDimension() != getPhyDimension())

set

public void set(GeomVector<?> vector)

Set the value of elements of this point to the elements of the specified vector of Parameter objects. The origin of the vector is ignored.

Parameters:

vector - The new vector to make this point equal to in length or dimensionless units. If in dimensionless units, the values are interpreted as being in the same units as this point. May not be null.

Throws:

DimensionException - (vector.getDimension() != getPhyDimension())

javax.measure.converter.ConversionException - if the input vector is not in length (or Dimensionless) units.

set

public void set(int i,
                Parameter<javax.measure.quantity.Length> value)

Set the value of a point dimension to the specified Parameter.

Parameters:

i - the dimension index.

value - The new value of the parameter to set at i. May not be null.

Throws:

java.lang.IndexOutOfBoundsException - (i < 0) || (i ≥ getPhyDimension())

setValue

public void setValue(int i,
                     double value)

Set the value of a point dimension to the specified double in the current point units.

Parameters:

i - the dimension index.

value - The new value of the parameter to set at i in the current units of this point.

Throws:

java.lang.IndexOutOfBoundsException - (i < 0) || (i ≥ getPhyDimension())

getValue

public double getValue(int i)

Returns the value of a coordinate in this point as a double, stated in this point's unit.

Specified by:

getValue in class GeomPoint

Parameters:

i - the dimension index.

Returns:

the value of the Parameter at i.

Throws:

java.lang.IndexOutOfBoundsException - (i < 0) || (i ≥ getPhyDimension())

getValue

public double getValue(int i,
                       javax.measure.unit.Unit<javax.measure.quantity.Length> unit)

Returns the value of a coordinate in this point as a double, stated in the specified unit.

Specified by:

getValue in class GeomPoint

Parameters:

i - the dimension index.

unit - the unit to return the value in. May not be null.

Returns:

the value of the Parameter at i in the specified unit.

Throws:

java.lang.IndexOutOfBoundsException - (i < 0) || (i ≥ getPhyDimension())

normSqValue

public double normSqValue()

Returns the square of the Euclidean norm, magnitude, or length value of the vector from the origin to this point (the dot product of the origin-to-this-point vector and itself). This is slightly faster than calling normValue if the squared value is all that is needed.

Specified by:

normSqValue in class GeomPoint

Returns:

this.normSq().getValue().

See Also:

GeomPoint.normValue()

plus

public Point plus(GeomPoint that)

Returns the sum of this point with the one specified. The unit of the output point will be the units of this point.

Specified by:

plus in class GeomPoint

Parameters:

that - the point to be added. May not be null.

Returns:

this + that.

Throws:

DimensionException - if point dimensions are different.

plus

public Point plus(Parameter<javax.measure.quantity.Length> that)

Adds the specified parameter to each component of this point. The unit of the output point will be the units of this point.

Specified by:

plus in class GeomPoint

Parameters:

that - the parameter to be added to each component of this point. May not be null.

Returns:

this + that.

minus

public Point minus(GeomPoint that)

Returns the difference between this point and the one specified. The unit of the output point will be the units of this point.

Specified by:

minus in class GeomPoint

Parameters:

that - the point to be subtracted from this point. May not be null.

Returns:

this - that.

Throws:

DimensionException - if point dimensions are different.

minus

public Point minus(Parameter<javax.measure.quantity.Length> that)

Subtracts the specified parameter from each component of this point. The unit of the output point will be the units of this point.

Specified by:

minus in class GeomPoint

Parameters:

that - the parameter to be subtracted from each component of this point. May not be null.

Returns:

this - that.

opposite

public Point opposite()

Returns the negation of this point (all the values of each dimension negated).

Specified by:

opposite in class GeomPoint

Returns:

-this

times

public Point times(double k)

Returns the product of this point with the specified coefficient.

Specified by:

times in class GeomPoint

Parameters:

k - the coefficient multiplier.

Returns:

this · k

copy

public MutablePoint copy()

Returns a copy of this MutablePoint instance allocated by the calling thread (possibly on the stack).

Specified by:

copy in interface GeomElement<GeomPoint>

Specified by:

copy in class GeomPoint

Returns:

an identical and independent copy of this point.

copyToReal

public Point copyToReal()

Return a copy of this object with any transformations or subranges removed (applied).

Specified by:

copyToReal in interface GeomElement<GeomPoint>

Specified by:

copyToReal in class GeomPoint

Returns:

A copy of this object with any transformations or subranges removed.

getUnit

public final javax.measure.unit.Unit<javax.measure.quantity.Length> getUnit()

Returns the unit in which the values in this point are stated in.

Returns:

The unit in which the values in this point are stated in.

immutable

public Point immutable()

Return an immutable version of this point.

Specified by:

immutable in class GeomPoint

Returns:

An immutable version of this point.

to

public MutablePoint to(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
                throws javax.measure.converter.ConversionException

Returns the equivalent to this point but stated in the specified unit.

Parameters:

unit - the length unit of the point to be returned. May not be null.

Returns:

an equivalent of this point but stated in the specified unit.

Throws:

javax.measure.converter.ConversionException - if the the input unit is not a length unit.

toDimension

public MutablePoint toDimension(int newDim)

Return the equivalent of this point converted to the specified number of physical dimensions. If the number of dimensions is greater than this element, then zeros are added to the additional dimensions. If the number of dimensions is less than this element, then the extra dimensions are simply dropped (truncated). If the new dimensions are the same as the dimension of this element, then this element is simply returned.

Parameters:

newDim - The dimension of the point to return.

Returns:

A copy of this point converted to the new dimensions.

toFloat64Vector

public final Float64Vector toFloat64Vector()

Returns the values stored in this point, stated in this point's unit, as a Float64Vector.

Specified by:

toFloat64Vector in class GeomPoint

Returns:

A Float64Vector containing the coordinate values for this point.

equals

public boolean equals(java.lang.Object obj)

Compares this Point against the specified object for strict equality (same values and same units).

Overrides:

equals in class AbstractGeomElement<GeomPoint>

Parameters:

obj - the object to compare with.

Returns:

true if this point is identical to that point; false otherwise.

hashCode

public int hashCode()

Returns the hash code for this parameter.

Overrides:

hashCode in class AbstractGeomElement<GeomPoint>

Returns:

the hash code value.