Name

---

    DOT_PRODUCT

Purpose

---

    This function will compute the dot product between two provided vectors
    (or arrays or vectors) in n-space.

Category

---

    General.

Calling Sequence

---

    Result = DOT_PRODUCT( vector1, vector2 )

Inputs

---

    vector1
      A n-dimensional vector -OR- an array of N n-dimensional vectors (nxN)
    vector2
      A n-dimensional vector -OR- an array of N n-dimensional vectors (nxN)
      (NOTE: The provided vector dimensions and number of vectors must be equal)

Keyword Parameters

---

    None
   

Result

---

    A scalar or a vector containg the dot product(s) between the provided
    vectors.

Side Effects

---

    If the size of the provided vectors do not match, execution will be halted
    and a session reset will occur.

Requires

---

    ARRAYS_ARE_SAME_SIZE

Modification History

---

    Written by: Carl Salvaggio
    September, 2009 Original code
 

Disclaimer

---

    This source code is provided "as is" and without warranties as to performance
    or merchantability. The author and/or distributors of this source code may
    have made statements about this source code. Any such statements do not
    constitute warranties and shall not be relied on by the user in deciding
    whether to use this source code.
    This source code is provided without any express or implied warranties
    whatsoever. Because of the diversity of conditions and hardware under which
    this source code may be used, no warranty of fitness for a particular purpose
    is offered. The user is advised to test the source code thoroughly before
    relying on it. The user must assume the entire risk of using the source code.