SimpleVector

java.lang.Object
- de.thaw.comb.util.SimpleVector

All Implemented Interfaces:

Vector
```
public final class SimpleVector
extends Object
implements Vector
```
An euclidian vector implementation. Objects are defined either by cartesian differences or -- at the client's option -- by distance and bearing. Instances represent free vectors: The initial and terminal points are not stored, only their difference.

Field Summary
- Fields inherited from interface de.thaw.comb.util.Vector
  FULL_CIRCLE, RIGHT_ANGLE, SEMI_CIRCLE

Constructor Summary

Constructors
Constructor and Description

SimpleVector(PlaneCoordinates start, PlaneCoordinates end)
Creates a vector from start to end.

Constructors
Constructor and Description
`SimpleVector(PlaneCoordinates start, PlaneCoordinates end)` Creates a vector from `start` to `end`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SimpleVector`	`aligned(Vector v)` Compares this vector to the specified vector with regards to their convergence.
`double`	`bearing()` The angle from grid north to the vector's direction, measured clockwise.
`(package private) static SimpleVector`	`createFromDistanceBearing(double distance, double bearing)` Creates a vector given in polar coordinates.
`double`	`distance()` The vector's length (norm).
`static double`	`distance(PlaneCoordinates point1, PlaneCoordinates point2)` Obtain the distance (in internal coordinates) between two points.
`double`	`easting()` The ordinate (horizontal / longitudinal) aspect of the vector's coordinate representation.
`static double`	`eastingFromDistanceBearing(double distance, double bearing)` Obtain the distance in the ordinate (horizontal / longitudinal) aspect of a vector given in polar coordinates.
`boolean`	`isAligned(Vector v)` Compares this vector's bearing to the specified vector's bearing.
`static double`	`normaliseAbsoluteBearing(double bearing)` Reduces a bearing to the interval [0, 2 π).
`static double`	`normaliseRelativeBearing(double bearing)` Reduces a bearing to the interval [−π, π).
`double`	`northing()` The abscissa (vertical / latitudinal) aspect of the vector's coordinate representation.
`static double`	`northingFromDistanceBearing(double distance, double bearing)` Obtain the distance in the abscissa (vertical / latitudinal) aspect of a vector given in polar coordinates.
`double`	`relativeBearing(Vector v)` The angle from this vector's direction to the specified vector's direction, measured counterclockwise or clockwise, whichever is nearer.
`SimpleVector`	`reversed()` Returns a reversed representation of this vector.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimpleVector
```
public SimpleVector(PlaneCoordinates start,
                    PlaneCoordinates end)
```
    Creates a vector from start to end.
    
    Parameters:
    
    start - the initial point
    
    end - the terminal point
    
    Throws:
    
    NullPointerException - iff start == null || end == null
- Method Detail
  - createFromDistanceBearing
```
static SimpleVector createFromDistanceBearing(double distance,
                                              double bearing)
```
    Creates a vector given in polar coordinates.
    
    Parameters:
    
    distance - the length
    
    bearing - the direction
    
    Throws:
    
    NullPointerException - iff start == null || end == null
    
    See Also:
    
    Vector.bearing()
  - easting
```
public double easting()
```
    Description copied from interface: Vector
    
    The ordinate (horizontal / longitudinal) aspect of the vector's coordinate representation.
    
    Specified by:
    
    easting in interface Vector
    
    Returns:
    
    the difference in easting (in internal units)
  - northing
```
public double northing()
```
    Description copied from interface: Vector
    
    The abscissa (vertical / latitudinal) aspect of the vector's coordinate representation.
    
    Specified by:
    
    northing in interface Vector
    
    Returns:
    
    the difference in northing (in internal units)
  - distance
```
public static double distance(PlaneCoordinates point1,
                              PlaneCoordinates point2)
```
    Obtain the distance (in internal coordinates) between two points. This distance is equivalent to the length of a vector created from the two points, but this method forgoes creating a new object for this purpose.
    
    Returns:
    
    distance between point1 and point2
    
    Throws:
    
    NullPointerException - iff point1 == null || point2 == null
  - distance
```
public double distance()
```
    Description copied from interface: Vector
    
    The vector's length (norm).
    
    Specified by:
    
    distance in interface Vector
    
    Returns:
    
    the length (in internal units)
  - bearing
```
public double bearing()
```
    Description copied from interface: Vector
    
    The angle from grid north to the vector's direction, measured clockwise. This value must always be returned in radians, facilitating easy use with Math.
    For example, if a vector pointed to the west, this method would return 3/2 π (equal to 270°).
    It is strongly recommended for implementations to return bearings normalised to the interval [0, 2 π), but clients should not depend upon this behaviour.
    
    Specified by:
    
    bearing in interface Vector
    
    Returns:
    
    the vector's bearing (direction)
    
    See Also:
    
    normaliseAbsoluteBearing(double), Bearing (Wikipedia)
  - relativeBearing
```
public double relativeBearing(Vector v)
```
    The angle from this vector's direction to the specified vector's direction, measured counterclockwise or clockwise, whichever is nearer.
    
    Specified by:
    
    relativeBearing in interface Vector
    
    Parameters:
    
    v - the vector to calculate the bearing of in relation to this vector
    
    Returns:
    
    relative bearing in interval [−π, π); 0.0 if v is zero-length
    
    See Also:
    
    normaliseRelativeBearing(double), Relative bearing (Wikipedia)
  - normaliseAbsoluteBearing
```
public static double normaliseAbsoluteBearing(double bearing)
```
    Reduces a bearing to the interval [0, 2 π). Bearings returned by this method are safe to compare with == for congruency.
    
    Parameters:
    
    bearing - the bearing to normalise
    
    Returns:
    
    bearing, normalised
  - normaliseRelativeBearing
```
public static double normaliseRelativeBearing(double bearing)
```
    Reduces a bearing to the interval [−π, π). Bearings returned by this method are safe to compare with == for congruency.
    
    Parameters:
    
    bearing - the bearing to normalise
    
    Returns:
    
    bearing, normalised
  - reversed
```
public SimpleVector reversed()
```
    Description copied from interface: Vector
    
    Returns a reversed representation of this vector.
    
    Specified by:
    
    reversed in interface Vector
    
    Returns:
    
    a view of this vector, reversed
  - aligned
```
public SimpleVector aligned(Vector v)
```
    Description copied from interface: Vector
    Compares this vector to the specified vector with regards to their convergence. Implementations might use code that basically produces the same result as the following line does: return isAligned(v) ? clone() : reversed(); If the vectors already are aligned, implementations are free to return either this itself or another Vector object of equivalent value, at their option.
    Specified by:
    
    aligned in interface Vector
    
    Parameters:
    
    v - the vector to be compared with this one
    
    Returns:
    
    a view of this vector that is aligned with v
    
    See Also:
    
    Vector.isAligned(de.thaw.comb.util.Vector)
  - isAligned
```
public boolean isAligned(Vector v)
```
    Description copied from interface: Vector
    Compares this vector's bearing to the specified vector's bearing. For the purpose of this interface, two vectors are defined as being "aligned" if the absolute value of their relative bearing is less than a right angle. In other words, they are aligned if they form an acute angle and not aligned if they form an obtuse angle.
    Implementations might use code that basically produces the same result as the following line does:
```
 return Math.abs( relativeBearing(v) ) < RIGHT_ANGLE;
 
```
    The result of this method if the vectors are orthogonal is undefined.
    Specified by:
    
    isAligned in interface Vector
    
    Parameters:
    
    v - the vector to be compared with this one
    
    Returns:
    
    whether the two vectors differ by an acute angle
    
    See Also:
    
    Vector.relativeBearing(de.thaw.comb.util.Vector)
  - toString
```
public String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this object
  - eastingFromDistanceBearing
```
public static double eastingFromDistanceBearing(double distance,
                                                double bearing)
```
    Obtain the distance in the ordinate (horizontal / longitudinal) aspect of a vector given in polar coordinates. This distance is equivalent to the easting() of a vector created from the polar coordinates, but this method forgoes creating a new object for this purpose.
    
    Parameters:
    
    distance - the length
    
    bearing - the direction
    
    Returns:
    
    easting distance for the specified vector
  - northingFromDistanceBearing
```
public static double northingFromDistanceBearing(double distance,
                                                 double bearing)
```
    Obtain the distance in the abscissa (vertical / latitudinal) aspect of a vector given in polar coordinates. This distance is equivalent to the northing() of a vector created from the polar coordinates, but this method forgoes creating a new object for this purpose.
    
    Parameters:
    
    distance - the length
    
    bearing - the direction
    
    Returns:
    
    northing distance for the specified vector

Class SimpleVector

Field Summary

Fields inherited from interface de.thaw.comb.util.Vector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleVector

Method Detail

createFromDistanceBearing

easting

northing

distance

distance

bearing

relativeBearing

normaliseAbsoluteBearing

normaliseRelativeBearing

reversed

aligned

isAligned

toString

eastingFromDistanceBearing

northingFromDistanceBearing