Vec3d (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- mil.navy.nps.rra.Vec3d

```
public class Vec3d
extends Object
```
Vector arithmetic routines for 3-element vectors of type Double.

Constructor Summary

Constructors
Constructor and Description
`Vec3d()` Constructs an Vec3d object.
`Vec3d(double[] vec)` Constructs an Vec3d object.
`Vec3d(double v0, double v1, double v2)` Creates a new Vec3d instance.
`Vec3d(Vec3d vec)` Constructs an Vec3d object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(Vec3d vec)` This method adds up Vec3d object to the array.
`void`	`add(Vec3d vec1, Vec3d vec2)` This method add Vec3d objects to the v array.
`void`	`cross(Vec3d vec)` This method calculates by used Vec3d object.
`void`	`cross(Vec3d vec1, Vec3d vec2)` This method calculates using Vec3d objects.
`double`	`dot(Vec3d vec)` This method returns the result of the multiplication with the array v and Vec3d object.
`static double`	`dot(Vec3d vec1, Vec3d vec2)` This method is a static method which calculates using Vec3d objects.
`void`	`get(double[] vec)` This method gets.. ?
`void`	`get(double[] v0, double[] v1, double[] v2)` This method gets .. ?
`double`	`get(int index)` This method returns the array of v by requested of index.
`void`	`get(Vec3d vec)` This method gets.. ?
`double`	`length_sqr()` This method calculates the square root of the v array value.
`double`	`length()` This method calculates the square root of the v array value.
`void`	`makeNull()` Initialize the v array.
`void`	`negate()` Set negative value to the v array.
`void`	`negate(Vec3d vec)` Set negative value to the v array.
`void`	`normalize()` This method
`void`	`normalize(Vec3d vec)` This method calculate the length of one over.
`void`	`print()` This method prints v[0], v[1] and v[2] values.
`void`	`scale(double s)` This methods does multiplication the array v with double value.
`void`	`scale(double s, Vec3d vec)` This methods does multiplication the array v with double value.
`void`	`set(double[] vec)` This method sets the array of vector into the array of v.
`void`	`set(double v0, double v1, double v2)` This method sets v0, v1 and v2 value into the array of v.
`void`	`set(int index, double val)` This method set value into the array of v.
`void`	`set(Vec3d vec)` This method sets Vec3d object into the array of v.
`void`	`sub(Vec3d vec)` This method performs subtraction.
`void`	`sub(Vec3d vec1, Vec3d vec2)` This method performs subtraction.

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

- Constructor Detail
  - Vec3d
```
public Vec3d()
```
    Constructs an Vec3d object.
  - Vec3d
```
public Vec3d(double v0,
     double v1,
     double v2)
```
    Creates a new Vec3d instance.
    
    Parameters:
    v0 - double.
    v1 - double.
    v2 - double.
  - Vec3d
```
public Vec3d(double[] vec)
```
    Constructs an Vec3d object.
    
    Parameters:
    vec - the array of double.
  - Vec3d
```
public Vec3d(Vec3d vec)
```
    Constructs an Vec3d object.
    
    Parameters:
    vec - Vec3d object.
- Method Detail
  - print
```
public void print()
```
    This method prints v[0], v[1] and v[2] values.
  - set
```
public void set(double v0,
       double v1,
       double v2)
```
    This method sets v0, v1 and v2 value into the array of v.
    
    Parameters:
    v0 - value of double.
    v1 - value of double.
    v2 - value of double.
  - get
```
public void get(double[] v0,
       double[] v1,
       double[] v2)
```
    This method gets .. ?
    
    Parameters:
    v0 - double.
    v1 - double.
    v2 - double.
  - set
```
public void set(int index,
       double val)
```
    This method set value into the array of v.
    
    Parameters:
    index - the array index.
    val - value.
  - get
```
public double get(int index)
```
    This method returns the array of v by requested of index.
    
    Parameters:
    index - the requested index value.
    
    Returns:
    the value of the array of v.
  - set
```
public void set(double[] vec)
```
    This method sets the array of vector into the array of v.
    
    Parameters:
    vec - the array of vector.
  - get
```
public void get(double[] vec)
```
    This method gets.. ?
    
    Parameters:
    vec - the array of double.
  - set
```
public void set(Vec3d vec)
```
    This method sets Vec3d object into the array of v.
    
    Parameters:
    vec - Vec3d object.
  - get
```
public void get(Vec3d vec)
```
    This method gets.. ?
    
    Parameters:
    vec - Vec3d object.
  - makeNull
```
public void makeNull()
```
    Initialize the v array.
  - negate
```
public void negate()
```
    Set negative value to the v array.
  - negate
```
public void negate(Vec3d vec)
```
    Set negative value to the v array.
    
    Parameters:
    vec - Vec3d object.
  - add
```
public void add(Vec3d vec)
```
    This method adds up Vec3d object to the array.
    
    Parameters:
    vec - Vec3d object.
  - add
```
public void add(Vec3d vec1,
       Vec3d vec2)
```
    This method add Vec3d objects to the v array.
    
    Parameters:
    vec1 - Vec3d object.
    vec2 - Vec3d object.
  - sub
```
public void sub(Vec3d vec)
```
    This method performs subtraction.
    
    Parameters:
    vec - Vec3d object.
  - sub
```
public void sub(Vec3d vec1,
       Vec3d vec2)
```
    This method performs subtraction.
    
    Parameters:
    vec1 - Vec3d object.
    vec2 - Vec3d object.
  - scale
```
public void scale(double s)
```
    This methods does multiplication the array v with double value.
    
    Parameters:
    s - double.
  - scale
```
public void scale(double s,
         Vec3d vec)
```
    This methods does multiplication the array v with double value.
    
    Parameters:
    s - double.
    vec - Vec3d object.
  - length
```
public double length()
```
    This method calculates the square root of the v array value.
    
    Returns:
    the correctly rounded positive square root of the v array value.
  - length_sqr
```
public double length_sqr()
```
    This method calculates the square root of the v array value.
    
    Returns:
    the square root of the v array value.
  - normalize
```
public void normalize()
```
    This method
  - normalize
```
public void normalize(Vec3d vec)
```
    This method calculate the length of one over. It multiplies and normalizes with the array v.
    
    Parameters:
    vec - Vec3d object.
  - dot
```
public double dot(Vec3d vec)
```
    This method returns the result of the multiplication with the array v and Vec3d object.
    
    Parameters:
    vec - Vec3d object.
    
    Returns:
    the result of the multiplication with the array v and Vec3d object.
  - dot
```
public static double dot(Vec3d vec1,
         Vec3d vec2)
```
    This method is a static method which calculates using Vec3d objects.
    
    Parameters:
    vec1 - Vec3d object.
    vec2 - Vec3d object.
    
    Returns:
    the result of calculation used Vec3d objects.
  - cross
```
public void cross(Vec3d vec)
```
    This method calculates by used Vec3d object.
    
    Parameters:
    vec - Vec3d object.
  - cross
```
public void cross(Vec3d vec1,
         Vec3d vec2)
```
    This method calculates using Vec3d objects.
    
    Parameters:
    vec1 - Vec3d object.
    vec2 - Vec3d object.

Class Vec3d

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Vec3d

Vec3d

Vec3d

Vec3d

Method Detail

print

set

get

set

get

set

get

set

get

makeNull

negate

negate

add

add

sub

sub

scale

scale

length

length_sqr

normalize

normalize

dot

dot

cross

cross