ComplexVector Class - Extreme.Mathematics

public abstract class ComplexVector : IFormattable, 
	IList<DoubleComplex>, ICollection<DoubleComplex>, IEnumerable<DoubleComplex>, 
	IEnumerable, ICloneable, IStructuralEquatable

Public MustInherit Class ComplexVector
	Implements IFormattable, IList(Of DoubleComplex), 
	ICollection(Of DoubleComplex), IEnumerable(Of DoubleComplex), IEnumerable, 
	ICloneable, IStructuralEquatable

public ref class ComplexVector abstract : IFormattable, 
	IList<DoubleComplex>, ICollection<DoubleComplex>, IEnumerable<DoubleComplex>, 
	IEnumerable, ICloneable, IStructuralEquatable

[<AbstractClassAttribute>]
type ComplexVector =  
    class
        interface IFormattable
        interface IList<DoubleComplex>
        interface ICollection<DoubleComplex>
        interface IEnumerable<DoubleComplex>
        interface IEnumerable
        interface ICloneable
        interface IStructuralEquatable
    end

The ComplexVector type exposes the following members.

Constructors

	Name	Description
	ComplexVector(Int32)	Constructs a new complex vector with the specified number of components.
	ComplexVector(SerializationInfo, StreamingContext)	Constructs a new complex vector from serialization values.

Top

Properties

	Name	Description
	ItemInt32	Gets or sets a specific component of this vector.
	ItemRange	Gets or sets a range of components of the complex vector.
	Length	Gets the number of elements in the complex vector.

Top

Methods

	Name	Description
	Abs	Returns a complex vector whose components are the absolute values of the components of another vector.
	AbsoluteMax	Returns the value of the component in this complex vector that has the largest absolute value.
	AbsoluteMax(ComplexVector)	Returns the largest absolute value of a component of a vector.
	AbsoluteMaxIndex	Returns the index of the component in this complex vector that has the largest absolute value.
	AbsoluteMin	Returns the value of the component in this complex vector that has the smallest absolute value.
	AbsoluteMin(ComplexVector)	Returns the smallest absolute value of a component of a vector.
	AbsoluteMinIndex	Returns the index of the component in this complex vector that has the smallest absolute value.
	Acos	Returns a complex vector whose components are the inverse cosine of the components of another vector.
	Add(ComplexVector)	Adds another ComplexVector to this ComplexVector.
	Add(DoubleComplex)	Adds a constant to a vector.
	Add(ComplexMatrix, ComplexVector)	Adds the product of a ComplexMatrix and a ComplexVector to this ComplexVector.
	Add(ComplexVector, ComplexVector)	Adds two complex vector values.
	Add(DoubleComplex, ComplexVector)	Adds a scaled ComplexVector to this ComplexVector.
	Add(DoubleComplex, ComplexMatrix, ComplexVector)	Adds the scaled product of a ComplexMatrix and a ComplexVector to this ComplexVector.
	Apply(FuncDoubleComplex, DoubleComplex)	Obsolete. Applies a function to the elements of a complex vector.
	Apply(FuncDoubleComplex, DoubleComplex, ComplexVector)	Applies a function to the elements of a complex vector and returns the result in a new vector.
	ApplyInPlace	Applies a function to the elements of a complex vector.
	AsDenseVector	Returns a ComplexDenseVector with the same components as this vector.
	AsGeneralVector	Obsolete. Returns a ComplexDenseVector with the same components as this vector.
	Asin	Returns a complex vector whose components are the inverse sine of the components of another vector.
	Atan	Returns a complex vector whose components are the inverse tangent of the components of another vector.
	Clone	Makes a copy of this complex vector.
	Clone(CloningMethod)	Makes a copy of this complex vector using the specified method.
	CloneData	If possible, gives this instance its own copy of its elements.
	ComponentwiseConjugateMultiply	Obsolete. Multiplies the components of the conjugate of a complex vector by the corresponding components of another vector.
	ComponentwiseDivide(ComplexVector)	Obsolete. Divides the components of this instance by the corresponding components of another vector.
	ComponentwiseDivide(Vector)	Divides the components of this instance by the corresponding components of a real vector.
	ComponentwiseDivide(ComplexVector, ComplexVector)	Obsolete. Divides the components of a complex vector by the corresponding components of another vector.
	ComponentwiseMultiply(ComplexVector)	Obsolete. Multiplies the components of this instance by the corresponding components of another vector.
	ComponentwiseMultiply(Vector)	Obsolete. Multiplies the components of this instance by the corresponding components of a real vector.
	ComponentwiseMultiply(ComplexVector, ComplexVector)	Obsolete. Multiplies the components of a complex vector by the corresponding components of another vector.
	Conjugate	Returns a complex vector whose components are the complex conjugate of this vector's components.
	Convolution	Calculates the convolution of two vectors.
	CopyTo(ComplexVector)	Copies the components of this complex vector to another vector.
	CopyTo(DoubleComplex)	Copies the components of this complex vector to another vector.
	CopyTo(ComplexVector, Int32)	Copies the components of this complex vector to another vector starting at the specified position.
	Cos	Returns a complex vector whose components are the cosines of the components of another vector.
	Cosh	Returns a complex vector whose components are the hyperbolic cosines of the components of another vector.
	Create(Int32)	Constructs a new vector with the specified length.
	Create(DoubleComplex)	Constructs a new vector with the specified components.
	Create(IListDoubleComplex)	Constructs a new vector with the specified components.
	Create(Double, Double)	Constructs a new ComplexDenseVector with the specified components.
	Create(Int32, FuncInt32, DoubleComplex)	Constructs a new ComplexDenseVector.
	Create(DoubleComplex, Boolean)	Constructs a new ComplexDenseVector with the specified components.
	Create(Int32, DoubleComplex, Boolean)	Constructs a new ComplexDenseVector with the specified components.
	Create(Int32, DoubleComplex, Int32, Int32)	Constructs a new ComplexDenseVector.
	CreateConstant	Constructs a new constant vector.
	CrossProduct	Returns the cross product of two 3D vectors.
	CumulativeProduct	Returns a vector containing the cumulative product of the elements of the vector.
	CumulativeSum	Returns a vector containing the cumulative sum of the elements of the vector.
	Divide	Divides a complex vector by a constant.
	DotProduct(ComplexVector)	Returns the dot product of this vector with another vector.
	DotProduct(ComplexVector, ComplexVector)	Returns the dot product of two vectors.
	ElementwiseConjugateMultiply	Multiplies the components of the conjugate of a complex vector by the corresponding components of another vector.
	ElementwiseDivide	Divides the components of a complex vector by the corresponding components of another vector.
	ElementwiseDivideInPlace	Divides the components of this instance by the corresponding components of another vector.
	ElementwiseMultiply	Multiplies the components of a complex vector by the corresponding components of another vector.
	ElementwiseMultiplyInPlace(ComplexVector)	Multiplies the components of this instance by the corresponding components of another vector.
	ElementwiseMultiplyInPlace(Vector)	Multiplies the components of this instance by the corresponding components of a real vector.
	Equals(Object)	Determines whether the specified Object is equal to the current ComplexVector. (Overrides ObjectEquals(Object).)
	Equals(Object, IEqualityComparer)	Returns whether an object is structurally equal to this instance.
	Exp	Returns a complex vector whose components are the exponential of the components of another vector.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FourierTransform	Returns the Fourier transform of a vector.
	GetAmplitude	Returns a vector containing the amplitude (modulus) of each component of this vector.
	GetComponents	Obsolete. Gets the components of the complex vector.
	GetEnumerator	Returns a IEnumeratorT that enumerates the elements of the vector.
	GetHashCode	Returns the hash code for this instance. (Overrides ObjectGetHashCode.)
	GetHashCode(IEqualityComparer)	Returns a hash code for this instance.
	GetImaginaryPart	Returns a real vector containing the imaginary elements of the vector.
	GetObjectData	Populates a SerializationInfo with the values needed to serialize the target object.
	GetPhase	Returns a vector containing the phase (argument) of each component of this vector.
	GetProduct	Gets the product of the elements of the vector.
	GetRealPart	Returns a real vector containing the real elements of the vector.
	GetSubvector(Range)	Returns a vector whose components are a subset of the components of this instance
	GetSubvector(Int32, Int32)	Returns a vector whose components are a subset of the components of this instance
	GetSubvector(Int32, Int32, Int32)	Returns a vector whose components are a subset of the components of this instance
	GetSum	Gets the sum of the elements of the vector.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Gets the vector component at the specified position.
	InverseFourierTransform	Returns the inverse Fourier transform of a vector.
	IsComponentWritable	Obsolete. Gets a value indicating whether the value of the component at the specified index can be changed.
	IsElementWritable	Gets a value indicating whether the value of the component at the specified index can be changed.
	Join(ComplexVector)	Joins vectors together to form one large vector.
	Join(ComplexVector, ComplexVector)	Joins two vectors.
	Log(ComplexVector)	Returns a complex vector whose components are the logarithms of the components of another vector.
	Log(ComplexVector, ComplexVector)	Returns a complex vector whose components are the logarithms of the components of another vector.
	Log(ComplexVector, DoubleComplex)	Returns a complex vector whose components are the logarithms of the components of another vector.
	Log10	Returns a complex vector whose components are the base 10 logarithms of the components of another vector.
	Max	Returns the value of the largest component of a vector.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Min	Returns the value of the smallest component of a vector.
	Multiply(ComplexMatrix)	Multiplies the vector on the left by a matrix.
	Multiply(DoubleComplex)	Multiplies a vector by a given factor.
	Multiply(ComplexMatrix, MatrixOperationSide)	Multiplies a ComplexVector by a ComplexMatrix.
	Multiply(DoubleComplex, ComplexVector)	Multiplies a complex vector by a constant.
	Negate	Negates a complex vector.
	Norm	Returns the two-norm of the complex vector.
	Norm(Double)	Returns the norm of the specified order of this complex vector.
	Norm(Int32)	Returns the norm of the specified order of this complex vector.
	Normalize	Scales the complex vector to make its two-norm equal to one.
	NormInternal(Double)	Returns the norm of the specified order of this complex vector.
	NormInternal(Int32)	Returns the norm of the specified order of this complex vector.
	NormSquared	Returns the square of the two-norm of this complex vector.
	OneNorm	Returns the one-norm of this complex vector.
	Permute(Permutation)	Permutes a vector.
	Permute(ComplexVector, Permutation)	Permutes a vector.
	Permute(Permutation, Boolean)	Permutes a vector.
	Pow(ComplexVector, DoubleComplex)	Returns a complex vector whose components are the components of another vector raised to the specified power.
	Pow(ComplexVector, Int32)	Returns a complex vector whose components are the components of another vector raised to the specified power.
	Product	Returns the product of the components of a vector.
	Project	Returns the projection of one vector onto another.
	Reciprocal	Returns a complex vector whose components are the inverses (reciprocals) of the components of another vector.
	SetValue(DoubleComplex)	Sets all the components of the complex vector to the specified value.
	SetValue(DoubleComplex, Int32)	Sets the vector component at the specified position to the specified value.
	ShallowCopy	Makes a shallow copy of this complex vector.
	Sin	Returns a complex vector whose components are the sines of the components of another vector.
	Sinh	Returns a complex vector whose components are the hyperbolic sines of the components of another vector.
	Sqrt	Returns a complex vector whose components are the square roots of the components of another vector.
	Subtract(ComplexVector)	Subtracts another ComplexVector from this ComplexVector.
	Subtract(ComplexMatrix, ComplexVector)	Subtracts the product of a ComplexMatrix and a ComplexVector from this ComplexVector.
	Subtract(ComplexVector, ComplexVector)	Subtracts two complex vector values.
	Sum	Returns the sum of the components of a vector.
	Swap	Swaps the elements of two vectors.
	SwapElements	Exchanges two elements of the vector.
	Tan	Returns a complex vector whose components are the tangents of the components of another vector.
	Tanh	Returns a complex vector whose components are the hyperbolic tangents of the components of another vector.
	ToArray	Gets the components of the complex vector.
	ToConjugate	Changes the elements of the vector to their complex conjugate.
	ToDenseVector	Makes a copy of this instance and returns it as a ComplexDenseVector.
	ToGeneralVector	Obsolete. Makes a copy of this instance and returns it as a ComplexDenseVector.
	ToString	Returns a String representation of this ComplexVector. (Overrides ObjectToString.)
	ToString(String)	Converts the numeric value of this complex vector instance to its equivalent string representation, using the specified format.
	ToString(String, IFormatProvider)	Returns a String representation of this ComplexDenseMatrix.
	ToStringInternal	Writes a string representation of this ComplexVector to an instance of StringBuilder using the specified number format.
	Zero	Sets all the components of the complex vector to 0.

Top

Operators

	Name	Description
	Addition	Adds two complex vector values.
	Division	Divides a complex vector by a constant.
	Equality	Returns a value indicating whether two instances of complex vector are equal.
	Inequality	Returns a value indicating whether two instances of complex vector are not equal.
	Multiply(ComplexVector, DoubleComplex)	Multiplies a complex vector by a constant.
	Multiply(DoubleComplex, ComplexVector)	Multiplies a complex vector by a constant.
	Subtraction	Subtracts two complex vector values.
	UnaryNegation	Negates a complex vector.

Top

Extension Methods

	Name	Description
	GroupDoubleComplex	Overloaded. Returns a grouping by the unique elements in a list. (Defined by Grouping.)
	GroupDoubleComplex	Overloaded. Returns a grouping by the unique elements in a sequence. (Defined by Grouping.)
	GroupDoubleComplex(IEqualityComparerDoubleComplex)	Overloaded. Returns a grouping by the unique elements in a list using the specified comparer to determine equality. (Defined by Grouping.)
	GroupDoubleComplex(IEqualityComparerDoubleComplex)	Overloaded. Returns a grouping by the unique elements in a sequence using the specified comparer to determine equality. (Defined by Grouping.)
	SumDoubleComplex	Overloaded. Computes the sum of the sequence of values. (Defined by ArrayMath.)
	SumDoubleComplex, U(FuncDoubleComplex, U)	Overloaded. Computes the sum of the sequence of values that are obtained by invoking a transform function on each element of the input sequence. (Defined by ArrayMath.)

Top

Remarks

The ComplexVector class represents a one-dimensional array of DoubleComplex precision floating-point numbers.

The ComplexVector class provides methods and properties for all the common operations on vectors, including norms, dot products, as well as retrieving extreme values from a vector.

Overloaded versions of the major arithmetic operators are provided for languages that support them. For languages that don't support operator overloading, equivalent methods are supplied.

To allow for greater efficiency, overloaded instance methods are available for many compound operations on vectors.

Version Information

Numerical Libraries

Supported in: 5.x, 4.x

Reference

Extreme.Mathematics Namespace

Inheritance Hierarchy

SystemObject
  Extreme.MathematicsComplexVector
    Extreme.Mathematics.LinearAlgebra.ComplexComplexBandVector
    Extreme.Mathematics.LinearAlgebra.ComplexComplexConstantVector
    Extreme.Mathematics.LinearAlgebra.ComplexComplexDenseVector
    Extreme.Mathematics.LinearAlgebra.ComplexComplexVectorView
    Extreme.Mathematics.LinearAlgebra.ComplexComposedComplexVector
    Extreme.Mathematics.SignalProcessingComplexConjugateSignalVector

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2021, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.