ComplexArray Type

A set of array utilities for complex number arrays

Static members

Static member Description

ComplexArray.Clamp(array, minimum, maximum)

Full Usage: ComplexArray.Clamp(array, minimum, maximum)

Parameters:

Clamp elements in the complex array to range [minimum,maximum]

array : Complex[]

minimum : Complex

maximum : Complex

ComplexArray.ClampLength(array, fMinimum, fMaximum)

Full Usage: ComplexArray.ClampLength(array, fMinimum, fMaximum)

Parameters:
    array : Complex[] -
    fMinimum : float -
    fMaximum : float -

Clamp length (modulus) of the elements in the complex array

array : Complex[]

fMinimum : float

fMaximum : float

ComplexArray.ClampToRealUnit(array)

Full Usage: ComplexArray.ClampToRealUnit(array)

Parameters:

Clamp elements in the complex array to real unit range (i.e. [0,1])

array : Complex[]

ComplexArray.Copy(dest, source)

Full Usage: ComplexArray.Copy(dest, source)

Parameters:

Copy an array

dest : Complex[]

source : Complex[]

ComplexArray.Copy(dest, source)

Full Usage: ComplexArray.Copy(dest, source)

Parameters:

Copy an array

dest : ComplexFloat[]

source : ComplexFloat[]

ComplexArray.Divide(target, rhs)

Full Usage: ComplexArray.Divide(target, rhs)

Parameters:

Divide each element in target array with corresponding element in rhs array

target : Complex[]

rhs : Complex[]

ComplexArray.Divide(lhs, rhs, result)

Full Usage: ComplexArray.Divide(lhs, rhs, result)

Parameters:

Divide each element in lhs array with corresponding element in rhs array and put product in result array

lhs : Complex[]

rhs : Complex[]

result : Complex[]

ComplexArray.Divide(target, rhs)

Full Usage: ComplexArray.Divide(target, rhs)

Parameters:

Divide each element in target array with corresponding element in rhs array

target : ComplexFloat[]

rhs : ComplexFloat[]

ComplexArray.Divide(lhs, rhs, result)

Full Usage: ComplexArray.Divide(lhs, rhs, result)

Parameters:

Divide each element in lhs array with corresponding element in rhs array and put product in result array

lhs : ComplexFloat[]

rhs : ComplexFloat[]

result : ComplexFloat[]

ComplexArray.GetLengthRange(array, minimum, maximum)

Full Usage: ComplexArray.GetLengthRange(array, minimum, maximum)

Parameters:
    array : Complex[] -
    minimum : byref<float> -
    maximum : byref<float> -

Get the range of element lengths

array : Complex[]

minimum : byref<float>

maximum : byref<float>

ComplexArray.GetLengthRange(array, minimum, maximum)

Full Usage: ComplexArray.GetLengthRange(array, minimum, maximum)

Parameters:
    array : ComplexFloat[] -
    minimum : byref<float32> -
    maximum : byref<float32> -

Get the range of element lengths

array : ComplexFloat[]

minimum : byref<float32>

maximum : byref<float32>

ComplexArray.Invert(array)

Full Usage: ComplexArray.Invert(array)

Parameters:

Invert each element in the array

array : Complex[]

ComplexArray.Invert(array)

Full Usage: ComplexArray.Invert(array)

Parameters:

Invert each element in the array

array : ComplexFloat[]

ComplexArray.IsEqual(array1, array2, tolerance)

Full Usage: ComplexArray.IsEqual(array1, array2, tolerance)

Parameters:
Returns: bool

Determine whether the elements in the two arrays are the same

array1 : Complex[]

array2 : Complex[]

tolerance : float

Returns: bool

ComplexArray.IsEqual(array1, array2, tolerance)

Full Usage: ComplexArray.IsEqual(array1, array2, tolerance)

Parameters:
Returns: bool

Determine whether the elements in the two arrays are the same

array1 : ComplexFloat[]

array2 : ComplexFloat[]

tolerance : float32

Returns: bool

ComplexArray.Multiply(target, rhs)

Full Usage: ComplexArray.Multiply(target, rhs)

Parameters:

Multiply each element in target array with corresponding element in rhs array

target : Complex[]

rhs : Complex[]

ComplexArray.Multiply(lhs, rhs, result)

Full Usage: ComplexArray.Multiply(lhs, rhs, result)

Parameters:

Multiply each element in lhs array with corresponding element in rhs array and put product in result array

lhs : Complex[]

rhs : Complex[]

result : Complex[]

ComplexArray.Multiply(target, rhs)

Full Usage: ComplexArray.Multiply(target, rhs)

Parameters:

Multiply each element in target array with corresponding element in rhs array

target : ComplexFloat[]

rhs : ComplexFloat[]

ComplexArray.Multiply(lhs, rhs, result)

Full Usage: ComplexArray.Multiply(lhs, rhs, result)

Parameters:

Multiply each element in lhs array with corresponding element in rhs array and put product in result array

lhs : ComplexFloat[]

rhs : ComplexFloat[]

result : ComplexFloat[]

ComplexArray.Normalize(array)

Full Usage: ComplexArray.Normalize(array)

Parameters:

Scale and offset the elements in the array so that the overall range is [0, 1]

array : Complex[]

ComplexArray.Normalize(array)

Full Usage: ComplexArray.Normalize(array)

Parameters:

Scale and offset the elements in the array so that the overall range is [0, 1]

array : ComplexFloat[]

ComplexArray.Offset(array, offset)

Full Usage: ComplexArray.Offset(array, offset)

Parameters:
    array : Complex[] -
    offset : float -

Add a specific value to each element in the array

array : Complex[]

offset : float

ComplexArray.Offset(array, offset)

Full Usage: ComplexArray.Offset(array, offset)

Parameters:

Add a specific value to each element in the array

array : Complex[]

offset : Complex

ComplexArray.Offset(array, offset)

Full Usage: ComplexArray.Offset(array, offset)

Parameters:

Add a specific value to each element in the array

array : ComplexFloat[]

offset : float32

ComplexArray.Offset(array, offset)

Full Usage: ComplexArray.Offset(array, offset)

Parameters:

Add a specific value to each element in the array

array : ComplexFloat[]

offset : ComplexFloat

ComplexArray.Reverse(array)

Full Usage: ComplexArray.Reverse(array)

Parameters:

Reverse the elements in the array

array : Complex[]

ComplexArray.Scale(array, scale)

Full Usage: ComplexArray.Scale(array, scale)

Parameters:
    array : Complex[] -
    scale : float -

Multiply each element in the array by a specific value

array : Complex[]

scale : float

ComplexArray.Scale(array, scale, start, length)

Full Usage: ComplexArray.Scale(array, scale, start, length)

Parameters:
    array : Complex[] -
    scale : float -
    start : int -
    length : int -

Multiply each element in the array by a specific value

array : Complex[]

scale : float

start : int

length : int

ComplexArray.Scale(array, scale)

Full Usage: ComplexArray.Scale(array, scale)

Parameters:

Multiply each element in the array by a specific value

array : Complex[]

scale : Complex

ComplexArray.Scale(array, scale, start, length)

Full Usage: ComplexArray.Scale(array, scale, start, length)

Parameters:

Multiply each element in the array by a specific value

array : Complex[]

scale : Complex

start : int

length : int

ComplexArray.Scale(array, scale)

Full Usage: ComplexArray.Scale(array, scale)

Parameters:

Multiply each element in the array by a specific value

array : ComplexFloat[]

scale : float32

ComplexArray.Scale(array, scale, start, length)

Full Usage: ComplexArray.Scale(array, scale, start, length)

Parameters:
    array : ComplexFloat[] -
    scale : float32 -
    start : int -
    length : int -

Multiply each element in the array by a specific value

array : ComplexFloat[]

scale : float32

start : int

length : int

ComplexArray.Scale(array, scale)

Full Usage: ComplexArray.Scale(array, scale)

Parameters:

Multiply each element in the array by a specific value

array : ComplexFloat[]

scale : ComplexFloat

ComplexArray.Scale(array, scale, start, length)

Full Usage: ComplexArray.Scale(array, scale, start, length)

Parameters:

Multiply each element in the array by a specific value

array : ComplexFloat[]

scale : ComplexFloat

start : int

length : int

ComplexArray.Shift(array, offset)

Full Usage: ComplexArray.Shift(array, offset)

Parameters:
    array : Complex[] -
    offset : int -

Shift (offset) the elements in the array

array : Complex[]

offset : int

ComplexArray.Shift(array, offset)

Full Usage: ComplexArray.Shift(array, offset)

Parameters:

Shift (offset) the elements in the array

array : ComplexFloat[]

offset : int