SignalMath.AutoCorrelate Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.0.0

Overload List

AutoCorrelate<T>(Vector<T>, ConvolutionMode)	Computes the autocorrelation of a real-valued vector and returns the result.
AutoCorrelate<T>(Vector<Complex<T>>, ConvolutionMode)	Computes the autocorrelation of a complex-valued vector and returns the result.
AutoCorrelate<T>(ReadOnlySpan<T>, Span<T>, ConvolutionMode)	Computes the autocorrelation of a real signal.
AutoCorrelate<T>(ReadOnlySpan<Complex<T>>, Span<Complex<T>>, ConvolutionMode)	Computes the autocorrelation of a complex signal.
AutoCorrelate<T>(Vector<T>, Vector<T>, ConvolutionMode)	Computes the autocorrelation of a real-valued vector.
AutoCorrelate<T>(Vector<Complex<T>>, Vector<Complex<T>>, ConvolutionMode)	Computes the autocorrelation of a complex-valued vector.
AutoCorrelate<T>(Int32, ReadOnlySpan<T>, Int32, Int32, Span<T>, Int32, ConvolutionMode)	Computes the autocorrelation of a real signal.
AutoCorrelate<T>(Int32, ReadOnlySpan<Complex<T>>, Int32, Int32, Span<Complex<T>>, Int32, ConvolutionMode)	Computes the autocorrelation of a complex signal.

AutoCorrelate<T>(Vector<T>, ConvolutionMode)

Computes the autocorrelation of a real-valued vector and returns the result.

public static Vector<T> AutoCorrelate<T>(
	Vector<T> x,
	ConvolutionMode shape = ConvolutionMode.FullLength
)

Visual Basic

Public Shared Function AutoCorrelate(Of T) ( 
	x As Vector(Of T),
	Optional shape As ConvolutionMode = ConvolutionMode.FullLength
) As Vector(Of T)

C++/CLI

public:
generic<typename T>
static Vector<T>^ AutoCorrelate(
	Vector<T>^ x, 
	ConvolutionMode shape = ConvolutionMode::FullLength
)

static member AutoCorrelate : 
        x : Vector<'T> * 
        ?shape : ConvolutionMode 
(* Defaults:
        let _shape = defaultArg shape ConvolutionMode.FullLength
*)
-> Vector<'T>

Parameters

x Vector<T>: The input signal vector.
shape ConvolutionMode (Optional): The output shape mode.

Type Parameters

T: The element type (double or float).

Return Value

Vector<T>
A vector containing the autocorrelation result.

Exceptions

ArgumentNullException

Thrown when x is null.

AutoCorrelate<T>(Vector<Complex<T>>, ConvolutionMode)

Computes the autocorrelation of a complex-valued vector and returns the result.

public static Vector<Complex<T>> AutoCorrelate<T>(
	Vector<Complex<T>> x,
	ConvolutionMode shape = ConvolutionMode.FullLength
)

Visual Basic

Public Shared Function AutoCorrelate(Of T) ( 
	x As Vector(Of Complex(Of T)),
	Optional shape As ConvolutionMode = ConvolutionMode.FullLength
) As Vector(Of Complex(Of T))

C++/CLI

public:
generic<typename T>
static Vector<Complex<T>>^ AutoCorrelate(
	Vector<Complex<T>>^ x, 
	ConvolutionMode shape = ConvolutionMode::FullLength
)

static member AutoCorrelate : 
        x : Vector<Complex<'T>> * 
        ?shape : ConvolutionMode 
(* Defaults:
        let _shape = defaultArg shape ConvolutionMode.FullLength
*)
-> Vector<Complex<'T>>

Parameters

x Vector<Complex<T>>: The input signal vector.
shape ConvolutionMode (Optional): The output shape mode.

Type Parameters

T: The element type (double or float).

Return Value

Vector<Complex<T>>
A vector containing the autocorrelation result.

Exceptions

ArgumentNullException

Thrown when x is null.

AutoCorrelate<T>(ReadOnlySpan<T>, Span<T>, ConvolutionMode)

Computes the autocorrelation of a real signal.

public static void AutoCorrelate<T>(
	ReadOnlySpan<T> x,
	Span<T> result,
	ConvolutionMode shape = ConvolutionMode.FullLength
)

Visual Basic

Public Shared Sub AutoCorrelate(Of T) ( 
	x As ReadOnlySpan(Of T),
	result As Span(Of T),
	Optional shape As ConvolutionMode = ConvolutionMode.FullLength
)

C++/CLI

public:
generic<typename T>
static void AutoCorrelate(
	ReadOnlySpan<T> x, 
	Span<T> result, 
	ConvolutionMode shape = ConvolutionMode::FullLength
)

static member AutoCorrelate : 
        x : ReadOnlySpan<'T> * 
        result : Span<'T> * 
        ?shape : ConvolutionMode 
(* Defaults:
        let _shape = defaultArg shape ConvolutionMode.FullLength
*)
-> unit

Parameters

x ReadOnlySpan<T>: The input signal.
result Span<T>: The output span to hold the autocorrelation result.
shape ConvolutionMode (Optional): The output shape mode.

Type Parameters

T: The element type (double or float).

Exceptions

ArgumentException

Thrown when the result span is too small for the requested output shape.

AutoCorrelate<T>(ReadOnlySpan<Complex<T>>, Span<Complex<T>>, ConvolutionMode)

Computes the autocorrelation of a complex signal.

public static void AutoCorrelate<T>(
	ReadOnlySpan<Complex<T>> x,
	Span<Complex<T>> result,
	ConvolutionMode shape = ConvolutionMode.FullLength
)

Visual Basic

Public Shared Sub AutoCorrelate(Of T) ( 
	x As ReadOnlySpan(Of Complex(Of T)),
	result As Span(Of Complex(Of T)),
	Optional shape As ConvolutionMode = ConvolutionMode.FullLength
)

C++/CLI

public:
generic<typename T>
static void AutoCorrelate(
	ReadOnlySpan<Complex<T>> x, 
	Span<Complex<T>> result, 
	ConvolutionMode shape = ConvolutionMode::FullLength
)

static member AutoCorrelate : 
        x : ReadOnlySpan<Complex<'T>> * 
        result : Span<Complex<'T>> * 
        ?shape : ConvolutionMode 
(* Defaults:
        let _shape = defaultArg shape ConvolutionMode.FullLength
*)
-> unit

Parameters

x ReadOnlySpan<Complex<T>>: The input signal.
result Span<Complex<T>>: The output span to hold the autocorrelation result.
shape ConvolutionMode (Optional): The output shape mode.

Type Parameters

T: The element type (double or float).

Exceptions

ArgumentException

Thrown when the result span is too small for the requested output shape.

AutoCorrelate<T>(Vector<T>, Vector<T>, ConvolutionMode)

Computes the autocorrelation of a real-valued vector.

public static void AutoCorrelate<T>(
	Vector<T> x,
	Vector<T> output,
	ConvolutionMode shape = ConvolutionMode.FullLength
)

Visual Basic

Public Shared Sub AutoCorrelate(Of T) ( 
	x As Vector(Of T),
	output As Vector(Of T),
	Optional shape As ConvolutionMode = ConvolutionMode.FullLength
)

C++/CLI

public:
generic<typename T>
static void AutoCorrelate(
	Vector<T>^ x, 
	Vector<T>^ output, 
	ConvolutionMode shape = ConvolutionMode::FullLength
)

static member AutoCorrelate : 
        x : Vector<'T> * 
        output : Vector<'T> * 
        ?shape : ConvolutionMode 
(* Defaults:
        let _shape = defaultArg shape ConvolutionMode.FullLength
*)
-> unit

Parameters

x Vector<T>: The input signal vector.
output Vector<T>: The output vector to hold the autocorrelation result.
shape ConvolutionMode (Optional): The output shape mode.

Type Parameters

T: The element type (double or float).

Exceptions

ArgumentNullException	Thrown when x or output is null.
ArgumentException	Thrown when the output vector length does not match the expected size for the given shape.

AutoCorrelate<T>(Vector<Complex<T>>, Vector<Complex<T>>, ConvolutionMode)

Computes the autocorrelation of a complex-valued vector.

public static void AutoCorrelate<T>(
	Vector<Complex<T>> x,
	Vector<Complex<T>> output,
	ConvolutionMode shape = ConvolutionMode.FullLength
)

Visual Basic

Public Shared Sub AutoCorrelate(Of T) ( 
	x As Vector(Of Complex(Of T)),
	output As Vector(Of Complex(Of T)),
	Optional shape As ConvolutionMode = ConvolutionMode.FullLength
)

C++/CLI

public:
generic<typename T>
static void AutoCorrelate(
	Vector<Complex<T>>^ x, 
	Vector<Complex<T>>^ output, 
	ConvolutionMode shape = ConvolutionMode::FullLength
)

static member AutoCorrelate : 
        x : Vector<Complex<'T>> * 
        output : Vector<Complex<'T>> * 
        ?shape : ConvolutionMode 
(* Defaults:
        let _shape = defaultArg shape ConvolutionMode.FullLength
*)
-> unit

Parameters

x Vector<Complex<T>>: The input signal vector.
output Vector<Complex<T>>: The output vector to hold the autocorrelation result.
shape ConvolutionMode (Optional): The output shape mode.

Type Parameters

T: The element type (double or float).

Exceptions

ArgumentNullException	Thrown when x or output is null.
ArgumentException	Thrown when the output vector length does not match the expected size for the given shape.

AutoCorrelate<T>(Int32, ReadOnlySpan<T>, Int32, Int32, Span<T>, Int32, ConvolutionMode)

Computes the autocorrelation of a real signal.

public static void AutoCorrelate<T>(
	int xLength,
	ReadOnlySpan<T> x,
	int xStride,
	int resultLength,
	Span<T> result,
	int resultStride,
	ConvolutionMode shape = ConvolutionMode.FullLength
)

Visual Basic

Public Shared Sub AutoCorrelate(Of T) ( 
	xLength As Integer,
	x As ReadOnlySpan(Of T),
	xStride As Integer,
	resultLength As Integer,
	result As Span(Of T),
	resultStride As Integer,
	Optional shape As ConvolutionMode = ConvolutionMode.FullLength
)

C++/CLI

public:
generic<typename T>
static void AutoCorrelate(
	int xLength, 
	ReadOnlySpan<T> x, 
	int xStride, 
	int resultLength, 
	Span<T> result, 
	int resultStride, 
	ConvolutionMode shape = ConvolutionMode::FullLength
)

static member AutoCorrelate : 
        xLength : int * 
        x : ReadOnlySpan<'T> * 
        xStride : int * 
        resultLength : int * 
        result : Span<'T> * 
        resultStride : int * 
        ?shape : ConvolutionMode 
(* Defaults:
        let _shape = defaultArg shape ConvolutionMode.FullLength
*)
-> unit

Parameters

xLength Int32: The number of elements in the signal.
x ReadOnlySpan<T>: The input signal.
xStride Int32: The stride between successive elements in x.
resultLength Int32: The number of elements in the result.
result Span<T>: The output span to hold the autocorrelation result.
resultStride Int32: The stride between successive elements in result.
shape ConvolutionMode (Optional): The output shape mode.

Type Parameters

T: The element type (double or float).

Exceptions

ArgumentException

Thrown when the result span is too small for the requested output shape.

AutoCorrelate<T>(Int32, ReadOnlySpan<Complex<T>>, Int32, Int32, Span<Complex<T>>, Int32, ConvolutionMode)

Computes the autocorrelation of a complex signal.

public static void AutoCorrelate<T>(
	int xLength,
	ReadOnlySpan<Complex<T>> x,
	int xStride,
	int resultLength,
	Span<Complex<T>> result,
	int resultStride,
	ConvolutionMode shape = ConvolutionMode.FullLength
)

Visual Basic

Public Shared Sub AutoCorrelate(Of T) ( 
	xLength As Integer,
	x As ReadOnlySpan(Of Complex(Of T)),
	xStride As Integer,
	resultLength As Integer,
	result As Span(Of Complex(Of T)),
	resultStride As Integer,
	Optional shape As ConvolutionMode = ConvolutionMode.FullLength
)

C++/CLI

public:
generic<typename T>
static void AutoCorrelate(
	int xLength, 
	ReadOnlySpan<Complex<T>> x, 
	int xStride, 
	int resultLength, 
	Span<Complex<T>> result, 
	int resultStride, 
	ConvolutionMode shape = ConvolutionMode::FullLength
)

static member AutoCorrelate : 
        xLength : int * 
        x : ReadOnlySpan<Complex<'T>> * 
        xStride : int * 
        resultLength : int * 
        result : Span<Complex<'T>> * 
        resultStride : int * 
        ?shape : ConvolutionMode 
(* Defaults:
        let _shape = defaultArg shape ConvolutionMode.FullLength
*)
-> unit

Parameters

xLength Int32: The number of elements in the signal.
x ReadOnlySpan<Complex<T>>: The input signal.
xStride Int32: The stride between successive elements in x.
resultLength Int32: The number of elements in the result.
result Span<Complex<T>>: The output span to hold the autocorrelation result.
resultStride Int32: The stride between successive elements in result.
shape ConvolutionMode (Optional): The output shape mode.

Type Parameters

T: The element type (double or float).

Exceptions

ArgumentException

Thrown when the result span is too small for the requested output shape.

SignalMath.AutoCorrelate Method

Definition

Overload List

AutoCorrelate<T>(Vector<T>, ConvolutionMode)

Parameters

Type Parameters

Return Value

Exceptions

AutoCorrelate<T>(Vector<Complex<T>>, ConvolutionMode)

Parameters

Type Parameters

Return Value

Exceptions

AutoCorrelate<T>(ReadOnlySpan<T>, Span<T>, ConvolutionMode)

Parameters

Type Parameters

Exceptions

AutoCorrelate<T>(ReadOnlySpan<Complex<T>>, Span<Complex<T>>, ConvolutionMode)

Parameters

Type Parameters

Exceptions

AutoCorrelate<T>(Vector<T>, Vector<T>, ConvolutionMode)

Parameters

Type Parameters

Exceptions

AutoCorrelate<T>(Vector<Complex<T>>, Vector<Complex<T>>, ConvolutionMode)

Parameters

Type Parameters

Exceptions

AutoCorrelate<T>(Int32, ReadOnlySpan<T>, Int32, Int32, Span<T>, Int32, ConvolutionMode)

Parameters

Type Parameters

Exceptions

AutoCorrelate<T>(Int32, ReadOnlySpan<Complex<T>>, Int32, Int32, Span<Complex<T>>, Int32, ConvolutionMode)

Parameters

Type Parameters

Exceptions

See Also

Reference