Module org.arakhne.afc.core.mathgeom

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

Class ImmutableVector1D<S extends Segment1D<?,?>>

java.lang.Object

org.arakhne.afc.math.geometry.d1.ImmutableVector1D<S>

Type Parameters:

S - the type of the segment.

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Vector1D<?,?,?>>, UnmodifiableVector1D<ImmutableVector1D<S>,ImmutablePoint1D<S>,S>, Vector1D<ImmutableVector1D<S>,ImmutablePoint1D<S>,S>, Tuple2D<ImmutableVector1D<S>>, UnmodifiableTuple2D<ImmutableVector1D<S>>, JsonableObject

public final class ImmutableVector1D<S extends Segment1D<?,?>>
extends Object
implements UnmodifiableVector1D<ImmutableVector1D<S>,ImmutablePoint1D<S>,S>

Immutable vector 1.5D.

Since:

14.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND

See Also:

Serialized Form

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Constructor Summary

Constructors

Constructor	Description
ImmutableVector1D(S segment, double x, double y)	Constructor.
ImmutableVector1D(S segment, int x, int y)	Constructor.

Method Summary

Modifier and Type	Method	Description
ImmutableVector1D<S>	clone()	Clone this point.
boolean	equals(Object object)	Returns true if the Object t1 is of type Tuple2D and all of the data members of t1 are equal to the corresponding data members in this Tuple2D.
ImmutableGeomFactory<S>	getGeomFactory()	Replies the geometry factory associated to this point.
S	getSegment()	Replies the segment.
double	getX()	Get the x coordinate.
double	getY()	Get the y coordinate.
int	hashCode()	Returns a hash code value based on the data values in this object.
int	ix()	Get the x coordinate.
int	iy()	Get the y coordinate.
void	toJson(JsonBuffer buffer)	Replies the Json representation of this node.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

epsilonEquals, equals, get, get, get

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.UnmodifiableVector1D

add, add, normalize, normalize, scaleAdd, scaleAdd, scaleAdd, scaleAdd, setLength, sub, sub, sub, toUnmodifiable

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

$div, $minus, $minus, $minus, $minus, $plus, $plus, $plus, $times, compareTo, equals, getLength, getLengthSquared, 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

Constructor Detail

ImmutableVector1D

public ImmutableVector1D(S segment,
                         double x,
                         double y)

Constructor.

Parameters:

segment - the segment.

x - x coordinate.

y - y coordinate.

ImmutableVector1D

public ImmutableVector1D(S segment,
                         int x,
                         int y)

Constructor.

Parameters:

segment - the segment.

x - x coordinate.

y - y coordinate.

Method Detail

getGeomFactory

public ImmutableGeomFactory<S> getGeomFactory()

Description copied from interface: Vector1D

Replies the geometry factory associated to this point.

Specified by:

getGeomFactory in interface Vector1D<ImmutableVector1D<S extends Segment1D<?,?>>,ImmutablePoint1D<S extends Segment1D<?,?>>,S extends Segment1D<?,?>>

Returns:

the factory.

getSegment

public S getSegment()

Description copied from interface: Vector1D

Replies the segment.

Specified by:

getSegment in interface Vector1D<ImmutableVector1D<S extends Segment1D<?,?>>,ImmutablePoint1D<S extends Segment1D<?,?>>,S extends Segment1D<?,?>>

Returns:

the segment or null if the weak reference has lost the segment.

equals

@Pure
public boolean equals(Object object)

Description copied from interface: Tuple2D

Returns true if the Object t1 is of type Tuple2D and all of the data members of t1 are equal to the corresponding data members in this Tuple2D.

Specified by:

equals in interface Tuple2D<S extends Segment1D<?,?>>

Specified by:

equals in interface Vector1D<ImmutableVector1D<S extends Segment1D<?,?>>,ImmutablePoint1D<S extends Segment1D<?,?>>,S extends Segment1D<?,?>>

Overrides:

equals in class Object

Parameters:

object - the object with which the comparison is made

Returns:

true or false

hashCode

@Pure
public int hashCode()

Description copied from interface: Tuple2D

Returns a hash code value based on the data values in this object. Two different Tuple2D objects with identical data values (i.e., Tuple2D.equals(Object) returns true) will return the same hash code value. Two objects with different data members may return the same hash value, although this is not likely.

Specified by:

hashCode in interface Tuple2D<S extends Segment1D<?,?>>

Overrides:

hashCode in class Object

Returns:

the integer hash code value

toString

@Pure
public String toString()

Overrides:

toString in class Object

toJson

public void toJson(JsonBuffer buffer)

Description copied from interface: JsonableObject

Replies the Json representation of this node.

Specified by:

toJson in interface JsonableObject

Parameters:

buffer - the Json buffer.

clone

@Pure
public ImmutableVector1D<S> clone()

Description copied from interface: Tuple2D

Clone this point.

Specified by:

clone in interface Tuple2D<S extends Segment1D<?,?>>

Overrides:

clone in class Object

Returns:

the clone.

getX

@Pure
public double getX()

Description copied from interface: Tuple2D

Get the x coordinate.

Specified by:

getX in interface Tuple2D<S extends Segment1D<?,?>>

Returns:

the x coordinate.

ix

@Pure
public int ix()

Description copied from interface: Tuple2D

Get the x coordinate.

Specified by:

ix in interface Tuple2D<S extends Segment1D<?,?>>

Returns:

the x coordinate.

getY

@Pure
public double getY()

Description copied from interface: Tuple2D

Get the y coordinate.

Specified by:

getY in interface Tuple2D<S extends Segment1D<?,?>>

Returns:

the y coordinate.

iy

@Pure
public int iy()

Description copied from interface: Tuple2D

Get the y coordinate.

Specified by:

iy in interface Tuple2D<S extends Segment1D<?,?>>

Returns:

the y coordinate.