java.lang.Object
- JxnVectorAlgebra

All Implemented Interfaces:: JxnCloneableAlgebra

public class JxnVectorAlgebra
extends Object
implements JxnCloneableAlgebra

Implementation of a vector algebra.

Visualize 3-dimensional vector objects in a JxnPerspectivePlotFrame using the add methods.
Example:


    #JXN:include/P3dInclude.jxn
    plot(p3d).add( @JxnVectorAlgebra( 0.6, 0.8, 1.0 ) ).box()

Field Summary

Fields
Modifier and Type Field Description

protected static double equalityTolerance
See setEqualityTolerance(double).

double[] itsV
Internal storage.

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`JxnVectorAlgebra(double[] arr)`	Creates a vector algebra instance from the array `double [] arr`.
`protected`	`JxnVectorAlgebra(double[] arr, boolean copyInput)`	Creates a vector algebra instance from the array `double [] arr`.
	`JxnVectorAlgebra(double lat, double lon, boolean degrees)`	Creates a 3-dimensional vector of length 1 from latitude-angle and longitude-angle.
	`JxnVectorAlgebra(double x, double y, double z)`	Creates a 3-dimensional vector ( x, y, z ).
	`JxnVectorAlgebra(JxnVectorAlgebra v)`	Creates a copy of `v`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`double`	`abs()`	Returns the length (sqrt of the sum of the squares of the components) of this vector object.
`static double`	`abs(JxnVectorAlgebra va)`	Returns the length (sqrt of the sum of the squares of the components) of `va`.
`JxnVectorAlgebra`	`add(JxnVectorAlgebra opnd)`	Adds `opnd` to this vector.
`JxnCloneableAlgebra`	`cloneThis()`	Called internally.
`static double`	`cosphi(JxnVectorAlgebra v1, JxnVectorAlgebra v2)`	Returns cosine of the angle between `v1` and `v2`.
`JxnVectorAlgebra`	`div(double scalar)`	Divides this vector by `scalar`.
`boolean`	`equals(Object other)`	Two vector objects are equal, if all corresponding components are equal.
`double`	`get(int i)`	Returns the `i`-th component of this vector object.
`static double`	`getEqualityTolerance()`	Returns the tolerance used for the `equals` method.
`double`	`getX()`	Returns the x-component of this vector object.
`double`	`getY()`	Returns the y-component of this vector object.
`double`	`getZ()`	Returns the z-component of this vector object.
`protected double`	`hypot(double x, double y)`	Returns `Math.hypot(double, double)`.
`double`	`lat()`	Returns the latitude angle of this vector object.
`static double`	`lat(JxnVectorAlgebra va)`	Returns the latitude angle of `va`.
`double`	`latD()`	Returns the latitude angle of this vector object in degrees.
`static double`	`latD(JxnVectorAlgebra va)`	Returns the latitude angle of `va` in degrees.
`double`	`lon()`	Returns the longitude angle of this vector object.
`static double`	`lon(JxnVectorAlgebra va)`	Returns the latitude angle of `va`.
`double`	`lonD()`	Returns the longitude angle of this vector object in degrees.
`static double`	`lonD(JxnVectorAlgebra va)`	Returns the latitude angle of `va` in degrees.
`JxnVectorAlgebra`	`mul(double scalar)`	Multiplies this vector by `scalar`.
`static JxnVectorAlgebra`	`mul(double scalar, JxnVectorAlgebra v)`	Returns `v` scaled by `scalar`.
`static JxnVectorAlgebra`	`mul(JxnVectorAlgebra v1, JxnVectorAlgebra v2)`	Returns the vektor product `v1` × `v2`.
`JxnVectorAlgebra`	`mulL(double scalar)`	Multiplies this vector by `scalar`.
`static JxnVectorAlgebra`	`normal(JxnVectorAlgebra vr)`	Finds a normal vector for `vr`.
`static int`	`pathCoverage()`	For test of method `normal(JxnVectorAlgebra)`.
`KmgComplex`	`phasor(IKmg3DProjection p3d)`	Deprecated. Use `JxnPerspectivePlotFrame.add(JxnVectorAlgebra)`.
`static double`	`phi(JxnVectorAlgebra v1, JxnVectorAlgebra v2)`	Returns the angle between `v1` and `v2`.
`static double`	`phiD(JxnVectorAlgebra v1, JxnVectorAlgebra v2)`	Returns the angle between `v1` and `v2` in degrees.
`static double`	`prod(JxnVectorAlgebra v1, JxnVectorAlgebra v2)`	Returns the scalar produkt `v1` · `v2`.
`JxnVectorAlgebra`	`set(int i, double vi)`	Replaces the `i`-th component of this `JxnVectorAlgebra` by `vi`.
`static JxnVectorAlgebra`	`set(JxnVectorAlgebra va, int i, double vi)`	Returns a copy of `ra`, with the `i`-th component replaced by `vi`.
`static double`	`setEqualityTolerance(double eps)`	Sets the tolerance for the `equals` method for all instances of this class.
`double`	`setValue(int i, double vi)`	Replaces the `i`-th component of this `JxnVectorAlgebra` by `vi`.
`JxnVectorAlgebra`	`sub(JxnVectorAlgebra opnd)`	Subtracts `opnd` from this vector.
`double[]`	`toArray()`	Returns an array containing the vector components of this vector object.
`String`	`toString()`	Returns a String representation of this vector object.

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

- Field Detail
  - equalityTolerance
```
protected static double equalityTolerance
```
    See setEqualityTolerance(double).
  - itsV
```
public double[] itsV
```
    Internal storage.
- Constructor Detail
  - JxnVectorAlgebra
```
public JxnVectorAlgebra(double x,
                        double y,
                        double z)
```
    Creates a 3-dimensional vector ( x, y, z ).
  - JxnVectorAlgebra
```
public JxnVectorAlgebra(double lat,
                        double lon,
                        boolean degrees)
```
    Creates a 3-dimensional vector of length 1 from latitude-angle and longitude-angle.
    
    Parameters:
    
    degrees - if true, the angles are expected in degrees.
  - JxnVectorAlgebra
```
protected JxnVectorAlgebra(double[] arr)
```
    Creates a vector algebra instance from the array double [] arr. Calls JxnVectorAlgebra( arr, false )
  - JxnVectorAlgebra
```
protected JxnVectorAlgebra(double[] arr,
                           boolean copyInput)
```
    Creates a vector algebra instance from the array double [] arr.
    
    Parameters:
    
    copyInput - if true, stores a copy of the array arr, otherwise stores a reference to the array arr.
  - JxnVectorAlgebra
```
public JxnVectorAlgebra(JxnVectorAlgebra v)
```
    Creates a copy of v.
- Method Detail
  - cloneThis
```
public JxnCloneableAlgebra cloneThis()
```
    Description copied from interface: JxnCloneableAlgebra
    
    Called internally. Required to avoid overwriting the left side operand opndLeft in opndLeft op opndRght, if op is implemented as opndLeft.op(opndRght) and the instance method op modifies the instance.
    
    Specified by:
    
    cloneThis in interface JxnCloneableAlgebra
    
    Returns:
    
    copy of this instance
  - add
```
public JxnVectorAlgebra add(JxnVectorAlgebra opnd)
```
    Adds opnd to this vector.
    
    Returns:
    
    this
  - sub
```
public JxnVectorAlgebra sub(JxnVectorAlgebra opnd)
```
    Subtracts opnd from this vector.
    
    Returns:
    
    this
  - mul
```
public static JxnVectorAlgebra mul(JxnVectorAlgebra v1,
                                   JxnVectorAlgebra v2)
```
    Returns the vektor product v1 × v2.
    
    See Also:
    
    Wikipedia
  - mul
```
public JxnVectorAlgebra mul(double scalar)
```
    Multiplies this vector by scalar.
    
    Returns:
    
    this
  - mul
```
public static JxnVectorAlgebra mul(double scalar,
                                   JxnVectorAlgebra v)
```
    Returns v scaled by scalar.
  - mulL
```
public JxnVectorAlgebra mulL(double scalar)
```
    Multiplies this vector by scalar.
    
    Returns:
    
    this
  - div
```
public JxnVectorAlgebra div(double scalar)
```
    Divides this vector by scalar.
    
    Returns:
    
    this
  - prod
```
public static double prod(JxnVectorAlgebra v1,
                          JxnVectorAlgebra v2)
```
    Returns the scalar produkt v1 · v2.
    
    See Also:
    
    Wikipedia
  - equals
```
public boolean equals(Object other)
```
    Two vector objects are equal, if all corresponding components are equal. Use setEqualityTolerance(double) to set a tolerance for the comparision of the vector components.
    
    Overrides:
    
    equals in class Object
  - setEqualityTolerance
```
public static double setEqualityTolerance(double eps)
```
    Sets the tolerance for the equals method for all instances of this class.
    
    Parameters:
    
    eps -
    eps > 0. absolute difference
    eps < 0. difference relative to the length of the longest of two vectors to be compared
    
    Returns:
    
    old tolerance
  - getEqualityTolerance
```
public static double getEqualityTolerance()
```
    Returns the tolerance used for the equals method.
  - toString
```
public String toString()
```
    Returns a String representation of this vector object.
    
    Overrides:
    
    toString in class Object
  - toArray
```
public double[] toArray()
```
    Returns an array containing the vector components of this vector object.
  - set
```
public JxnVectorAlgebra set(int i,
                            double vi)
```
    Replaces the i-th component of this JxnVectorAlgebra by vi.
    
    Returns:
    
    this
  - set
```
public static JxnVectorAlgebra set(JxnVectorAlgebra va,
                                   int i,
                                   double vi)
```
    Returns a copy of ra, with the i-th component replaced by vi.
  - setValue
```
public double setValue(int i,
                       double vi)
```
    Replaces the i-th component of this JxnVectorAlgebra by vi.
    
    Returns:
    
    the old value
  - get
```
public double get(int i)
```
    Returns the i-th component of this vector object.
  - getX
```
public double getX()
```
    Returns the x-component of this vector object.
  - getY
```
public double getY()
```
    Returns the y-component of this vector object.
  - getZ
```
public double getZ()
```
    Returns the z-component of this vector object.
  - abs
```
public double abs()
```
    Returns the length (sqrt of the sum of the squares of the components) of this vector object.
  - abs
```
public static double abs(JxnVectorAlgebra va)
```
    Returns the length (sqrt of the sum of the squares of the components) of va.
  - lat
```
public double lat()
```
    Returns the latitude angle of this vector object.
  - latD
```
public double latD()
```
    Returns the latitude angle of this vector object in degrees.
  - lat
```
public static double lat(JxnVectorAlgebra va)
```
    Returns the latitude angle of va.
  - latD
```
public static double latD(JxnVectorAlgebra va)
```
    Returns the latitude angle of va in degrees.
  - lon
```
public double lon()
```
    Returns the longitude angle of this vector object.
  - lonD
```
public double lonD()
```
    Returns the longitude angle of this vector object in degrees.
  - lon
```
public static double lon(JxnVectorAlgebra va)
```
    Returns the latitude angle of va.
  - lonD
```
public static double lonD(JxnVectorAlgebra va)
```
    Returns the latitude angle of va in degrees.
  - hypot
```
protected double hypot(double x,
                       double y)
```
    Returns Math.hypot(double, double).
  - phi
```
public static double phi(JxnVectorAlgebra v1,
                         JxnVectorAlgebra v2)
```
    Returns the angle between v1 and v2.
  - phiD
```
public static double phiD(JxnVectorAlgebra v1,
                          JxnVectorAlgebra v2)
```
    Returns the angle between v1 and v2 in degrees.
  - cosphi
```
public static double cosphi(JxnVectorAlgebra v1,
                            JxnVectorAlgebra v2)
```
    Returns cosine of the angle between v1 and v2.
  - normal
```
public static JxnVectorAlgebra normal(JxnVectorAlgebra vr)
```
    Finds a normal vector for vr. Use vn1 = normal( vr ); vn2 = mul( vn1, vr ); to get an orthogonal system.
  - pathCoverage
```
public static int pathCoverage()
```
    For test of method normal(JxnVectorAlgebra).
  - phasor
```
public KmgComplex phasor(IKmg3DProjection p3d)
```
    Deprecated.
    Use JxnPerspectivePlotFrame.add(JxnVectorAlgebra).

Modifier and Type	Field	Description
`protected static double`	`equalityTolerance`	See `setEqualityTolerance(double)`.
`double[]`	`itsV`	Internal storage.

Class JxnVectorAlgebra

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

equalityTolerance

itsV

Constructor Detail

JxnVectorAlgebra

JxnVectorAlgebra

JxnVectorAlgebra

JxnVectorAlgebra

JxnVectorAlgebra

Method Detail

cloneThis

add

sub

mul

mul

mul

mulL

div

prod

equals

setEqualityTolerance

getEqualityTolerance

toString

toArray

set

set

setValue

get

getX

getY

getZ

abs

abs

lat

latD

lat

latD

lon

lonD

lon

lonD

hypot

phi

phiD

cosphi

normal

pathCoverage

phasor