\n\n\n\nComplexVector\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n\n\n\n\n
\n
\n
\n\n\n\n
\n
org.jscience.mathematics.vector
\n

## Class ComplexVector

\n
\n
\n
\n
\n
\n
\n
\n
\n
• \n\n
\n
• \n\n\n

### Method Summary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Methods
Modifier and TypeMethod and Description
`ComplexVector``copy()`\n
Returns a copy of this vector \n `allocated` \n by the calling thread (possibly on the stack).
\n
`Complex``get(int i)`\n
Returns a single element from this vector.
\n
`int``getDimension()`\n
Returns the number of elements held by this vector.
\n
`double``getImaginary(int i)`\n
Returns the imaginary value of a complex number from this vector (fast).
\n
`double``getReal(int i)`\n
Returns the real value of a complex number from this vector (fast).
\n
`ComplexVector``minus(Vector<Complex> that)`\n
Returns the difference between this vector and the one specified.
\n
`Complex``norm()`\n
Returns the Euclidian norm of this vector (square root of the \n dot product of this vector and itself).
\n
`ComplexVector``opposite()`\n
Returns the negation of this vector.
\n
`ComplexVector``plus(Vector<Complex> that)`\n
Returns the sum of this vector with the one specified.
\n
`ComplexVector``times(Complex k)`\n
Returns the product of this vector with the specified coefficient.
\n
`Complex``times(Vector<Complex> that)`\n
Returns the dot product of this vector with the one specified.
\n
`static ComplexVector``valueOf(Complex... elements)`\n
Returns a new vector holding the specified complex numbers.
\n
`static ComplexVector``valueOf(List<Complex> elements)`\n
Returns a new vector holding the elements from the specified \n collection.
\n
`static ComplexVector``valueOf(Vector<Complex> that)`\n
Returns a `ComplexVector` instance equivalent to the \n specified vector.
\n
\n
\n
• \n\n\n

### Methods inherited from class org.jscience.mathematics.vector.Vector

\n`cross, equals, equals, hashCode, toString, toText`
• \n
\n
\n
• \n\n\n

### Methods inherited from class java.lang.Object

\n`getClass, notify, notifyAll, wait, wait, wait`
• \n
\n
• \n
\n
• \n
\n
\n
\n
\n
• \n\n
\n
• \n\n\n

### Method Detail

\n\n\n\n
\n
• \n

#### valueOf

\n
`public static ComplexVector valueOf(Complex... elements)`
\n
Returns a new vector holding the specified complex numbers.
\n
Parameters:
`elements` - the complex numbers elements.
\n
Returns:
the vector having the specified complex numbers.
\n
• \n
\n\n\n\n
\n
• \n

#### valueOf

\n
`public static ComplexVector valueOf(List<Complex> elements)`
\n
Returns a new vector holding the elements from the specified \n collection.
\n
Parameters:
`elements` - the collection of floating-points numbers.
\n
Returns:
the vector having the specified elements.
\n
• \n
\n\n\n\n
\n
• \n

#### valueOf

\n
`public static ComplexVector valueOf(Vector<Complex> that)`
\n
Returns a `ComplexVector` instance equivalent to the \n specified vector.
\n
Parameters:
`that` - the vector to convert.
\n
Returns:
`that` or new equivalent ComplexVector.
\n
• \n
\n\n\n\n
\n
• \n

#### getReal

\n
`public double getReal(int i)`
\n
Returns the real value of a complex number from this vector (fast).
\n
Parameters:
`i` - the complex number index.
\n
Returns:
the real value of complex at `i`.
\n
Throws:
\n
`IndexOutOfBoundsException` - `(i < 0) || (i >= dimension())`
\n
• \n
\n\n\n\n
\n
• \n

#### getImaginary

\n
`public double getImaginary(int i)`
\n
Returns the imaginary value of a complex number from this vector (fast).
\n
Parameters:
`i` - the complex number index.
\n
Returns:
the real value of complex at `i`.
\n
Throws:
\n
`IndexOutOfBoundsException` - `(i < 0) || (i >= dimension())`
\n
• \n
\n\n\n\n
\n
• \n

#### norm

\n
`public Complex norm()`
\n
Returns the Euclidian norm of this vector (square root of the \n dot product of this vector and itself).
\n
\n
Specified by:
\n
`norm` in interface `VectorSpaceNormed<Vector<Complex>,Complex>`
\n
Returns:
`sqrt(this \xc2\xb7 this)`.
\n Wikipedia: Vector Norm
\n
• \n
\n\n\n\n
\n
• \n

#### getDimension

\n
`public int getDimension()`
\n
Description copied from class: `Vector`
\n
Returns the number of elements held by this vector.
\n
\n
Specified by:
\n
`getDimension` in class `Vector<Complex>`
\n
Returns:
this vector dimension.
\n
• \n
\n\n\n\n
\n
• \n

#### get

\n
`public Complex get(int i)`
\n
Description copied from class: `Vector`
\n
Returns a single element from this vector.
\n
\n
Specified by:
\n
`get` in class `Vector<Complex>`
\n
Parameters:
`i` - the element index (range [0..n[).
\n
Returns:
the element at `i`.
\n
• \n
\n\n\n\n
\n
• \n

#### opposite

\n
`public ComplexVector opposite()`
\n
Description copied from class: `Vector`
\n
Returns the negation of this vector.
\n
\n
Specified by:
\n
`opposite` in interface `GroupAdditive<Vector<Complex>>`
\n
Specified by:
\n
`opposite` in class `Vector<Complex>`
\n
Returns:
`-this`.
\n
• \n
\n\n\n\n
\n
• \n

#### plus

\n
`public ComplexVector plus(Vector<Complex> that)`
\n
Description copied from class: `Vector`
\n
Returns the sum of this vector with the one specified.
\n
\n
Specified by:
\n
`plus` in interface `GroupAdditive<Vector<Complex>>`
\n
Specified by:
\n
`plus` in class `Vector<Complex>`
\n
Parameters:
`that` - the vector to be added.
\n
Returns:
`this + that`.
\n
• \n
\n\n\n\n
\n
• \n

#### minus

\n
`public ComplexVector minus(Vector<Complex> that)`
\n
Description copied from class: `Vector`
\n
Returns the difference between this vector and the one specified.
\n
\n
Overrides:
\n
`minus` in class `Vector<Complex>`
\n
Parameters:
`that` - the vector to be subtracted.
\n
Returns:
`this - that`.
\n
• \n
\n\n\n\n
\n
• \n

#### times

\n
`public ComplexVector times(Complex k)`
\n
Description copied from class: `Vector`
\n
Returns the product of this vector with the specified coefficient.
\n
\n
Specified by:
\n
`times` in interface `VectorSpace<Vector<Complex>,Complex>`
\n
Specified by:
\n
`times` in class `Vector<Complex>`
\n
Parameters:
`k` - the coefficient multiplier.
\n
Returns:
`this \xc2\xb7 k`
\n
• \n
\n\n\n\n
\n
• \n

#### times

\n
`public Complex times(Vector<Complex> that)`
\n
Description copied from class: `Vector`
\n
Returns the dot product of this vector with the one specified.
\n
\n
Specified by:
\n
`times` in class `Vector<Complex>`
\n
Parameters:
`that` - the vector multiplier.
\n
Returns:
`this \xc2\xb7 that`
\n Wikipedia: Dot Product
\n
• \n
\n\n\n\n
\n
• \n

#### copy

\n
`public ComplexVector copy()`
\n
Description copied from class: `Vector`
\n
Returns a copy of this vector \n `allocated` \n by the calling thread (possibly on the stack).
\n
\n
Specified by:
\n
`copy` in interface `javolution.lang.ValueType`
\n
Specified by:
\n
`copy` in class `Vector<Complex>`
\n
Returns:
an identical and independant copy of this matrix.
\n
• \n
\n
• \n
\n
• \n
\n
\n
\n\n\n
\n\n\n\n\n
\n
\n
\n\n\n

SCaVis 1.0 © jWork.org

\n\n\n