vDSP Reference

Framework	Accelerate/vecLib
Declared in	vDSP.h vDSP_translate.h

Overview

This document describes the vDSP portion of the Accelerate framework. The vDSP header provides a number of functions related to digital signal processing, including:

Vector and matrix arithmetic
Fourier transforms
Convolution, correlation, and window generation

For an overview that describes how to use these routines, read vDSP Programming Guide.

Functions by Task

Single-Vector Absolute Value

The functions in this group compute the absolute value of each element in a vector.

Single-Vector Negation

The functions in this group negates each element in a vector.

Single-Vector Fill or Clear

The functions in this group fills each element in a vector with a specific value or clears each element.

Single-Vector Generation

The functions in this group build vectors with specific generator functions.

Single-Vector Squaring

The functions in this group computes the square of each element in a vector or the square of the magnitude of each element in a complex vector.

Single-Vector Polar-Rectangular Conversion

The functions in this group convert each element in a vector between rectangular and polar coordinates.

Single-Vector Conversion to Decibel Equivalents

The functions in this group convert power or amplitude values to decibel values.

Single-Vector Fractional Part Extraction

The functions in this group remove the whole-number part of each element in a vector, leaving the fractional part.

Single-Vector Complex Conjugation

The functions in this group find the complex conjugate of values in a vector.

Single-Vector Phase Computation

The functions in this group compute the phase values of each element in a complex vector.

Single-Vector Clipping, Limit, and Threshold Operations

The functions in this group restrict the values in a vector so that they fall within a given range or invert values outside a given range.

Single-Vector Compression

The functions in this group compress the values of a vector.

Single-Vector Gathering

The functions in this group use either indices or pointers stored within one source vector to generate a new vector containing the chosen elements from either a second source vector or from memory.

Single-Vector Reversing

The functions in this group reverse the order of the elements in a vector.

Single-Vector Copying

The functions in this group copy one vector to another vector.

Single-Vector Zero Crossing Search

The functions in this group find a specified number of zero crossings, returning the last crossing found and the number of crossings found.

Single-Vector Operations: Linear Averaging

The functions in this group take a vector that contains the linear averages of values from other vectors and adds an additional vector into those averages.

Single-Vector Linear Interpolation

The functions in this group calculate the linear interpolation between neighboring elements.

Single-Vector Integration

The functions in this group perform integration on the values in a vector.

Single-Vector Sorting

The functions in this group find sort the values in a vector.

Single-Vector Sliding-Window Summing

The functions in this group calculates a sliding-window sum for a vector.

Single-Vector Precision Conversion

The functions in this group convert between single-precision and double-precision floating-point vectors.

Single-Vector Floating-Point to Integer Conversion

The functions in this group convert the values in a vector from floating-point values to integer values of a given size.

Single-Vector Integer to Floating-Point Conversion

The functions in this group convert integer values of a given size to floating-point vectors.

Vector-Scalar Addition

These functions add a scalar to each element of a vector.

Vector-Scalar Division

These functions divide each element of a vector by a scalar.

Vector-Scalar Multiplication

These functions multiply a scalar by each element of a vector.

Vector-Scalar Multiply and Add

These functions multiply a scalar with each element of a vector, then add another scalar.

Vector-to-Vector Real Vector Basic Arithmetic

Vector-to-Vector Integer Arithmetic

Vector-to-Vector Complex Vector Basic Arithmetic

Vector-to-Vector Maxima and Minima

Vector-to-Vector Distance Computation

Vector-to-Vector Interpolation

Vector-to-Vector Polynomial Evaluation

Vector-to-Vector Pythagoras Computation

The functions in this group apply Pythagoras’s theorem to vectors.

Vector-to-Vector Extrema Finding

Vector-to-Vector Element Swapping

Vector-to-Vector Merging

Vector-to-Vector Spectra Computation

Vector-to-Vector Coherence Function Computation

Vector-to-Vector Transfer Function Computation

Vector-to-Vector Recursive Filtering on Real Vectors

Calculating Dot Products

Finding Maximums

Finding Minimums

Calculating Means

Summing Vectors

Matrix Multiplication (Real Matrices)

The functions in this group multiply two matrices.

Matrix Transposition

Matrix and Submatrix Copying

1D Fast Fourier Transforms (Support Functions)

1D Fast Fourier Transforms (In-Place Real)

1D Fast Fourier Transforms (Out-of-Place Real)

1D Fast Fourier Transforms (In-Place Complex)

1D Fast Fourier Transforms (Out-of-Place Complex)

1D Fast Fourier Transforms (Fixed Length)

2D Fast Fourier Transforms (In-Place Complex)

2D Fast Fourier Transforms (Out-of-Place Complex)

2D Fast Fourier Transforms (In-Place Real)

2D Fast Fourier Transforms (Out-of-Place Real)

Discrete Fourier Transforms

These functions calculate a discrete Fourier transform of a specified length on a vector.

Correlation and Convolution

These functions perform correlation and convolution operations on real or complex signals in vDSP.

Windowing and Filtering

This section describes the C API for performing filtering operations on real or complex signals in vDSP. It also describes the built-in support for windowing functions such as Blackman, Hamming, and Hann windows.

Complex Vector Conversion

These functions convert complex vectors between interleaved and split forms.

Legacy APIs

This section includes old APIs that have been renamed to be more consistent. It provides links from the old symbol names to the preferred names.

These symbols exist solely on 32-bit OS X architectures. They do not exist in iOS, nor on 64-bit architectures in OS X.

Legacy Macros

On 32-bit PowerPC and i386 architectures, the functions listed in “Legacy APIs” are actual symbols, and the recommended replacements for those functions are actually macros that translate the preferred names to the legacy names listed in “Legacy APIs.”

On 64-bit architectures in OS X, these macros are not defined. In iOS, these macros are not defined.

Functions

conv

Deprecated. Use vDSP_conv instead.

void conv (
   const float __vDSP_signal[],
   vDSP_Stride __vDSP_signalStride,
   const float __vDSP_filter[],
   vDSP_Stride __vDSP_strideFilter,
   float __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_lenResult,
   vDSP_Length __vDSP_lenFilter
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

convD

Deprecated. Use vDSP_convD instead.

void convD (
   const double __vDSP_signal[],
   vDSP_Stride __vDSP_signalStride,
   const double __vDSP_filter[],
   vDSP_Stride __vDSP_strideFilter,
   double __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_lenResult,
   vDSP_Length __vDSP_lenFilter
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

create_fftsetup

Deprecated. Use vDSP_create_fftsetup instead.

FFTSetup create_fftsetup (
   vDSP_Length __vDSP_log2n,
   FFTRadix __vDSP_radix
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

create_fftsetupD

Deprecated. Use vDSP_create_fftsetupD instead.

FFTSetupD create_fftsetupD (
   vDSP_Length __vDSP_log2n,
   FFTRadix __vDSP_radix
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

ctoz

Deprecated. Use vDSP_ctoz instead.

void ctoz (
   const DSPComplex __vDSP_C[],
   vDSP_Stride __vDSP_strideC,
   DSPSplitComplex *__vDSP_Z,
   vDSP_Stride __vDSP_strideZ,
   vDSP_Length __vDSP_size
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

ctozD

Deprecated. Use vDSP_ctozD instead.

void ctozD (
   const DSPDoubleComplex __vDSP_C[],
   vDSP_Stride __vDSP_strideC,
   DSPDoubleSplitComplex *__vDSP_Z,
   vDSP_Stride __vDSP_strideZ,
   vDSP_Length __vDSP_size
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

destroy_fftsetup

Deprecated. Use vDSP_destroy_fftsetup instead.

void destroy_fftsetup (
   FFTSetup __vDSP_setup
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

destroy_fftsetupD

Deprecated. Use vDSP_destroy_fftsetupD instead.

void destroy_fftsetupD (
   FFTSetupD __vDSP_setup
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

dotpr

Deprecated. Use vDSP_dotpr instead.

void dotpr (
   const float __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const float __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   float *__vDSP_result,
   vDSP_Length __vDSP_size
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

dotprD

Deprecated. Use vDSP_dotprD instead.

void dotprD (
   const double __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const double __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   double *__vDSP_result,
   vDSP_Length __vDSP_size
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

f3x3

Deprecated. Use vDSP_f3x3 instead.

void f3x3 (
   float *__vDSP_signal,
   vDSP_Length __vDSP_rows,
   vDSP_Length __vDSP_cols,
   float *__vDSP_filter,
   float *__vDSP_result
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

f3x3D

Deprecated. Use vDSP_f3x3D instead.

void f3x3D (
   double *__vDSP_signal,
   vDSP_Length __vDSP_rows,
   vDSP_Length __vDSP_cols,
   double *__vDSP_filter,
   double *__vDSP_result
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

f5x5

Deprecated. Use vDSP_f5x5 instead.

void f5x5 (
   float *__vDSP_signal,
   vDSP_Length __vDSP_rows,
   vDSP_Length __vDSP_cols,
   float *__vDSP_filter,
   float *__vDSP_result
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

f5x5D

Deprecated. Use vDSP_f5x5D instead.

void f5x5D (
   double *__vDSP_signal,
   vDSP_Length __vDSP_rows,
   vDSP_Length __vDSP_cols,
   double *__vDSP_filter,
   double *__vDSP_result
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zip

Deprecated. Use vDSP_fft2d_zip instead.

void fft2d_zip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zipD

Deprecated. Use vDSP_fft2d_zipD instead.

void fft2d_zipD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zipt

Deprecated. Use vDSP_fft2d_zipt instead.

void fft2d_zipt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_ziptD

Deprecated. Use vDSP_fft2d_ziptD instead.

void fft2d_ziptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zop

Deprecated. Use vDSP_fft2d_zop instead.

void fft2d_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zopD

Deprecated. Use vDSP_fft2d_zopD instead.

void fft2d_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zopt

Deprecated. Use vDSP_fft2d_zopt instead.

void fft2d_zopt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zoptD

Deprecated. Use vDSP_fft2d_zoptD instead.

void fft2d_zoptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zrip

Deprecated. Use vDSP_fft2d_zrip instead.

void fft2d_zrip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zripD

Deprecated. Use vDSP_fft2d_zripD instead.

void fft2d_zripD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zript

Deprecated. Use vDSP_fft2d_zript instead.

void fft2d_zript (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zriptD

Deprecated. Use vDSP_fft2d_zriptD instead.

void fft2d_zriptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zrop

Deprecated. Use vDSP_fft2d_zrop instead.

void fft2d_zrop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zropD

Deprecated. Use vDSP_fft2d_zropD instead.

void fft2d_zropD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_Kr,
   vDSP_Stride __vDSP_Kc,
   DSPDoubleSplitComplex *__vDSP_ioData2,
   vDSP_Stride __vDSP_Ir,
   vDSP_Stride __vDSP_Ic,
   vDSP_Length __vDSP_log2nc,
   vDSP_Length __vDSP_log2nr,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zropt

Deprecated. Use vDSP_fft2d_zropt instead.

void fft2d_zropt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft2d_zroptD

Deprecated. Use vDSP_fft2d_zroptD instead.

void fft2d_zroptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_Kr,
   vDSP_Stride __vDSP_Kc,
   DSPDoubleSplitComplex *__vDSP_ioData2,
   vDSP_Stride __vDSP_Ir,
   vDSP_Stride __vDSP_Ic,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2nc,
   vDSP_Length __vDSP_log2nr,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft3_zop

Deprecated. Use vDSP_fft3_zop instead.

void fft3_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft3_zopD

Deprecated. Use vDSP_fft3_zopD instead.

void fft3_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_K,
   DSPDoubleSplitComplex *__vDSP_ioData2,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft5_zop

Deprecated. Use vDSP_fft5_zop instead.

void fft5_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft5_zopD

Deprecated. Use vDSP_fft5_zopD instead.

void fft5_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_K,
   DSPDoubleSplitComplex *__vDSP_ioData2,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zip

Deprecated. Use vDSP_fftm_zip instead.

void fftm_zip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zipD

Deprecated. Use vDSP_fftm_zipD instead.

void fftm_zipD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zipt

Deprecated. Use vDSP_fftm_zipt instead.

void fftm_zipt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_ziptD

Deprecated. Use vDSP_fftm_ziptD instead.

void fftm_ziptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zop

Deprecated. Use vDSP_fftm_zop instead.

void fftm_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zopD

Deprecated. Use vDSP_fftm_zopD instead.

void fftm_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zopt

Deprecated. Use vDSP_fftm_zopt instead.

void fftm_zopt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   DSPSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zoptD

Deprecated. Use vDSP_fftm_zoptD instead.

void fftm_zoptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zrip

Deprecated. Use vDSP_fftm_zrip instead.

void fftm_zrip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zripD

Deprecated. Use vDSP_fftm_zripD instead.

void fftm_zripD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zript

Deprecated. Use vDSP_fftm_zript instead.

void fftm_zript (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zriptD

Deprecated. Use vDSP_fftm_zriptD instead.

void fftm_zriptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zrop

Deprecated. Use vDSP_fftm_zrop instead.

void fftm_zrop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zropD

Deprecated. Use vDSP_fftm_zropD instead.

void fftm_zropD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zropt

Deprecated. Use vDSP_fftm_zropt instead.

void fftm_zropt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   DSPSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fftm_zroptD

Deprecated. Use vDSP_fftm_zroptD instead.

void fftm_zroptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zip

Deprecated. Use vDSP_fft_zip instead.

void fft_zip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zipD

Deprecated. Use vDSP_fft_zipD instead.

void fft_zipD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zipt

Deprecated. Use vDSP_fft_zipt instead.

void fft_zipt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_ziptD

Deprecated. Use vDSP_fft_ziptD instead.

void fft_ziptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zop

Deprecated. Use vDSP_fft_zop instead.

void fft_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zopD

Deprecated. Use vDSP_fft_zopD instead.

void fft_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zopt

Deprecated. Use vDSP_fft_zopt instead.

void fft_zopt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zoptD

Deprecated. Use vDSP_fft_zoptD instead.

void fft_zoptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zrip

Deprecated. Use vDSP_fft_zrip instead.

void fft_zrip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zripD

Deprecated. Use vDSP_fft_zripD instead.

void fft_zripD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zript

Deprecated. Use vDSP_fft_zript instead.

void fft_zript (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zriptD

Deprecated. Use vDSP_fft_zriptD instead.

void fft_zriptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zrop

Deprecated. Use vDSP_fft_zrop instead.

void fft_zrop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zropD

Deprecated. Use vDSP_fft_zropD instead.

void fft_zropD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zropt

Deprecated. Use vDSP_fft_zropt instead.

void fft_zropt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

fft_zroptD

Deprecated. Use vDSP_fft_zropD instead.

void fft_zroptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

imgfir

Deprecated. Use vDSP_imgfir instead.

void imgfir (
   float *__vDSP_signal,
   vDSP_Length __vDSP_numRow,
   vDSP_Length __vDSP_numCol,
   float *__vDSP_filter,
   float *__vDSP_result,
   vDSP_Length __vDSP_fnumRow,
   vDSP_Length __vDSP_fnumCol
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

imgfirD

Deprecated. Use vDSP_imgfirD instead.

void imgfirD (
   double *__vDSP_signal,
   vDSP_Length __vDSP_numRow,
   vDSP_Length __vDSP_numCol,
   double *__vDSP_filter,
   double *__vDSP_result,
   vDSP_Length __vDSP_fnumRow,
   vDSP_Length __vDSP_fnumCol
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

mmul

Deprecated. Use vDSP_mmul instead.

void mmul (
   float *__vDSP_a,
   vDSP_Stride __vDSP_aStride,
   float *__vDSP_b,
   vDSP_Stride __vDSP_bStride,
   float *__vDSP_c,
   vDSP_Stride __vDSP_cStride,
   vDSP_Length __vDSP_M,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_P
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

mmulD

Deprecated. Use vDSP_mmulD instead.

void mmulD (
   double *__vDSP_a,
   vDSP_Stride __vDSP_aStride,
   double *__vDSP_b,
   vDSP_Stride __vDSP_bStride,
   double *__vDSP_c,
   vDSP_Stride __vDSP_cStride,
   vDSP_Length __vDSP_M,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_P
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

mtrans

Deprecated. Use vDSP_mtrans instead.

void mtrans (
   float *__vDSP_a,
   vDSP_Stride __vDSP_aStride,
   float *__vDSP_c,
   vDSP_Stride __vDSP_cStride,
   vDSP_Length __vDSP_M,
   vDSP_Length __vDSP_N
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

mtransD

Deprecated. Use vDSP_mtransD instead.

void mtransD (
   double *__vDSP_a,
   vDSP_Stride __vDSP_aStride,
   double *__vDSP_c,
   vDSP_Stride __vDSP_cStride,
   vDSP_Length __vDSP_M,
   vDSP_Length __vDSP_N
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

vadd

Deprecated. Use vDSP_vadd instead.

void vadd (
   const float __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const float __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   float __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

vaddD

Deprecated. Use vDSP_vaddD instead.

void vaddD (
   const double __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const double __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   double __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

vam

Deprecated. Use vDSP_vam instead.

void vam (
   const float __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const float __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   const float __vDSP_input3[],
   vDSP_Stride __vDSP_stride3,
   float __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Availability

Available in OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

vamD

Deprecated. Use vDSP_vamD instead.

void vamD (
   const double __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const double __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   const double __vDSP_input3[],
   vDSP_Stride __vDSP_stride3,
   double __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Availability

Available in OS X v10.2 and later.
Not available to 64-bit applications.

Declared In

vDSP.h

vDSP_blkman_window

Creates a single-precision Blackman window.

void vDSP_blkman_window (
   float *__vDSP_C,
   vDSP_Length __vDSP_N,
   int __vDSP_FLAG
);

Parameters

__vDSP_C: Output vector C.
__vDSP_N: The desired window length.
__vDSP_FLAG: Pass the vDSP_HALF_WINDOW flag to create only the first (n+1)/2 points, or 0 (zero) for a full-size window.

Discussion

Represented in pseudo-code, this function does the following:

for (n=0; n < N; ++n)

    C[n] = 0.42 - (0.5 * cos(  2 * pi * n / N ) ) +(0.08 * cos( 4 * pi * n / N) );

vDSP_blkman_window creates a single-precision Blackman window function C, which can be multiplied by a vector using vDSP_vmul.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_blkman_windowD

Creates a double-precision Blackman window.

void vDSP_blkman_windowD (
   double *__vDSP_C,
   vDSP_Length __vDSP_N,
   int __vDSP_FLAG
);

Parameters

__vDSP_C: Output vector C.
__vDSP_N: The desired window length.
__vDSP_FLAG: Pass the vDSP_HALF_WINDOW flag to create only the first (n+1)/2 points, or 0 (zero) for a full-size window.

Discussion

Represented in pseudo-code, this function does the following:

for (n=0; n < N; ++n)

    C[n] = 0.42 - (0.5 * cos(  2 * pi * n / N ) ) +(0.08 * cos( 4 * pi * n / N) );

vDSP_blkman_windowD creates a double-precision Blackman window function C, which can be multiplied by a vector using vDSP_vmulD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_conv

Performs either correlation or convolution on two vectors; single precision.

void vDSP_conv (
   const float __vDSP_signal[],
   vDSP_Stride __vDSP_signalStride,
   const float __vDSP_filter[],
   vDSP_Stride __vDSP_strideFilter,
   float __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_lenResult,
   vDSP_Length __vDSP_lenFilter
);

Parameters

__vDSP_signal: Input vector A. The length of this vector must be at least __vDSP_lenResult + __vDSP_lenFilter - 1.
__vDSP_signalStride: The stride through __vDSP_signal.
__vDSP_filter: Input vector B.
__vDSP_strideFilter: The stride through __vDSP_filter.
__vDSP_result: Output vector C.
__vDSP_strideResult: The stride through __vDSP_result.
__vDSP_lenResult: The length of __vDSP_result.
__vDSP_lenFilter: The length of __vDSP_filter.

Discussion

where A is __vDSP_signal, B is __vDSP_filter, C is , I is __vDSP_signalStride, J is __vDSP_strideFilter, K is __vDSP_strideResult, N is __vDSP_lenResult, and P is __vDSP_lenFilter.

If __vDSP_strideFilter is positive, vDSP_conv performs correlation. If __vDSP_strideFilter is negative, it performs convolution and *filter must point to the last vector element. The function can run in place, but result cannot be in place with filter.

Availability

Available in OS X v10.4 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_conv

Translation macro from vDSP_conv to conv.

#define vDSP_conv conv

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_convD

Performs either correlation or convolution on two vectors; double precision.

void vDSP_convD (
   const double __vDSP_signal[],
   vDSP_Stride __vDSP_signalStride,
   const double __vDSP_filter[],
   vDSP_Stride __vDSP_strideFilter,
   double __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_lenResult,
   vDSP_Length __vDSP_lenFilter
);

Parameters

__vDSP_signal: Input vector A. The length of this vector must be at least __vDSP_lenResult + __vDSP_lenFilter - 1.
__vDSP_signalStride: The stride through __vDSP_signal.
__vDSP_filter: Input vector B.
__vDSP_strideFilter: The stride through __vDSP_filter.
__vDSP_result: Output vector C.
__vDSP_strideResult: The stride through __vDSP_result.
__vDSP_lenResult: The length of __vDSP_result.
__vDSP_lenFilter: The length of __vDSP_filter.

Discussion

where A is __vDSP_signal, B is __vDSP_filter, C is , I is __vDSP_signalStride, J is __vDSP_strideFilter, K is __vDSP_strideResult, N is __vDSP_lenResult, and P is __vDSP_lenFilter.

If __vDSP_strideFilter is positive, vDSP_convD performs correlation. If __vDSP_strideFilter is negative, it performs convolution and *filter must point to the last vector element. The function can run in place, but result cannot be in place with filter.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_convD

Translation macro from vDSP_convD to convD.

#define vDSP_convD convD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_create_fftsetup

Builds a data structure that contains precalculated data for use by single-precision FFT functions.

FFTSetup vDSP_create_fftsetup (
   vDSP_Length __vDSP_log2n,
   FFTRadix __vDSP_radix
);

Parameters

__vDSP_log2n: A base 2 exponent that represents the number of divisions of the complex unit circle and thus specifies the largest power of two that can be processed by a subsequent frequency-domain function. Parameter log2n must equal or exceed the largest power of 2 that any subsequent function processes using the weights array.
__vDSP_radix: Specifies radix options. Radix 2, radix 3, and radix 5 functions are supported.

Return Value

Returns an FFTSetup structure for use with one-dimensional FFT functions. Returns 0 on error.

Discussion

This function returns a filled-in FFTSetup data structure for use by FFT functions that operate on single-precision vectors. Once prepared, the setup structure can be used repeatedly by FFT functions (which read the data in the structure and do not alter it) for any (power of two) length up to that specified when you created the structure.

If an application performs FFTs with diverse lengths, the calls with different lengths can share a single setup structure (created for the longest length), and this saves space over having multiple structures. However, in some cases, notably single-precision FFTs on 32-bit PowerPC, an FFT routine may perform faster if it is passed a setup structure that was created specifically for the length of the transform.

Parameter log2n is a base-two exponent and specifies that the largest transform length that can processed using the resulting setup structure is 2**log2n (or 3*2**log2n or 5*2**log2n if the appropriate flags are passed, as discussed below). That is, the log2n parameter must equal or exceed the value passed to any subsequent FFT routine using the setup structure returned by this routine.

Parameter radix specifies radix options. Its value may be the bitwise OR of any combination of kFFTRadix2, kFFTRadix3, or kFFTRadix5. The resulting setup structure may be used with any of the routines for which the respective flag was used. (The radix-3 and radix-5 FFT routines have "fft3" and "fft5" in their names. The radix-2 FFT routines have plain "fft" in their names.)

If zero is returned, the routine failed to allocate storage.

The setup structure is deallocated by calling vDSP_destroy_fftsetup.

Use vDSP_create_fftsetup during initialization. It is relatively slow compared to the routines that actually perform FFTs. Never use it in a part of an application that needs to be high performance.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Declared In

vDSP.h

vDSP_create_fftsetup

Translation macro from vDSP_create_fftsetup to create_fftsetup.

#define vDSP_create_fftsetup create_fftsetup

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_create_fftsetupD

Builds a data structure that contains precalculated data for use by double-precision FFT functions.

FFTSetupD vDSP_create_fftsetupD (
   vDSP_Length __vDSP_log2n,
   FFTRadix __vDSP_radix
);

Parameters

__vDSP_log2n: A base 2 exponent that represents the number of divisions of the complex unit circle and thus specifies the largest power of two that can be processed by a subsequent frequency-domain function. Parameter log2n must equal or exceed the largest power of 2 that any subsequent function processes using the weights array.
__vDSP_radix: Specifies radix options. Radix 2, radix 3, and radix 5 functions are supported.

Return Value

Returns an FFTSetupD structure for use with FFT functions, or 0 if there was an error.

Discussion

This function returns a filled-in FFTSetupD data structure for use by FFT functions that operate on double-precision vectors. Once prepared, the setup structure can be used repeatedly by FFT functions (which read the data in the structure and do not alter it) for any (power of two) length up to that specified when you created the structure.

Parameter radix specifies radix options. Its value may be the bitwise OR of any combination of kFFTRadix2, kFFTRadix3, or kFFTRadix5. The resulting setup structure may be used with any of the routines for which the respective flag was used. (The radix-3 and radix-5 FFT routines have fft3 and fft5 in their names. The radix-2 FFT routines have plain fft in their names.)

If zero is returned, the routine failed to allocate storage.

The setup structure is deallocated by calling vDSP_destroy_fftsetupD.

Use vDSP_create_fftsetupD during initialization. It is relatively slow compared to the routines that actually perform FFTs. Never use it in a part of an application that needs to be high performance.

Availability

Available in OS X v10.4 and later.

Related Sample Code

OpenCL_FFT

Declared In

vDSP.h

vDSP_create_fftsetupD

Translation macro from vDSP_create_fftsetupD to create_fftsetupD.

#define vDSP_create_fftsetupD create_fftsetupD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_ctoz

Copies the contents of an interleaved complex vector C to a split complex vector Z; single precision.

void vDSP_ctoz (
   const DSPComplex __vDSP_C[],
   vDSP_Stride __vDSP_strideC,
   DSPSplitComplex *__vDSP_Z,
   vDSP_Stride __vDSP_strideZ,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_C: Input vector C.
__vDSP_strideC: Stride length in __vDSP_C.
__vDSP_Z: Output vector Z.
__vDSP_strideZ: Stride length in __vDSP_Z.
__vDSP_size: Length

Discussion

This performs the following operations:

The strideC parameter contains an address stride through C. strideZ is an address stride through Z. The value of strideC must be a multiple of 2.

For best performance, __vDSP_C, __vDSP_Z.realp, and __vDSP_Z.imagp should be 16-byte aligned.

See also functionsvDSP_ztoc and vDSP_ztocD.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Declared In

vDSP.h

vDSP_ctoz

Translation macro from vDSP_ctoz to ctoz.

#define vDSP_ctoz ctoz

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_ctozD

Copies the contents of an interleaved complex vector C to a split complex vector Z; double precision.

void vDSP_ctozD (
   const DSPDoubleComplex __vDSP_C[],
   vDSP_Stride __vDSP_strideC,
   DSPDoubleSplitComplex *__vDSP_Z,
   vDSP_Stride __vDSP_strideZ,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_C: Input vector C.
__vDSP_strideC: Stride length in __vDSP_C.
__vDSP_Z: Output vector Z.
__vDSP_strideZ: Stride length in __vDSP_Z.
__vDSP_size: Length

Discussion

This performs the following operation:

The strideC parameter contains an address stride through C. strideZ is an address stride through Z. The value of strideC must be a multiple of 2.

For best performance, __vDSP_C, __vDSP_Z.realp, and __vDSP_Z.imagp should be 16-byte aligned.

See also functions vDSP_ztoc and vDSP_ztocD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_ctozD

Translation macro from vDSP_ctozD to ctozD.

#define vDSP_ctozD ctozD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_deq22

Difference equation, 2 poles, 2 zeros; single precision.

void vDSP_deq22 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector; must have at least N+2 elements
__vDSP_I: Stride for A
__vDSP_B: 5 single-precision inputs, filter coefficients
__vDSP_C: Single-precision real output vector; must have at least N+2 elements
__vDSP_K: Stride for C
__vDSP_N: Number of new output elements to produce

Discussion

Performs two-pole two-zero recursive filtering on real input vector A. Since the computation is recursive, the first two elements in vector C must be initialized prior to calling vDSP_deq22. vDSP_deq22 creates N new values for vector C beginning with its third element and requires at least N+2 input values from vector A. This function can only be done out of place.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_deq22D

Difference equation, 2 poles, 2 zeros; double precision.

void vDSP_deq22D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector; must have at least N+2 elements
__vDSP_I: Stride for A
__vDSP_B: 5 double-precision inputs, filter coefficients
__vDSP_C: Double-precision real output vector; must have at least N+2 elements
__vDSP_K: Stride for C
__vDSP_N: Number of new output elements to produce

Discussion

Performs two-pole two-zero recursive filtering on real input vector A. Since the computation is recursive, the first two elements in vector C must be initialized prior to calling vDSP_deq22D. vDSP_deq22D creates N new values for vector C beginning with its third element and requires at least N+2 input values from vector A. This function can only be done out of place.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_desamp

Convolution with decimation; single precision.

void vDSP_desamp (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   float *__vDSP_C,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_M
);

Parameters

__vDSP_A: Single-precision real input vector, 8-byte aligned; length of A >= 12
__vDSP_I: Desampling factor
__vDSP_B: Single-precision input filter coefficients
__vDSP_C: Single-precision real output vector
__vDSP_N: Output count
__vDSP_M: Filter coefficient count

Discussion

Performs finite impulse response (FIR) filtering at selected positions of vector A. desampx can run in place, but C cannot be in place with B. Length of A must be >=(N-1)*I+(nearest multiple of 4 >=M).

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_desampD

Convolution with decimation; double precision.

void vDSP_desampD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   double *__vDSP_C,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_M
);

Parameters

__vDSP_A: Double-precision real input vector, 8-byte aligned; length of A >= 12
__vDSP_I: Desampling factor
__vDSP_B: Double-precision input filter coefficients
__vDSP_C: Double-precision real output vector
__vDSP_N: Output count
__vDSP_M: Filter coefficient count

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_destroy_fftsetup

Frees an existing single-precision FFT data structure.

void vDSP_destroy_fftsetup (
   FFTSetup __vDSP_setup
);

Parameters

__vDSP_setup: Identifies the weights array, and must point to a data structure previously created by vDSP_create_fftsetup.

Discussion

vDSP_destroy_fftsetup frees an existing weights array. Any memory allocated for the array is released. After the vDSP_destroy_fftsetup function returns, the structure should not be used in any other functions.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Declared In

vDSP.h

vDSP_destroy_fftsetup

Translation macro from vDSP_destroy_fftsetup to destroy_fftsetup.

#define vDSP_destroy_fftsetup destroy_fftsetup

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_destroy_fftsetupD

Frees an existing double-precision FFT data structure.

void vDSP_destroy_fftsetupD (
   FFTSetupD __vDSP_setup
);

Parameters

__vDSP_setup: Identifies the weights array, and must point to a data structure previously created by vDSP_create_fftsetupD.

Discussion

vDSP_destroy_fftsetupD frees an existing weights array. Any memory allocated for the array is released. After the vDSP_destroy_fftsetupD function returns, the structure should not be used in any other functions.

Availability

Available in OS X v10.4 and later.

Related Sample Code

OpenCL_FFT

Declared In

vDSP.h

vDSP_destroy_fftsetupD

Translation macro from vDSP_destroy_fftsetupD to destroy_fftsetupD.

#define vDSP_destroy_fftsetupD destroy_fftsetupD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_DFT_CreateSetup

Deprecated. Use vDSP_DFT_zop_CreateSetup instead.

vDSP_DFT_Setup vDSP_DFT_CreateSetup (
   vDSP_DFT_Setup __vDSP_Previous,
   vDSP_Length __vDSP_Length
);

Discussion

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_DFT_DestroySetup

Releases a setup object.

void vDSP_DFT_DestroySetup (
   vDSP_DFT_Setup __vDSP_Setup
);

Parameters

__vDSP_Setup: The setup object to destroy (as returned by vDSP_DFT_CreateSetup, vDSP_DFT_zop_CreateSetup, or vDSP_DFT_zrop_CreateSetup.

Discussion

If this setup object shares memory with other setup objects, that memory is not released until the last object is destroyed.

Availability

Available in OS X v10.7 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_DFT_Execute

Calculates the discrete Fourier transform for a vector.

void vDSP_DFT_Execute (
   const struct vDSP_DFT_SetupStruct *__vDSP_Setup,
   const float *__vDSP_Ir,
   const float *__vDSP_Ii,
   float *__vDSP_Or,
   float *__vDSP_Oi
);

Parameters

__vDSP_Setup: A DFT setup object returned by a call to vDSP_DFT_zop_CreateSetup or vDSP_DFT_zrop_CreateSetup.
__vDSP_Ir: A vector containing the real part of the input values.
__vDSP_Ii: A vector containing the imaginary part of the input values.
__vDSP_Or: A vector where the real parts of the results is stored on return.
__vDSP_Oi: A vector where the imaginary parts of the results is stored on return.

Discussion

This function calculates either a real or complex discrete Fourier transform, depending on whether the setup object was created with a call to vDSP_DFT_zrop_CreateSetup or vDSP_DFT_zop_CreateSetup.

Availability

Available in OS X v10.7 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_DFT_zop

Calculates the discrete Fourier transform for a vector (single-precision complex).

void vDSP_DFT_zop (
   const struct vDSP_DFT_SetupStruct *__vDSP_Setup,
   const float *__vDSP_Ir,
   const float *__vDSP_Ii,
   vDSP_Stride __vDSP_Is,
   float *__vDSP_Or,
   float *__vDSP_Oi,
   vDSP_Stride __vDSP_Os,
   vDSP_DFT_Direction __vDSP_Direction
);

Parameters

__vDSP_Setup: A DFT setup object returned by a call to vDSP_DFT_zop_CreateSetup.
__vDSP_InputRe: A vector containing the real part of the input values.
__vDSP_InputIm: A vector containing the imaginary part of the input values.
__vDSP_InputStride: Stride length within the input vector. For example, passing 2 would cause every second value to be used.
__vDSP_OutputRe: A vector where the real parts of the results is stored on return.
__vDSP_OutputIm: A vector where the imaginary parts of the results is stored on return.
__vDSP_OutputStride: Stride length within the input vector. For example, passing 2 would cause every second value to be overwritten.
__vDSP_Direction: vDSP_DFT_FORWARD or vDSP_DFT_INVERSE, indicating whether to perform a forward or inverse transform.

Discussion

The input and output vectors may not overlap, with one exception: if the real and imaginary input vectors are both the same as the corresponding output vector, an in-place algorithm is used.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_DFT_zop_CreateSetup

Creates data structures for use with vDSP_DFT_zop and vDSP_DFT_Execute.

vDSP_DFT_Setup vDSP_DFT_zop_CreateSetup (
   vDSP_DFT_Setup __vDSP_Previous,
   vDSP_Length __vDSP_Length,
   vDSP_DFT_Direction __vDSP_Direction
);

Parameters

__vDSP_Previous: A previous result from this function or NULL.
__vDSP_Length: The length of DFT computations with this object.

Return Value

Returns a DFT setup object.

Discussion

This function is designed to share memory between data structures where possible. If you have an existing setup object, you should pass that object as __vDSP_Previous. By doing so, the returned setup object can share underlying data storage with that object.

Availability

Available in OS X v10.7 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_DFT_zrop

Calculates the discrete Fourier transform for a vector (single-precision real).

void vDSP_DFT_zrop(
   vDSP_DFT_Setup __vDSP_Setup,
   const float *__vDSP_InputRe,
   const float *__vDSP_InputIm,
   vDSP_Stride __vDSP_InputStride,
   float *__vDSP_OutputRe,
   float *__vDSP_OutputIm,
   vDSP_Stride __vDSP_OutputStride,
   vDSP_DFT_Direction __vDSP_Direction
);

Parameters

__vDSP_Setup: A DFT setup object returned by a call to vDSP_DFT_zrop_CreateSetup.
__vDSP_InputRe: A vector containing the real part of the input values.
__vDSP_InputIm: A vector containing the imaginary part of the input values.
__vDSP_InputStride: Stride length within the input vector. For example, passing 2 would cause every second value to be used.
__vDSP_OutputRe: A vector where the real parts of the results is stored on return.
__vDSP_OutputIm: A vector where the imaginary parts of the results is stored on return.
__vDSP_OutputStride: Stride length within the input vector. For example, passing 2 would cause every second value to be overwritten.
__vDSP_Direction: vDSP_DFT_FORWARD or vDSP_DFT_INVERSE, indicating whether to perform a forward or inverse transform.

Discussion

The input and output vectors may not overlap unless they are equal, in which case an in-place algorithm is used.

vDSP_DFT_zrop_CreateSetup

Creates data structures for use with vDSP_DFT_Execute.

vDSP_DFT_Setup vDSP_DFT_zrop_CreateSetup (
   vDSP_DFT_Setup __vDSP_Previous,
   vDSP_Length __vDSP_Length,
   vDSP_DFT_Direction __vDSP_Direction
);

Parameters

__vDSP_Previous: An previous result from this function or NULL.
__vDSP_Length: The length of DFT computations with this object.

Return Value

Returns a DFT setup object.

Discussion

Availability

Available in OS X v10.7 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_dotpr

Computes the dot or scalar product of vectors A and B and leaves the result in scalar *C; single precision.

void vDSP_dotpr (
   const float __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const float __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   float *__vDSP_result,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_input1: Input vector A.
__vDSP_stride1: The stride within __vDSP_input1. For example if stride is 2, every second element is used.
__vDSP_input2: Input vector B.
__vDSP_stride2: The stride within __vDSP_input2. For example if stride is 2, every second element is used.
__vDSP_result: The dot product (on return).
__vDSP_size: The number of elements (N).

Discussion

This performs the following operation:

where A is __vDSP_input1, B is __vDSP_input2, C is __vDSP_result, I is __vDSP_stride1, J is __vDSP_stride2, and N is __vDSP_size.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_dotpr

Translation macro from vDSP_dotpr to dotpr.

#define vDSP_dotpr dotpr

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_dotpr2

Stereo variant of vDSP_dotpr.

void vDSP_dotpr2 (
   const float *__vDSP_A0,
   vDSP_Stride __vDSP_A0Stride,
   const float *__vDSP_A1,
   vDSP_Stride __vDSP_A1Stride,
   const float *__vDSP_B,
   vDSP_Stride __vDSP_BStride,
   float *__vDSP_C0,
   float *__vDSP_C1,
   vDSP_Length __vDSP_Length
);

Parameters

__vDSP_A0: Input vector A0.
__vDSP_A0Stride: The stride within vector A0. For example if stride is 2, every second element is used.
__vDSP_A1: Input vector A1.
__vDSP_A1Stride: The stride within vector A1. For example if stride is 2, every second element is used.
__vDSP_B: Input vector B.
__vDSP_BStride: The stride within vector B. For example if stride is 2, every second element is used.
__vDSP_C0: The dot product of A0 and B (on return).
__vDSP_C1: The dot product of A1 and B (on return).
__vDSP_Length: The number of elements.

Discussion

Calculates the dot product of A0 with B, then calculates the dot product of A1 with B. The equation for a single dot product is:

where I is __vDSP_A0Stride or __vDSP_A1Stride, J is __vDSP_BStride, and N is __vDSP_Length.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_dotpr2_s1_15

Vector fixed-point 1.15 format version of vDSP_dotpr2.

void vDSP_dotpr2_s1_15 (
   const short int *__vDSP_A0,
   vDSP_Stride __vDSP_A0Stride,
   const short int *__vDSP_A1,
   vDSP_Stride __vDSP_A1Stride,
   const short int *__vDSP_B,
   vDSP_Stride __vDSP_BStride,
   short int *__vDSP_C0,
   short int *__vDSP_C1,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A0: Input vector A0.
__vDSP_A0Stride: The stride within vector A0. For example if stride is 2, every second element is used.
__vDSP_A1: Input vector A1.
__vDSP_A1Stride: The stride within vector A1. For example if stride is 2, every second element is used.
__vDSP_B: Input vector B.
__vDSP_BStride: The stride within vector B. For example if stride is 2, every second element is used.
__vDSP_C0: The dot product of A0 and B (on return).
__vDSP_C1: The dot product of A1 and B (on return).
__vDSP_Length: The number of elements.

Discussion

Calculates the dot product of A0 with B, then calculates the dot product of A1 with B. The equation for a single dot product is:

where I is __vDSP_A0Stride or __vDSP_A1Stride, J is __vDSP_BStride, and N is __vDSP_Length.

The elements are fixed-point numbers, each with one sign bit and 15 fraction bits. A value in this representation can be converted to floating-point by dividing it by 32768.0.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_dotpr2_s8_24

Vector fixed-point 8.24 format version of vDSP_dotpr2.

void vDSP_dotpr2_s8_24 (
   const int *__vDSP_A0,
   vDSP_Stride __vDSP_A0Stride,
   const int *__vDSP_A1,
   vDSP_Stride __vDSP_A1Stride,
   const int *__vDSP_B,
   vDSP_Stride __vDSP_BStride,
   int *__vDSP_C0,
   int *__vDSP_C1,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A0: Input vector A0.
__vDSP_A0Stride: The stride within vector A0. For example if stride is 2, every second element is used.
__vDSP_A1: Input vector A1.
__vDSP_A1Stride: The stride within vector A1. For example if stride is 2, every second element is used.
__vDSP_B: Input vector B.
__vDSP_BStride: The stride within vector B. For example if stride is 2, every second element is used.
__vDSP_C0: The dot product of A0 and B (on return).
__vDSP_C1: The dot product of A1 and B (on return).
__vDSP_Length: The number of elements.

Discussion

Calculates the dot product of A0 with B, then calculates the dot product of A1 with B. The equation for a single dot product is:

where I is __vDSP_A0Stride or __vDSP_A1Stride, J is __vDSP_BStride, and N is __vDSP_Length.

The elements are fixed-point numbers, each with eight integer bits (including the sign bit) and 24 fraction bits. A value in this representation can be converted to floating-point by dividing it by 16777216.0.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_dotprD

Computes the dot or scalar product of vectors A and B and leaves the result in scalar *C; double precision.

void vDSP_dotprD (
   const double __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const double __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   double *__vDSP_result,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_input1: Input vector A.
__vDSP_stride1: The stride within __vDSP_input1. For example if stride is 2, every second element is used.
__vDSP_input2: Input vector B.
__vDSP_stride2: The stride within __vDSP_input2. For example if stride is 2, every second element is used.
__vDSP_result: The dot product (on return).
__vDSP_size: The number of elements.

Discussion

This performs the following operation:

where A is __vDSP_input1, B is __vDSP_input2, C is __vDSP_result, I is __vDSP_stride1, J is __vDSP_stride2, and N is __vDSP_size.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_dotprD

Translation macro from vDSP_dotprD to dotprD.

#define vDSP_dotprD dotprD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_dotpr_s1_15

Vector fixed-point 1.15 format version of vDSP_dotpr.

void vDSP_dotpr_s1_15 (
   const short int *__vDSP_A,
   vDSP_Stride __vDSP_AStride,
   const short int *__vDSP_B,
   vDSP_Stride __vDSP_BStride,
   short int *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Input vector A.
__vDSP_AStride: The stride within vector A. For example if stride is 2, every second element is used.
__vDSP_B: Input vector B.
__vDSP_BStride: The stride within vector B. For example if stride is 2, every second element is used.
__vDSP_C: The dot product (on return).
__vDSP_N: The number of elements.

Discussion

This performs the following operation:

where I is __vDSP_AStride and J is __vDSP_BStride.

The elements are fixed-point numbers, each with one sign bit and 15 fraction bits. A value in this representation can be converted to floating-point by dividing it by 32768.0.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_dotpr_s8_24

Vector fixed-point 8.24 format version of vDSP_dotpr.

void vDSP_dotpr_s8_24 (
   const int *__vDSP_A,
   vDSP_Stride __vDSP_AStride,
   const int *__vDSP_B,
   vDSP_Stride __vDSP_BStride,
   int *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Input vector A.
__vDSP_AStride: The stride within vector A. For example if stride is 2, every second element is used.
__vDSP_B: Input vector B.
__vDSP_BStride: The stride within vector B. For example if stride is 2, every second element is used.
__vDSP_C: The dot product (on return).
__vDSP_N: The number of elements.

Discussion

This performs the following operation:

where I is __vDSP_AStride and J is __vDSP_BStride.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_f3x3

Filters an image by performing a two-dimensional convolution with a 3x3 kernel; single precision.

void vDSP_f3x3 (
   float *__vDSP_signal,
   vDSP_Length __vDSP_rows,
   vDSP_Length __vDSP_cols,
   float *__vDSP_filter,
   float *__vDSP_result
);

Parameters

__vDSP_signal: Input matrix A.
__vDSP_rows: The number of rows in __vDSP_signal. The value of __vDSP_rows must be greater than or equal to 3.
__vDSP_cols: The number of columns in __vDSP_signal. The value of __vDSP_cols must be even and greater than or equal to 4.
__vDSP_filter: A 3x3 kernel.
__vDSP_result: The result matrix.

Discussion

This function filters an image by performing a two-dimensional convolution with a 3x3 kernel (B) on the input matrix A and storing the resulting image in the output matrix C.

This performs the following operation:

where B is the 3x3 kernel, M and N are the number of rows and columns, respectively, of the two-dimensional input matrix A (from __vDSP_signal), and C is the result matrix.

This function zero-pads the perimeter of the output image with a border of width 1.

The value of __vDSP_rows must be greater than or equal to 3. The value of __vDSP_cols must be even and greater than or equal to 4.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_f3x3

Translation macro from vDSP_f3x3 to f3x3.

#define vDSP_f3x3 f3x3

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_f3x3D

Filters an image by performing a two-dimensional convolution with a 3x3 kernel; double precision.

void vDSP_f3x3D (
   double *__vDSP_signal,
   vDSP_Length __vDSP_rows,
   vDSP_Length __vDSP_cols,
   double *__vDSP_filter,
   double *__vDSP_result
);

Parameters

__vDSP_signal: Input matrix A.
__vDSP_rows: The number of rows in __vDSP_signal. The value of __vDSP_rows must be greater than or equal to 3.
__vDSP_cols: The number of columns in __vDSP_signal. The value of __vDSP_cols must be even and greater than or equal to 4.
__vDSP_filter: A 3x3 kernel.
__vDSP_result: The result matrix.

Discussion

This function filters an image by performing a two-dimensional convolution with a 3x3 kernel on the input matrix A and storing the resulting image in the output matrix C.

This performs the following operation:

where B is the 3x3 kernel, M and N are the number of rows and columns, respectively, of the two-dimensional input matrix A (from __vDSP_signal), and C is the result matrix.

This function zero-pads the perimeter of the output image with a border of width 1.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_f3x3D

Translation macro from vDSP_f3x3D to f3x3D.

#define vDSP_f3x3D f3x3D

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_f5x5

Filters an image by performing a two-dimensional convolution with a 5x5 kernel; single precision.

void vDSP_f5x5 (
   float *__vDSP_signal,
   vDSP_Length __vDSP_rows,
   vDSP_Length __vDSP_cols,
   float *__vDSP_filter,
   float *__vDSP_result
);

Parameters

__vDSP_signal: Input matrix A.
__vDSP_rows: The number of rows in __vDSP_signal. The value of __vDSP_rows must be greater than or equal to 5.
__vDSP_cols: The number of columns in __vDSP_signal. The value of __vDSP_cols must be even and greater than or equal to 6.
__vDSP_filter: A 5x5 kernel.
__vDSP_result: The result matrix.

Discussion

This function filters an image by performing a two-dimensional convolution with a 5x5 kernel (B) on the input matrix A and storing the resulting image in the output matrix C.

This performs the following operation:

where B is the 5x5 kernel, M and N are the number of rows and columns, respectively, of the two-dimensional input matrix A (from __vDSP_signal), and C is the result matrix.

This function zero-pads the perimeter of the output image with a border of width 1.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_f5x5

Translation macro from vDSP_f5x5 to f5x5.

#define vDSP_f5x5 f5x5

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_f5x5D

Filters an image by performing a two-dimensional convolution with a 5x5 kernel; double precision.

void vDSP_f5x5D (
   double *__vDSP_signal,
   vDSP_Length __vDSP_rows,
   vDSP_Length __vDSP_cols,
   double *__vDSP_filter,
   double *__vDSP_result
);

Parameters

__vDSP_signal: Input matrix A.
__vDSP_rows: The number of rows in __vDSP_signal. The value of __vDSP_rows must be greater than or equal to 5.
__vDSP_cols: The number of columns in __vDSP_signal. The value of __vDSP_cols must be even and greater than or equal to 6.
__vDSP_filter: A 5x5 kernel.
__vDSP_result: The result matrix.

Discussion

This function filters an image by performing a two-dimensional convolution with a 5x5 kernel (B) on the input matrix A and storing the resulting image in the output matrix C.

This performs the following operation:

where B is the 5x5 kernel, M and N are the number of rows and columns, respectively, of the two-dimensional input matrix A (from __vDSP_signal), and C is the result matrix.

This function zero-pads the perimeter of the output image with a border of width 1.

The value of __vDSP_rows must be greater than or equal to 5. The value of __vDSP_cols must be even and greater than or equal to 6.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_f5x5D

Translation macro from vDSP_f5x5D to f5x5D.

#define vDSP_f5x5D f5x5D

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_FFT16_copv

Performs a 16-element FFT on interleaved complex data.

void vDSP_FFT16_copv (
   float *__vDSP_Output,
   const float *__vDSP_Input,
   FFTDirection __vDSP_Direction
);

Parameters

__vDSP_Output: A vector-block-aligned output array.
__vDSP_Input: A vector-block-aligned input array.
__vDSP_Direction: kFFTDirection_Forward or kFFTDirection_Inverse, indicating whether to perform a forward or inverse transform.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_FFT16_zopv

Performs a 16-element FFT on split complex data.

void vDSP_FFT16_zopv (
   float *__vDSP_Or,
   float *__vDSP_Oi,
   const float *__vDSP_Ir,
   const float *__vDSP_Ii,
   FFTDirection __vDSP_Direction
);

Parameters

__vDSP_Or: Output vector for real parts.
__vDSP_Oi: Output vector for imaginary parts.
__vDSP_Ir: Input vector for real parts.
__vDSP_Ii: Input vector for imaginary parts.
__vDSP_Direction: kFFTDirection_Forward or kFFTDirection_Inverse, indicating whether to perform a forward or inverse transform.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_fft2d_zip

Computes an in-place single-precision complex discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse).

void vDSP_fft2d_zip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the values supplied as parameters log2nInCol and log2nInRow of this transform function.

__vDSP_ioData

A complex vector input.

__vDSP_strideInRow

Specifies a stride across each row of the matrix signal. Specifying 1 for strideInRow processes every element across each row, specifying 2 processes every other element across each row, and so forth.

__vDSP_strideInCol

Specifies a column stride for the matrix, and should generally be allowed to default unless the matrix is a submatrix. Parameter strideInCol can be defaulted by specifying 0. The default column stride equals the row stride multiplied by the column count. Thus, if strideInRow is 1 and strideInCol is 0, every element of the input /output matrix is processed. If strideInRow is 2 and strideInCol is 0, every other element of each row is processed.

If not 0, parameter strideInCol represents the distance between each row of the matrix. If parameter strideInCol is 1024, for example, complex element 512 of the matrix equates to element (1,0), element 1024 equates to element (2,0), and so forth.

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for parameter log2nInCol and 6 for parameter log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_direction

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of direction.

Discussion

This performs the following operation:

where C is __vDSP_ioData, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_fft2d_zip

Translation macro from vDSP_fft2d_zip to fft2d_zip.

#define vDSP_fft2d_zip fft2d_zip

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zipD

Computes an in-place double-precision complex discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse).

void vDSP_fft2d_zipD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the values supplied as parameters log2nInCol and log2nInRow of this transform function.

__vDSP_ioData

A complex vector input.

__vDSP_strideInRow

__vDSP_strideInCol

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for parameter log2nInCol and 6 for parameter log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_direction

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of direction.

Discussion

This performs the following operation:

where C is __vDSP_ioData, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zipD

Translation macro from vDSP_fft2d_zipD to fft2d_zipD.

#define vDSP_fft2d_zipD fft2d_zipD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zipt

Computes an in-place single-precision complex discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse). A buffer is used for intermediate results.

void vDSP_fft2d_zipt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup

__vDSP_ioData

A complex vector input.

__vDSP_strideInRow

__vDSP_strideInCol

__vDSP_bufferTemp

A temporary matrix used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the lower value of 16,384 bytes or the size of NR * NC elements, where NC is the number of columns (2 raised to log2nInCol) and NR is the number of rows (2 raised to log2nInRow).

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for parameter log2nInCol and 6 for parameter log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_direction

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of direction.

Discussion

This performs the following operation:

where F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zipt

Translation macro from vDSP_fft2d_zipt to fft2d_zipt.

#define vDSP_fft2d_zipt fft2d_zipt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_ziptD

Computes an in-place double-precision complex discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse). A buffer is used for intermediate results.

void vDSP_fft2d_ziptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup

__vDSP_ioData

A complex vector input.

__vDSP_strideInRow

__vDSP_strideInCol

__vDSP_bufferTemp

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for parameter log2nInCol and 6 for parameter log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_direction

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of direction.

Discussion

This performs the following operation:

where C is __vDSP_ioData, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_ziptD

Translation macro from vDSP_fft2d_ziptD to fft2d_ziptD.

#define vDSP_fft2d_ziptD fft2d_ziptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zop

Computes an out-of-place single-precision complex discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse).

void vDSP_fft2d_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

__vDSP_signal

A complex vector signal input.

__vDSP_signalStrideInRow

Specifies a stride across each row of matrix a. Specifying 1 for signalStrideInRow processes every element across each row, specifying 2 processes every other element across each row, and so forth.

__vDSP_signalStrideInCol

If zero, specifies a stride of a single row’s width. If not zero, this parameter represents the distance between each row of the input /output matrix.

__vDSP_result

The complex vector signal output.

__vDSP_strideResultInRow

Specifies a row stride for output matrix result in the same way that signalStrideInRow specifies a stride for input the input /output matrix.

__vDSP_strideResultInCol

Specifies a column stride for output matrix result in the same way that signalStrideInCol specifies a stride for input the input /output matrix.

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

This performs the following operation:

where A is __vDSP_signal, C is __vDSP_result, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_fft2d_zop

Translation macro from vDSP_fft2d_zop to fft2d_zop.

#define vDSP_fft2d_zop fft2d_zop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zopD

Computes an out-of-place double-precision complex discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse).

void vDSP_fft2d_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

__vDSP_signal

A complex vector signal input.

__vDSP_signalStrideInRow

__vDSP_signalStrideInCol

If zero, specifies a stride of a single row’s width. If not zero, this parameter represents the distance between each row of the input /output matrix.

__vDSP_result

The complex vector signal output.

__vDSP_strideResultInRow

Specifies a row stride for output matrix result in the same way that signalStrideInRow specifies a stride for input the input /output matrix.

__vDSP_strideResultInCol

Specifies a column stride for output matrix result in the same way that signalStrideInCol specifies a stride for input the input /output matrix.

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

This performs the following operation:

where A is __vDSP_signal, C is __vDSP_result, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zopD

Translation macro from vDSP_fft2d_zopD to fft2d_zopD.

#define vDSP_fft2d_zopD fft2d_zopD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zopt

Computes an out-of-place single-precision complex discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse). A buffer is used for intermediate results.

void vDSP_fft2d_zopt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

__vDSP_signal

A complex vector signal input.

__vDSP_signalStrideInRow

__vDSP_signalStrideInCol

If zero, specifies a stride of a row width. If not zero, this parameter represents the distance between each row of the input /output matrix. If parameter signalStrideInCol is 1024, for example, element 512 equates to element (1,0) of matrix a, element 1024 equates to element (2,0), and so forth.

__vDSP_result

The complex vector signal output.

__vDSP_strideResultInRow

Specifies a row stride for output matrix result in the same way that signalStrideInRow specifies a stride for input the input /output matrix.

__vDSP_strideResultInCol

Specifies a column stride for output matrix result in the same way that signalStrideInCol specifies a stride for input the input /output matrix.

__vDSP_bufferTemp

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

This performs the following operation:

where A is __vDSP_signal, C is __vDSP_result, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zopt

Translation macro from vDSP_fft2d_zopt to fft2d_zopt.

#define vDSP_fft2d_zopt fft2d_zopt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zoptD

Computes an out-of-place double-precision complex discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse). A buffer is used for intermediate results.

void vDSP_fft2d_zoptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

__vDSP_signal

A complex vector signal input.

__vDSP_signalStrideInRow

__vDSP_signalStrideInCol

__vDSP_result

The complex vector signal output.

__vDSP_strideResultInRow

Specifies a row stride for output matrix result in the same way that signalStrideInRow specifies a stride for input the input /output matrix.

__vDSP_strideResultInCol

Specifies a column stride for output matrix result in the same way that signalStrideInCol specifies a stride for input the input /output matrix.

__vDSP_bufferTemp

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

This performs the following operation:

where A is __vDSP_signal, C is __vDSP_result, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zoptD

Translation macro from vDSP_fft2d_zoptD to fft2d_zoptD.

#define vDSP_fft2d_zoptD fft2d_zoptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zrip

Computes an in-place single-precision real discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse).

void vDSP_fft2d_zrip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the values supplied as parameters log2nInCol and log2nInRow of this transform function.

__vDSP_ioData

A complex vector input.

__vDSP_strideInRow

Specifies a stride across each row of the input matrix signal. Specifying 1 for strideInRow processes every element across each row, specifying 2 processes every other element across each row, and so forth.

__vDSP_strideInCol

If not 0, strideInCol represents the distance between each row of the matrix. If strideInCol is 1024, for example, complex element 512 of the matrix equates to element (1,0), element 1024 equates to element (2,0), and so forth.

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_direction

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of direction.

Discussion

Forward transforms read real input and write packed complex output. Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, spatial-domain data and its equivalent frequency-domain data have the same storage requirements.

where C is __vDSP_ioData, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

Real data is stored in split complex form, with odd reals stored on the imaginary side of the split complex form and even reals stored on the real side.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_fft2d_zrip

Translation macro from vDSP_fft2d_zrip to fft2d_zrip.

#define vDSP_fft2d_zrip fft2d_zrip

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zripD

Computes an in-place double-precision real discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse).

void vDSP_fft2d_zripD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the values supplied as parameters log2nInCol and log2nInRow of this transform function.

__vDSP_signal

A complex vector signal input.

__vDSP_strideInRow

__vDSP_strideInCol

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 2 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 2 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

where C is __vDSP_ioData, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

Real data is stored in split complex form, with odd reals stored on the imaginary side of the split complex form and even reals stored on the real side.

No Altivec/SSE support for double precision. The function always invokes scalar code.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zripD

Translation macro from vDSP_fft2d_zripD to fft2d_zripD.

#define vDSP_fft2d_zripD fft2d_zripD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zript

Computes an in-place single-precision real discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse). A buffer is used for intermediate results.

void vDSP_fft2d_zript (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the values supplied as parameters log2nInCol and log2nInRow of this transform function.

__vDSP_ioData

A complex vector input.

__vDSP_strideInRow

__vDSP_strideInCol

__vDSP_bufferTemp

A temporary matrix used for storing interim results. Both the realp and imagp fields in bufferTemp must contain temporary buffers. The size of those buffers must be at least the greater of NR or NC / 2 elements, where NR is the number of rows (2 raised to __vDSP_log2nInRow) and NC is the number of colums (2 raised to __vDSP_log2nInCol).

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 3 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 3 and 10, inclusive.

__vDSP_direction

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of direction.

Discussion

where C is __vDSP_ioData, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

Real data is stored in split complex form, with odd reals stored on the imaginary side of the split complex form and even reals stored on the real side.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zript

Translation macro from vDSP_fft2d_zript to fft2d_zript.

#define vDSP_fft2d_zript fft2d_zript

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zriptD

Computes an in-place double-precision real discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse). A buffer is used for intermediate results.

void vDSP_fft2d_zriptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_strideInRow,
   vDSP_Stride __vDSP_strideInCol,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the values supplied as parameters log2nInCol and log2nInRow of this transform function.

__vDSP_signal

A complex vector signal input.

__vDSP_strideInRow

__vDSP_strideInCol

__vDSP_bufferTemp

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 3 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 3 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

where C is __vDSP_ioData, F is __vDSP_direction, N is two raised to __vDSP_log2nInRow, M is is two raised to __vDSP_log2nInCol, and j is the square root of -1.

Real data is stored in split complex form, with odd reals stored on the imaginary side of the split complex form and even reals stored on the real side.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zriptD

Translation macro from vDSP_fft2d_zriptD to fft2d_zriptD.

#define vDSP_fft2d_zriptD fft2d_zriptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zrop

Computes an out-of-place single-precision real discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse).

void vDSP_fft2d_zrop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n or log2m, whichever is larger, of this transform function.

__vDSP_signal

A complex vector signal input.

__vDSP_signalStrideInRow

Specifies a stride across each row of matrix signal. Specifying 1 for signalStrideInRow processes every element across each row, specifying 2 processes every other element across each row, and so forth.

__vDSP_signalStrideInCol

If zero, specifies a stride of a row width. If not zero, represents the distance between each row of the input /output matrix. If parameter signalStrideInCol is 1024, for example, element 512 equates to element (1,0) of matrix a, element 1024 equates to element (2,0), and so forth.

__vDSP_result

The complex vector signal output.

__vDSP_strideResultInRow

Specifies a row stride for output matrix c in the same way that signalStrideInRow specifies strides for input the matrix.

__vDSP_strideResultInCol

Specifies a column stride for output matrix c in the same way that signalStrideInCol specify strides for input the matrix.

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 3 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 3 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

Real data is stored in split complex form, with odd reals stored on the imaginary side of the split complex form and even reals stored on the real side.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_fft2d_zrop

Translation macro from vDSP_fft2d_zrop to fft2d_zrop.

#define vDSP_fft2d_zrop fft2d_zrop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zropD

Computes an out-of-place double-precision real discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse).

void vDSP_fft2d_zropD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_Kr,
   vDSP_Stride __vDSP_Kc,
   DSPDoubleSplitComplex *__vDSP_ioData2,
   vDSP_Stride __vDSP_Ir,
   vDSP_Stride __vDSP_Ic,
   vDSP_Length __vDSP_log2nc,
   vDSP_Length __vDSP_log2nr,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n or log2m, whichever is larger, of this transform function.

__vDSP_ioData

A complex vector input.

__vDSP_Kr

Specifies a stride across each row of matrix signal. Specifying 1 for Kr processes every element across each row, specifying 2 processes every other element across each row, and so forth.

__vDSP_Kc

If zero, specifies a stride of a row width. If not zero, represents the distance between each row of the input /output matrix. If parameter Kc is 1024, for example, element 512 equates to element (1,0) of matrix a, element 1024 equates to element (2,0), and so forth.

__vDSP_ioData2

The complex vector result.

__vDSP_Ir

Specifies a row stride for output matrix ioData2 in the same way that Kr specifies strides for input the matrix.

__vDSP_Ic

Specifies a column stride for output matrix ioData2 in the same way that Kc specify strides for input matrix ioData.

__vDSP_log2nc

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nc must be between 3 and 10, inclusive.

__vDSP_log2nr

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nc and 6 for log2nr.

PowerPC Architecture Note: On PowerPC-based computers, log2nr must be between 3 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

Real data is stored in split complex form, with odd reals stored on the imaginary side of the split complex form and even reals stored on the real side.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zropD

Translation macro from vDSP_fft2d_zropD to fft2d_zropD.

#define vDSP_fft2d_zropD fft2d_zropD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zropt

Computes an out-of-place single-precision real discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse). A buffer is used for intermediate results.

void vDSP_fft2d_zropt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStrideInRow,
   vDSP_Stride __vDSP_signalStrideInCol,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResultInRow,
   vDSP_Stride __vDSP_strideResultInCol,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2nInCol,
   vDSP_Length __vDSP_log2nInRow,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n or log2m, whichever is larger, of this transform function.

__vDSP_signal

A complex vector signal input.

__vDSP_signalStrideInRow

Specifies a stride across each row of matrix signal. Specifying 1 for signalStrideInRow processes every element across each row, specifying 2 processes every other element across each row, and so forth.

__vDSP_signalStrideInCol

If zero, specifies a stride of a row width. If not zero, represents the distance between each row of matrix signal. If parameter signalStrideInCol is 1024, for example, element 512 equates to element (1,0) of matrix signal, element 1024 equates to element (2,0), and so forth.

__vDSP_result

The complex vector signal output.

__vDSP_strideResultInRow

Specifies a row stride for output matrix result in the same way that signalStrideInRow specifies strides for input matrix result.

__vDSP_strideResultInCol

Specifies a column stride for output matrix c in the same way that signalStrideInCol specify strides for input matrix result.

__vDSP_bufferTemp

__vDSP_log2nInCol

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nInCol must be between 3 and 10, inclusive.

__vDSP_log2nInRow

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nInCol and 6 for log2nInRow.

PowerPC Architecture Note: On PowerPC-based computers, log2nInRow must be between 3 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

Real data is stored in split complex form, with odd reals stored on the imaginary side of the split complex form and even reals stored on the real side.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zropt

Translation macro from vDSP_fft2d_zropt to fft2d_zropt.

#define vDSP_fft2d_zropt fft2d_zropt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft2d_zroptD

Computes an out-of-place double-precision real discrete FFT, either from the spatial domain to the frequency domain (forward) or from the frequency domain to the spatial domain (inverse). A buffer is used for intermediate results.

void vDSP_fft2d_zroptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_Kr,
   vDSP_Stride __vDSP_Kc,
   DSPDoubleSplitComplex *__vDSP_ioData2,
   vDSP_Stride __vDSP_Ir,
   vDSP_Stride __vDSP_Ic,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2nc,
   vDSP_Length __vDSP_log2nr,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup

Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n or log2m, whichever is larger, of this transform function.

__vDSP_ioData

A complex vector input.

__vDSP_Kr

__vDSP_Kc

__vDSP_ioData2

The complex vector result.

__vDSP_Ir

Specifies a row stride for output matrix ioData2 in the same way that Kr specifies strides for input the matrix.

__vDSP_Ic

Specifies a column stride for output matrix ioData2 in the same way that Kc specify strides for input matrix ioData.

__vDSP_temp

__vDSP_log2nc

The base 2 exponent of the number of columns to process for each row.

PowerPC Architecture Note: On PowerPC-based computers, log2nc must be between 3 and 10, inclusive.

__vDSP_log2nr

The base 2 exponent of the number of rows to process. For example, to process 64 rows of 128 columns, specify 7 for log2nc and 6 for log2nr.

PowerPC Architecture Note: On PowerPC-based computers, log2nr must be between 3 and 10, inclusive.

__vDSP_flag

A forward/inverse directional flag, and must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Results are undefined for other values of flag.

Discussion

Real data is stored in split complex form, with odd reals stored on the imaginary side of the split complex form and even reals stored on the real side.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft2d_zroptD

Translation macro from vDSP_fft2d_zroptD to fft2d_zroptD.

#define vDSP_fft2d_zroptD fft2d_zroptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_FFT32_copv

Performs a 32-element FFT on interleaved complex data.

void vDSP_FFT32_copv (
   float *__vDSP_Output,
   const float *__vDSP_Input,
   FFTDirection __vDSP_Direction
);

Parameters

__vDSP_Output: A vector-block-aligned output array.
__vDSP_Input: A vector-block-aligned input array.
__vDSP_Direction: kFFTDirection_Forward or kFFTDirection_Inverse, indicating whether to perform a forward or inverse transform.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_FFT32_zopv

Performs a 32-element FFT on split complex data.

void vDSP_FFT32_zopv (
   float *__vDSP_Or,
   float *__vDSP_Oi,
   const float *__vDSP_Ir,
   const float *__vDSP_Ii,
   FFTDirection __vDSP_Direction
);

Parameters

__vDSP_Or: Output vector for real parts.
__vDSP_Oi: Output vector for imaginary parts.
__vDSP_Ir: Input vector for real parts.
__vDSP_Ii: Input vector for imaginary parts.
__vDSP_Direction: kFFTDirection_Forward or kFFTDirection_Inverse, indicating whether to perform a forward or inverse transform.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_fft3_zop

Computes an out-of-place radix-3 complex Fourier transform, either forward or inverse. The number of input and output values processed equals 3 times the power of 2 specified by parameter log2n; single precision.

void vDSP_fft3_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: A setup object as returned by a call to vDSP_create_fftsetup. kFFTRadix3 must be specified in the call to vDSP_create_fftsetup. setup is preserved for reuse.
__vDSP_signal: A complex vector signal input.
Note: The input data may be modified.
__vDSP_signalStride: Specifies an address stride through the input vector signal. To process every element of the vector, specify 1 for parameter signalStride; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride for the result. The value of resultStride should be 1 for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. log2n must be between 3 and 15, inclusive.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_flag, C is __vDSP_signal, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft3_zop

Translation macro from vDSP_fft3_zop to fft3_zop.

#define vDSP_fft3_zop fft3_zop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft3_zopD

void vDSP_fft3_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_K,
   DSPDoubleSplitComplex *__vDSP_ioData2,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: A setup object as returned by a call to vDSP_create_fftsetupD. kFFTRadix3 must be specified in the call to vDSP_create_fftsetupD. setup is preserved for reuse.
__vDSP_ioData: A complex vector input.
Note: The input data may be modified.
__vDSP_K: Specifies an address stride through the input vector __vDSP_ioData. To process every element of the vector, specify 1 for parameter K; to process every other element, specify 2. The value of K should be 1 for best performance.
__vDSP_ioData2: The complex vector result.
__vDSP_L: Specifies an address stride for the result. The value of L should be 1 for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. log2n must be between 3 and 15, inclusive.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_flag, A is __vDSP_ioData, C is __vDSP_ioData2, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft3_zopD

Translation macro from vDSP_fft3_zopD to fft3_zopD.

#define vDSP_fft3_zopD fft3_zopD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft5_zop

Computes an out-of-place radix-5 complex Fourier transform, either forward or inverse. The number of input and output values processed equals 5 times the power of 2 specified by parameter log2n; single precision.

void vDSP_fft5_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: A setup object returned from a previous call to vDSP_create_fftsetup. kFFTRadix5 must be specified in the call to vDSP_create_fftsetup. setup is preserved for reuse.
__vDSP_signal: A complex vector signal input.
Note: The input data may be modified.
__vDSP_signalStride: Specifies an address stride through the input vector signal. To process every element of the vector, specify 1 for parameter signalStride; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride for the result. The value of resultStride should be 1 for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. log2n must be between 3 and 15, inclusive.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_flag, C is __vDSP_ioData, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft5_zop

Translation macro from vDSP_fft5_zop to fft5_zop.

#define vDSP_fft5_zop fft5_zop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft5_zopD

void vDSP_fft5_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_K,
   DSPDoubleSplitComplex *__vDSP_ioData2,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: A setup object returned from a previous call to vDSP_create_fftsetupD. kFFTRadix5 must be specified in the call to vDSP_create_fftsetupD. setup is preserved for reuse.
__vDSP_ioData: A complex vector input.
Note: The input data may be modified.
__vDSP_K: Specifies an address stride through the input vector signal. To process every element of the vector, specify 1 for parameter K; to process every other element, specify 2.
__vDSP_ioData2: The complex vector result.
__vDSP_L: Specifies an address stride for the result.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_flag, A is __vDSP_ioData, C is __vDSP_ioData2, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft5_zopD

Translation macro from vDSP_fft5_zopD to fft5_zopD.

#define vDSP_fft5_zopD fft5_zopD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zip

Performs the same operation as vDSP_fft_zip on multiple signals with a single call.

void vDSP_fftm_zip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector that stores the input and output signal.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n.
__vDSP_numFFT: The number of signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This function performs Discrete Fourier Transforms on multiple input signals using a single call. They will work for input signals of 4 points or greater. Each of the input signals processed by a given call must have the same length and address stride.

The functions compute in-place complex discrete Fourier transforms of the input signals, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zip

Translation macro from vDSP_fftm_zip to fftm_zip.

#define vDSP_fftm_zip fftm_zip

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zipD

Performs the same operation as vDSP_fft_zipD on multiple signals with a single call.

void vDSP_fftm_zipD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector that stores the input and output signal.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n. The value of log2n must be between 2 and 12, inclusive.
__vDSP_numFFT: The number of signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This function performs Discrete Fourier Transforms on multiple signals at once, using a single call. It will work for input signals of 4 points or greater. Each of the input signals processed by a given call must have the same length and address stride.

The function computes in-place complex discrete Fourier transforms of the input signals, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zipD

Translation macro from vDSP_fftm_zipD to fftm_zipD.

#define vDSP_fftm_zipD fftm_zipD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zipt

Performs the same operation as vDSP_fft_zipt on multiple signals with a single call.

void vDSP_fftm_zipt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector that stores the input and output signal.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_temp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is N elements per side (where N is 2 raised to __vDSP_log2n). If possible, temp.realp and temp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n. The value of log2n must be between 2 and 12, inclusive.
__vDSP_numFFT: The number of different input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

The function performs Fourier transforms on a number of different input signals at once, using a single call. It can be used for efficient processing of small input signals (less than 512 points). It will work for input signals of 4 points or greater. Each of the input signals processed by a given call must have the same length and address stride. The input signals are concatenated into a single output vector, the parameter __vDSP_result.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zipt

Translation macro from vDSP_fftm_zipt to fftm_zipt.

#define vDSP_fftm_zipt fftm_zipt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_ziptD

Performs the same operation as vDSP_fft_ziptD on multiple signals with a single call.

void vDSP_fftm_ziptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector that stores the input and output signal.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_temp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is N elements per side (where N is 2 raised to __vDSP_log2n). If possible, temp.realp and temp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n. The value of log2n must be between 2 and 12, inclusive.
__vDSP_numFFT: The number of different input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_ziptD

Translation macro from vDSP_fftm_ziptD to fftm_ziptD.

#define vDSP_fftm_ziptD fftm_ziptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zop

Performs the same operation as vDSP_fft_zop on multiple signals with a single call.

void vDSP_fftm_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector that stores the input signal.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of resultStride should be 1 for best performance.
__vDSP_rfftStride: The number of elements between the first element of one result vector and the next in the output vector result.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n.
__vDSP_numFFT: The number of input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

The function performs Discrete Fourier transforms on a number of different input signals at once, using a single call. It can be used for efficient processing of small input signals (less than 512 points). It will work for input signals of 4 points or greater. Each of the input signals processed by a given call must have the same length and address stride. The input signals are concatenated into a single output vector, the parameter __vDSP_result.

The function computes out-of-place complex discrete Fourier transforms of the input signals, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zop

Translation macro from vDSP_fftm_zop to fftm_zop.

#define vDSP_fftm_zop fftm_zop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zopD

Performs the same operation as vDSP_fft_zopD on multiple signals with a single call.

void vDSP_fftm_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of resultStride should be 1 for best performance.
__vDSP_rfftStride: The number of elements between the first element of one result vector and the next in the output vector result.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n. The value of log2n must be between 2 and 12, inclusive.
__vDSP_numFFT: The number of different input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zopD

Translation macro from vDSP_fftm_zopD to fftm_zopD.

#define vDSP_fftm_zopD fftm_zopD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zopt

Performs the same operation as vDSP_fft_zopt on multiple signals with a single call.

void vDSP_fftm_zopt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   DSPSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of resultStride should be 1 for best performance.
__vDSP_rfftStride: The number of elements between the first element of one result vector and the next in the output vector result.
__vDSP_temp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is N elements per side (where N is 2 raised to __vDSP_log2n). If possible, temp.realp and temp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n. The value of log2n must be between 2 and 12, inclusive.
__vDSP_numFFT: The number of different input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zopt

Translation macro from vDSP_fftm_zopt to fftm_zopt.

#define vDSP_fftm_zopt fftm_zopt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zoptD

Performs the same operation as vDSP_fft_zoptD on multiple signals with a single call.

void vDSP_fftm_zoptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2.
__vDSP_rfftStride: The number of elements between the first element of one result vector and the next in the output vector result.
__vDSP_temp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is N elements per side (where N is 2 raised to __vDSP_log2n). If possible, temp.realp and temp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n. The value of log2n must be between 2 and 12, inclusive.
__vDSP_numFFT: The number of different input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zoptD

Translation macro from vDSP_fftm_zoptD to fftm_zoptD.

#define vDSP_fftm_zoptD fftm_zoptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zrip

Performs the same operation as vDSP_fft_zrip on multiple signals with a single call.

void vDSP_fftm_zrip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vector. To process every element of each signal, specify 1 for parameter __vDSP_signalStride; to process every other element, specify 2.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n.
__vDSP_numFFT: The number of input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

The function performs Discrete Fourier Transforms on multiple signals using a single call. They will work for input signals of 4 points or greater. Each of the input signals processed by a given call must have the same length and address stride.

The functions compute in-place real Discrete Fourier Transforms of the input signals, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zrip

Translation macro from vDSP_fftm_zrip to fftm_zrip.

#define vDSP_fftm_zrip fftm_zrip

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zripD

Performs the same operation as vDSP_fft_zripD on multiple signals with a single call.

void vDSP_fftm_zripD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter __vDSP_signalStride; to process every other element, specify 2.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n.
__vDSP_numFFT: The number of input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

The functions allow you to perform Fourier transforms on a number of different input signals at once, using a single call. They can be used for efficient processing of small input signals (less than 512 points). They will work for input signals of 4 points or greater. Each of the input signals processed by a given call must have the same length and address stride.

The functions compute in-place real discrete Fourier transforms of the input signals, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zripD

Translation macro from vDSP_fftm_zripD to fftm_zripD.

#define vDSP_fftm_zripD fftm_zripD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zript

Performs the same operation as vDSP_fft_zript on multiple signals with a single call.

void vDSP_fftm_zript (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_temp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is N/2 elements per side (where N is 2 raised to __vDSP_log2n). If possible, temp.realp and temp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n.
__vDSP_numFFT: The number of different input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zript

Translation macro from vDSP_fftm_zript to fftm_zript.

#define vDSP_fftm_zript fftm_zript

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zriptD

Performs the same operation as vDSP_fft_zriptD on multiple signals with a single call.

void vDSP_fftm_zriptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify 1 for parameter signalStride; to process every other element, specify 2.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_temp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is N/2 elements per side (where N is 2 raised to __vDSP_log2n). If possible, temp.realp and temp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process in a single input signal. For example, to process 512 elements, specify 9 for parameter log2n.
__vDSP_numFFT: The number of input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zriptD

Translation macro from vDSP_fftm_zriptD to fftm_zriptD.

#define vDSP_fftm_zriptD fftm_zriptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zrop

Performs the same operation as vDSP_fft_zrop on multiple signals with a single call.

void vDSP_fftm_zrop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify a stride of 1; to process every other element, specify 2.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2.
__vDSP_rfftStride: The number of elements between the first element of one result vector and the next in the output vector result.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_numFFT: The number of input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This function performs Discrete Fourier Transforms on multiple input signals using a single call. They can be used for efficient processing of small input signals (less than 512 points). They will work for input signals of 4 points or greater. Each of the input signals processed by a given call must have the same length and address stride. The input signals are concatenated into a single output vector, the parameter __vDSP_result.

The functions compute out-of-place real Discrete Fourier Transforms of the input signals, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zrop

Translation macro from vDSP_fftm_zrop to fftm_zrop.

#define vDSP_fftm_zrop fftm_zrop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zropD

Performs the same operation as VDSP_fft_zropD on multiple signals with a single call.

void vDSP_fftm_zropD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify a stride of 1; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of resultStride should be 1 for best performance.
__vDSP_rfftStride: The number of elements between the first element of one result vector and the next in the output vector result.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_numFFT: The number of input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zropD

Translation macro from vDSP_fftm_zropD to fftm_zropD.

#define vDSP_fftm_zropD fftm_zropD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zropt

Performs the same operation as VDSP_fft_zropt on multiple signals with a single call.

void vDSP_fftm_zropt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   DSPSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify a stride of 1; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of resultStride should be 1 for best performance.
__vDSP_rfftStride: The number of elements between the first element of one result vector and the next in the output vector result.
__vDSP_temp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is N/2 elements per side (where N is 2 raised to __vDSP_log2n). If possible, temp.realp and temp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_numFFT: The number of input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

The functions compute out-of-place real discrete Fourier transforms of the input signals, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zropt

Translation macro from vDSP_fftm_zropt to fftm_zropt.

#define vDSP_fftm_zropt fftm_zropt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fftm_zroptD

Performs the same operation as VDSP_fft_zroptD on multiple signals with a single call.

void vDSP_fftm_zroptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   vDSP_Stride __vDSP_fftStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_resultStride,
   vDSP_Stride __vDSP_rfftStride,
   DSPDoubleSplitComplex *__vDSP_temp,
   vDSP_Length __vDSP_log2n,
   vDSP_Length __vDSP_numFFT,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vectors. To process every element of each signal, specify a stride of 1; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_fftStride: The number of elements between the first element of one input signal and the first element of the next (which is also to length of each input signal, measured in elements).
__vDSP_result: The complex vector signal output.
__vDSP_resultStride: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of resultStride should be 1 for best performance.
__vDSP_rfftStride: The number of elements between the first element of one result vector and the next in the output vector result.
__vDSP_temp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is N/2 elements per side (where N is 2 raised to __vDSP_log2n). If possible, temp.realp and temp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_numFFT: The number of different input signals.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fftm_zroptD

Translation macro from vDSP_fftm_zroptD to fftm_zroptD.

#define vDSP_fftm_zroptD fftm_zroptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_cip

Translation macro from vDSP_fft_cip to fft_cip.

#define vDSP_fft_cip fft_cip

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_cipt

Translation macro from vDSP_fft_cipt to fft_cipt.

#define vDSP_fft_cipt fft_cipt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_cop

Translation macro from vDSP_fft_cop to fft_cop.

#define vDSP_fft_cop fft_cop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_copt

Translation macro from vDSP_fft_copt to fft_copt.

#define vDSP_fft_copt fft_copt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zip

Computes an in-place single-precision complex discrete Fourier transform of the input/output vector signal, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_ioData: A complex input/output vector.
__vDSP_stride: Specifies an address stride through the input/output vector. To process every element of the vector, specify 1 for parameter stride; to process every other element, specify 2.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_ioData, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Declared In

vDSP.h

vDSP_fft_zip

Translation macro from vDSP_fft_zip to fft_zip.

#define vDSP_fft_zip fft_zip

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zipD

Computes an in-place double-precision complex discrete Fourier transform of the input/output vector signal, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zipD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_ioData: A complex input/output vector.
__vDSP_stride: Specifies an address stride through the input/output vector. To process every element of the vector, specify 1 for parameter stride; to process every other element, specify 2. The value of stride should be 1 for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_ioData, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Related Sample Code

OpenCL_FFT

Declared In

vDSP.h

vDSP_fft_zipD

Translation macro from vDSP_fft_zipD to fft_zipD.

#define vDSP_fft_zipD fft_zipD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zipt

void vDSP_fft_zipt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_ioData: A complex input/output vector.
__vDSP_stride: Specifies an address stride through the input/output vector. To process every element of the vector, specify 1 for parameter stride; to process every other element, specify 2.
__vDSP_bufferTemp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the lesser of the size of n elements or 16,384 bytes. If possible, bufferTemp.realp and bufferTemp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_ioData, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zipt

Translation macro from vDSP_fft_zipt to fft_zipt.

#define vDSP_fft_zipt fft_zipt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_ziptD

void vDSP_fft_ziptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the earlier call to the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_ioData: A complex input/output vector.
__vDSP_stride: Specifies an address stride through the input/output vector. To process every element of the vector, specify 1 for parameter stride; to process every other element, specify 2.
__vDSP_bufferTemp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the lesser of the size of n elements or 16,384 bytes. If possible, bufferTemp.realp and bufferTemp.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_ioData, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_ziptD

Translation macro from vDSP_fft_ziptD to fft_ziptD.

#define vDSP_fft_ziptD fft_ziptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zop

Computes an out-of-place single-precision complex discrete Fourier transform of the input vector, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector that stores the input and output signal.
__vDSP_signalStride: Specifies an address stride through the input vector. Parameter strideResult specifies an address stride through the output vector. Thus, to process every element, specify a signalStride of 1; to process every other element, specify 2.
__vDSP_result: The complex vector signal output.
__vDSP_strideResult: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_signal, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_fft_zop

Translation macro from vDSP_fft_zop to fft_zop.

#define vDSP_fft_zop fft_zop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zopD

Computes an out-of-place double-precision complex discrete Fourier transform of the input vector, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zopD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector that stores the input signal.
__vDSP_signalStride: Specifies an address stride through the input vector. Parameter strideResult specifies an address stride through the output vector. Thus, to process every element, specify a signalStride of 1; to process every other element, specify 2. The values of signalStride and strideResult should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_strideResult: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of strideResult should be 1 for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_signal, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zopD

Translation macro from vDSP_fft_zopD to fft_zopD.

#define vDSP_fft_zopD fft_zopD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zopt

void vDSP_fft_zopt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector that stores the input and output signal.
__vDSP_signalStride: Specifies an address stride through the input vector. Parameter strideResult specifies an address stride through the output vector. Thus, to process every element, specify a signalStride of 1; to process every other element, specify 2. The values of signalStride and strideResult should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_strideResult: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2.
__vDSP_bufferTemp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the lesser of the size of n elements or 16,384 bytes. If possible, tempBuffer.realp and tempBuffer.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_signal, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zopt

Translation macro from vDSP_fft_zopt to fft_zopt.

#define vDSP_fft_zopt fft_zopt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zoptD

void vDSP_fft_zoptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vector. Parameter strideResult specifies an address stride through the output vector. Thus, to process every element, specify a signalStride of 1; to process every other element, specify 2. The values of signalStride and strideResult should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_strideResult: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2.
__vDSP_bufferTemp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the lesser of the size of n elements or 16,384 bytes. If possible, tempBuffer.realp and tempBuffer.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_signal, j is the square root of -1, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zoptD

Translation macro from vDSP_fft_zoptD to fft_zoptD.

#define vDSP_fft_zoptD fft_zoptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zrip

Computes an in-place single-precision real discrete Fourier transform, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zrip (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_ioData: A complex input/output vector.
__vDSP_stride: Specifies an address stride through the input/output vector. To process every element of the vector, specify 1 for parameter __vDSP_stride; to process every other element, specify 2.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Forward transforms read real input and write packed complex output. Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, time-domain data and its equivalent frequency-domain data have the same storage requirements. You can find more details on the packing format in “Data Packing for Real FFTs” in vDSP Programming Guide.

where F is __vDSP_direction, C is __vDSP_ioData, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Declared In

vDSP.h

vDSP_fft_zrip

Translation macro from vDSP_fft_zrip to fft_zrip.

#define vDSP_fft_zrip fft_zrip

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zripD

Computes an in-place double-precision real discrete Fourier transform, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zripD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_ioData: A complex input/output vector.
__vDSP_stride: Specifies an address stride through the input/output vector. To process every element of the vector, specify 1 for parameter stride; to process every other element, specify 2.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Forward transforms read real input and write packed complex output. Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, time-domain data and its equivalent frequency-domain data have the same storage requirements. You can find more details on the packing format in “Data Packing for Real FFTs” in vDSP Programming Guide.

where F is __vDSP_flag, C is __vDSP_ioData, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zripD

Translation macro from vDSP_fft_zripD to fft_zripD.

#define vDSP_fft_zripD fft_zripD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zript

Computes an in-place single-precision real discrete Fourier transform, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zript (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_ioData: A complex input/output vector.
__vDSP_stride: Specifies an address stride through the input/output vector. To process every element of the vector, specify 1 for parameter __vDSP_stride; to process every other element, specify 2.
__vDSP_bufferTemp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the size of n / 2 elements. If possible, tempBuffer.realp and tempBuffer.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Forward transforms read real input and write packed complex output. Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, time-domain data and its equivalent frequency-domain data have the same storage requirements. You can find more details on the packing format in “Data Packing for Real FFTs” in vDSP Programming Guide.

where F is __vDSP_direction, C is __vDSP_ioData, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zript

Translation macro from vDSP_fft_zript to fft_zript.

#define vDSP_fft_zript fft_zript

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zriptD

Computes an in-place double-precision real discrete Fourier transform, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zriptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_ioData,
   vDSP_Stride __vDSP_stride,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_ioData: A complex input/output vector.
__vDSP_stride: Specifies an address stride through the input/output vector. To process every element of the vector, specify 1 for parameter signalStride; to process every other element, specify 2.
__vDSP_bufferTemp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the size of n / 2 elements. If possible, tempBuffer.realp and tempBuffer.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

Forward transforms read real input and write packed complex output. Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, time-domain data and its equivalent frequency-domain data have the same storage requirements. You can find more details on the packing format in “Data Packing for Real FFTs” in vDSP Programming Guide.

where F is __vDSP_flag, C is __vDSP_ioData, and N is two raised to the power of __vDSP_log2n.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zriptD

Translation macro from vDSP_fft_zriptD to fft_zriptD.

#define vDSP_fft_zriptD fft_zriptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zrop

Computes an out-of-place single-precision real discrete Fourier transform, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zrop (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_strideResult: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_signal, and N is two raised to the power of __vDSP_log2n.

Forward transforms read real input and write packed complex output (see “Data Packing for Real FFTs” in vDSP Programming Guide for details on the packing format). Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, time-domain data and its equivalent frequency-domain data have the same storage requirements.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Related Sample Code

vDSP Examples

Declared In

vDSP.h

vDSP_fft_zrop

Translation macro from vDSP_fft_zrop to fft_zrop.

#define vDSP_fft_zrop fft_zrop

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zropD

Computes an out-of-place double-precision real discrete Fourier transform, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zropD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_strideResult: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of strideResult should be 1 for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_flag, C is __vDSP_signal, and N is two raised to the power of __vDSP_log2n.

Forward transforms read real input and write packed complex output. Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, time-domain data and its equivalent frequency-domain data have the same storage requirements. You can find more details on the packing format in “Data Packing for Real FFTs” in vDSP Programming Guide.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zropD

Translation macro from vDSP_fft_zropD to fft_zropD.

#define vDSP_fft_zropD fft_zropD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zropt

Computes an out-of-place single-precision real discrete Fourier transform, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zropt (
   FFTSetup __vDSP_setup,
   DSPSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   DSPSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_direction
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetup. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_strideResult: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of strideResult should be 1 for best performance.
__vDSP_bufferTemp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the size of n / 2 elements. If possible, tempBuffer.realp and tempBuffer.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_direction: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_direction, C is __vDSP_signal, and N is two raised to the power of __vDSP_log2n.

Forward transforms read real input and write packed complex output. Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, time-domain data and its equivalent frequency-domain data have the same storage requirements. You can find more details on the packing format in “Data Packing for Real FFTs” in vDSP Programming Guide.

See also functions vDSP_create_fftsetup and vDSP_destroy_fftsetup.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zropt

Translation macro from vDSP_fft_zropt to fft_zropt.

#define vDSP_fft_zropt fft_zropt

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_fft_zroptD

Computes an out-of-place double-precision real discrete Fourier transform, either from the time domain to the frequency domain (forward) or from the frequency domain to the time domain (inverse).

void vDSP_fft_zroptD (
   FFTSetupD __vDSP_setup,
   DSPDoubleSplitComplex *__vDSP_signal,
   vDSP_Stride __vDSP_signalStride,
   DSPDoubleSplitComplex *__vDSP_result,
   vDSP_Stride __vDSP_strideResult,
   DSPDoubleSplitComplex *__vDSP_bufferTemp,
   vDSP_Length __vDSP_log2n,
   FFTDirection __vDSP_flag
);

Parameters

__vDSP_setup: Points to a structure initialized by a prior call to the FFT weights array function, vDSP_create_fftsetupD. The value supplied as parameter log2n of the setup function must equal or exceed the value supplied as parameter log2n of this transform function.
__vDSP_signal: A complex vector signal input.
__vDSP_signalStride: Specifies an address stride through the input vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of signalStride should be 1 for best performance.
__vDSP_result: The complex vector signal output.
__vDSP_strideResult: Specifies an address stride through the output vector. Thus, to process every element, specify a stride of 1; to process every other element, specify 2. The value of strideResult should be 1 for best performance.
__vDSP_bufferTemp: A temporary vector used for storing interim results. The minimum size of temporary memory for each part (real and imaginary) is the size of n / 2 elements. If possible, tempBuffer.realp and tempBuffer.imagp should be 16-byte aligned for best performance.
__vDSP_log2n: The base 2 exponent of the number of elements to process. For example, to process 1024 elements, specify 10 for parameter log2n.
__vDSP_flag: A forward/inverse directional flag, which must specify kFFTDirection_Forward for a forward transform or kFFTDirection_Inverse for an inverse transform.

Discussion

This performs the following operation:

where F is __vDSP_flag, C is __vDSP_signal, and N is two raised to the power of __vDSP_log2n.

Forward transforms read real input and write packed complex output. Inverse transforms read packed complex input and write real output. As a result of packing the frequency-domain data, time-domain data and its equivalent frequency-domain data have the same storage requirements. You can find more details on the packing format in “Data Packing for Real FFTs” in vDSP Programming Guide.

See also functions vDSP_create_fftsetupD and vDSP_destroy_fftsetupD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_fft_zroptD

Translation macro from vDSP_fft_zroptD to fft_zroptD.

#define vDSP_fft_zroptD fft_zroptD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_hamm_window

Creates a single-precision Hamming window.

void vDSP_hamm_window (
   float *__vDSP_C,
   vDSP_Length __vDSP_N,
   int __vDSP_FLAG
);

Parameters

__vDSP_C: Output vector C.
__vDSP_N: The desired window length.
__vDSP_FLAG: Pass the vDSP_HALF_WINDOW flag to create only the first (n+1)/2 points, or 0 (zero) for a full-size window.

Discussion

vDSP_hamm_window creates a single-precision Hamming window function C, which can be multiplied by a vector using vDSP_vmul.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_hamm_windowD

Creates a double-precision Hamming window.

void vDSP_hamm_windowD (
   double *__vDSP_C,
   vDSP_Length __vDSP_N,
   int __vDSP_FLAG
);

Parameters

__vDSP_C: Output vector C.
__vDSP_N: The desired window length.
__vDSP_FLAG: Pass the vDSP_HALF_WINDOW flag to create only the first (n+1)/2 points, or 0 (zero) for a full-size window.

Discussion

vDSP_hamm_windowD creates a double-precision Hamming window function C, which can be multiplied by a vector using vDSP_vmulD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_hann_window

Creates a single-precision Hanning window.

void vDSP_hann_window (
   float *__vDSP_C,
   vDSP_Length __vDSP_N,
   int __vDSP_FLAG
);

Parameters

__vDSP_C

Output vector C.

__vDSP_N

The desired window length.

__vDSP_FLAG

The FLAG parameter can have the following values:

vDSP_HANN_DENORM creates a denormalized window.
vDSP_HANN_NORM creates a normalized window.
vDSP_HALF_WINDOW creates only the first (N+1)/2 points.

vDSP_HALF_WINDOW can be ORed with any of the other values (using the C bitwise or operator, |).

Discussion

This computes the following:

vDSP_hann_window creates a single-precision Hanning window function C, which can be multiplied by a vector using vDSP_vmul.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_hann_windowD

Creates a double-precision Hanning window.

void vDSP_hann_windowD (
   double *__vDSP_C,
   vDSP_Length __vDSP_N,
   int __vDSP_FLAG
);

Parameters

__vDSP_C

Output vector C.

__vDSP_N

The desired window length.

__vDSP_FLAG

The FLAG parameter can have the following values:

vDSP_HANN_DENORM creates a denormalized window.
vDSP_HANN_NORM creates a normalized window.
vDSP_HALF_WINDOW creates only the first (N+1)/2 points.

vDSP_HALF_WINDOW can be ORed with any of the other values (using the C bitwise or operator, |).

Discussion

This computes the following:

vDSP_hann_window creates a double-precision Hanning window function C, which can be multiplied by a vector using vDSP_vmulD.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_imgfir

Filters an image by performing a two-dimensional convolution with a kernel; single precision.

void vDSP_imgfir (
   float *__vDSP_signal,
   vDSP_Length __vDSP_numRow,
   vDSP_Length __vDSP_numCol,
   float *__vDSP_filter,
   float *__vDSP_result,
   vDSP_Length __vDSP_fnumRow,
   vDSP_Length __vDSP_fnumCol
);

Parameters

__vDSP_signal: A real matrix signal input.
__vDSP_numRow: Number of rows in A.
__vDSP_numCol: Number of columns in A.
__vDSP_filter: A two-dimensional real matrix containing the filter.
__vDSP_result: Stores real output matrix.
__vDSP_fnumRow: Number of rows in B.
__vDSP_fnumCol: Number of columns in B.

Discussion

The image is given by the input matrix A. It has M rows and N columns.

where B is the filter kernel, which has P rows and Q columns.

On Intel and PowerPC CPUs, the values for P and Q must be odd. On PowerPC CPUs, both P and Q must be at least 5, and you should ensure Q >= P for best performance.

The filtered image is placed in the output matrix C. The function pads the perimeter of the output image with a border of (P-1)/2 rows of zeros on the top and bottom and (Q-1)/2 columns of zeros on the left and right.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_imgfir

Translation macro from vDSP_imgfir to imgfir.

#define vDSP_imgfir imgfir

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_imgfirD

Filters an image by performing a two-dimensional convolution with a kernel; double precision.

void vDSP_imgfirD (
   double *__vDSP_signal,
   vDSP_Length __vDSP_numRow,
   vDSP_Length __vDSP_numCol,
   double *__vDSP_filter,
   double *__vDSP_result,
   vDSP_Length __vDSP_fnumRow,
   vDSP_Length __vDSP_fnumCol
);

Parameters

__vDSP_signal: A real vector signal input.
__vDSP_numRow: Number of rows in input matrix.
__vDSP_numCol: Number of columns in input matrix.
__vDSP_filter: A two-dimensional real matrix containing the filter.
__vDSP_result: Stores real output matrix.
__vDSP_fnumRow: Number of rows in B.
__vDSP_fnumCol: Number of columns in B.

Discussion

The image is given by the input matrix A. It has M rows and N columns.

B is the filter kernel, which has P rows and Q columns.

On Intel and PowerPC CPUs, the values for P and Q must be odd. On PowerPC CPUs, both P and Q must be at least 5, and you should ensure Q >= P for best performance.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_imgfirD

Translation macro from vDSP_imgfirD to imgfirD.

#define vDSP_imgfirD imgfirD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_maxmgv

Vector maximum magnitude; single precision.

void vDSP_maxmgv (
   const float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = 0;

for (n = 0; n < N; ++n)

    if (*C < abs(A[n*I]))

        *C = abs(A[n*I]);

Finds the element with the greatest magnitude in vector A and copies this value to scalar *C.

If N is zero (0), this function returns a value of 0 in *C.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Core Audio Utility Classes

Declared In

vDSP.h

vDSP_maxmgvD

Vector maximum magnitude; double precision.

void vDSP_maxmgvD (
   const double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = 0;

for (n = 0; n < N; ++n)

    if (*C < abs(A[n*I]))

        *C = abs(A[n*I]);

Finds the element with the greatest magnitude in vector A and copies this value to scalar *C.

If N is zero (0), this function returns a value of 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_maxmgvi

Vector maximum magnitude with index; single precision.

void vDSP_maxmgvi (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length *__vDSP_IC,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A.
__vDSP_C: Output scalar.
__vDSP_IC: Output scalar index.
__vDSP_N: Count of values in A.

Discussion

This performs the following operation:

*C = 0;

for (n = 0; n < N; ++n)

    if (*C < abs(A[n*I]))

        *C = abs(A[n*I]);

        *IC = n*I;

Copies the element with the greatest magnitude from real vector A to real scalar *C, and writes its zero-based index to integer scalar *IC. The index is the actual array index, not the pre-stride index.If vector A contains more than one instance of the maximum magnitude, *IC contains the index of the first instance.

If N is zero (0), this function returns a value of 0 in *C, and the value in *IC is undefined.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_maxmgviD

Vector maximum magnitude with index; double precision.

void vDSP_maxmgviD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length *__vDSP_IC,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_IC: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = 0;

for (n = 0; n < N; ++n)

    if (*C < abs(A[n*I]))

        *C = abs(A[n*I]);

        *IC = n*I;

Copies the element with the greatest magnitude from real vector A to real scalar *C, and writes its zero-based index to integer scalar *IC. The index is the actual array index, not the pre-stride index. If vector A contains more than one instance of the maximum magnitude, *IC contains the index of the first instance.

If N is zero (0), this function returns a value of 0 in *C, and the value in *IC is undefined.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_maxv

Vector maximum value; single precision.

void vDSP_maxv (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = -INFINITY;

for (n = 0; n < N; ++n)

    if (*C < A[n*I])

        *C = A[n*I];

Finds the element with the greatest value in vector A and copies this value to scalar *C. If N is zero (0), this function returns -INFINITY in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_maxvD

Vector maximum value; double precision.

void vDSP_maxvD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = -INFINITY;

for (n = 0; n < N; ++n)

    if (*C < A[n*I])

        *C = A[n*I];

Finds the element with the greatest value in vector A and copies this value to scalar *C. If N is zero (0), this function returns -INFINITY in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_maxvi

Vector maximum value with index; single precision.

void vDSP_maxvi (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length *__vDSP_IC,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_IC: Output scalar index
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = -INFINITY;

for (n = 0; n < N; ++n)

    if (*C < A[n * I])

        *C = A[n * I];

        *IC = n * I;

Copies the element with the greatest value from real vector A to real scalar *C, and writes its zero-based index to integer scalar *IC. The index is the actual array index, not the pre-stride index. If vector A contains more than one instance of the maximum value, *IC contains the index of the first instance. If N is zero (0), this function returns a value of -INFINITY in *C, and the value in *IC is undefined.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_maxviD

Vector maximum value with index; double precision.

void vDSP_maxviD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length *__vDSP_IC,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_IC: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = -INFINITY;

for (n = 0; n < N; ++n)

    if (*C < A[n * I])

        *C = A[n * I];

        *IC = n * I;

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_meamgv

Vector mean magnitude; single precision.

void vDSP_meamgv (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the mean of the magnitudes of elements of vector A and stores this value in scalar *C.

If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_meamgvD

Vector mean magnitude; double precision.

void vDSP_meamgvD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the mean of the magnitudes of elements of vector A and stores this value in scalar *C.

If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_meanv

Vector mean value; single precision.

void vDSP_meanv (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the mean value of the elements of vector A and stores this value in scalar *C.

If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_meanvD

Vector mean value; double precision.

void vDSP_meanvD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the mean value of the elements of vector A and stores this value in scalar *C.

If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_measqv

Vector mean square value; single precision.

void vDSP_measqv (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the mean value of the squares of the elements of vector A and stores this value in scalar *C.

If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_measqvD

Vector mean square value; double precision.

void vDSP_measqvD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the mean value of the squares of the elements of vector A and stores this value in scalar *C.

If N is zero (0), this function returns NaN. in *C

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_minmgv

Vector minimum magnitude; single precision.

void vDSP_minmgv (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = INF;

for (n = 0; n < N; ++n)

    if (abs(A[n*I]) < *C)

        *C = abs(A[n*I]);

Finds the element with the least magnitude in vector A and copies this value to scalar *C.

If N is zero (0), this function returns +INF in *C.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Core Audio Utility Classes

Declared In

vDSP.h

vDSP_minmgvD

Vector minimum magnitude; double precision.

void vDSP_minmgvD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = INF;

for (n = 0; n < N; ++n)

    if (abs(A[n*I]) < *C)

        *C = abs(A[n*I]);

Finds the element with the least magnitude in vector A and copies this value to scalar *C.

If N is zero (0), this function returns +INF in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_minmgvi

Vector minimum magnitude with index; single precision.

void vDSP_minmgvi (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length *__vDSP_IC,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_IC: Output scalar index
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = INF;

for (n = 0; n < N; ++n)

    if (abs(A[n*I]) < *C)

        *C = abs(A[n*I]);

        *IC = n*I;

Copies the element with the least magnitude from real vector A to real scalar *C, and writes its zero-based index to integer scalar *IC. The index is the actual array index, not the pre-stride index. If vector A contains more than one instance of the least magnitude, *IC contains the index of the first instance.

If N is zero (0), this function returns a value of +INF in *C and the value in *IC is undefined.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_minmgviD

Vector minimum magnitude with index; double precision.

void vDSP_minmgviD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length *__vDSP_IC,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_IC: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = INF;

for (n = 0; n < N; ++n)

    if (abs(A[n*I]) < *C)

        *C = abs(A[n*I]);

        *IC = n*I;

If N is zero (0), this function returns a value of +INF in *C and the value in *IC is undefined.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_minv

Vector minimum value.

void vDSP_minv (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = INF;

for (n = 0; n < N; ++n)

    if (A[n*I] < *C)

        *C = A[n*I];

Finds the element with the least value in vector A and copies this value to scalar *C.

If N is zero (0), this function returns +INF in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_minvD

Vector minimum value; double precision.

void vDSP_minvD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = INF;

for (n = 0; n < N; ++n)

    if (A[n*I] < *C)

        *C = A[n*I];

Finds the element with the least value in vector A and copies this value to scalar *C.

If N is zero (0), this function returns +INF in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_minvi

Vector minimum value with index; single precision.

void vDSP_minvi (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length *__vDSP_IC,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_IC: Output scalar index
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = INF;

for (n = 0; n < N; ++n)

    if (A[n*I] < *C)

        *C = A[n*I];

        *IC = n*I;

Copies the element with the least value from real vector A to real scalar *C, and writes its zero-based index to integer scalar *IC. The index is the actual array index, not the pre-stride index. If vector A contains more than one instance of the least value, *IC contains the index of the first instance.

If N is zero (0), this function returns a value of +INF in *C, and the value in *IC is undefined.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_minviD

Vector minimum value with index; double precision.

void vDSP_minviD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length *__vDSP_IC,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_IC: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

*C = INF;

for (n = 0; n < N; ++n)

    if (A[n*I] < *C)

        *C = A[n*I];

        *IC = n*I;

If N is zero (0), this function returns a value of +INF in *C, and the value in *IC is undefined.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_mmov

Copies the contents of a submatrix to another submatrix.

void vDSP_mmov (
   float *__vDSP_A,
   float *__vDSP_C,
   vDSP_Length __vDSP_NC,
   vDSP_Length __vDSP_NR,
   vDSP_Length __vDSP_TCA,
   vDSP_Length __vDSP_TCC
);

Parameters

__vDSP_A: Single-precision real input submatrix
__vDSP_C: Single-precision real output submatrix
__vDSP_NC: Number of columns in A and C
__vDSP_NR: Number of rows in A and C
__vDSP_TCA: Number of columns in the matrix of which A is a submatrix
__vDSP_TCC: Number of columns in the matrix of which C is a submatrix

Discussion

The matrices are assumed to be stored in row-major order. Thus elements A[i][j] and A[i][j+1] are adjacent. Elements A[i][j] and A[i+1][j] are TCA elements apart.

This function may be used to move a subarray beginning at any point in a larger embedding array by passing for A the address of the first element of the subarray. For example, to move a subarray starting at A[3][4], pass &A[3][4]. Similarly, the address of the first destination element is passed for C

NC may equal TCA, and it may equal TCC. To copy all of an array to all of another array, pass the number of rows in NR and the number of columns in NC, TCA, and TCC.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_mmovD

Copies the contents of a submatrix to another submatrix.

void vDSP_mmovD (
   double *__vDSP_A,
   double *__vDSP_C,
   vDSP_Length __vDSP_NC,
   vDSP_Length __vDSP_NR,
   vDSP_Length __vDSP_TCA,
   vDSP_Length __vDSP_TCC
);

Parameters

__vDSP_A: Double-precision real input submatrix
__vDSP_C: Double-precision real output submatrix
__vDSP_NC: Number of columns in A and C
__vDSP_NR: Number of rows in A and C
__vDSP_TCA: Number of columns in the matrix of which A is a submatrix
__vDSP_TCC: Number of columns in the matrix of which C is a submatrix

Discussion

The matrices are assumed to be stored in row-major order. Thus elements A[i][j] and A[i][j+1] are adjacent. Elements A[i][j] and A[i+1][j] are TCA elements apart.

NC may equal TCA, and it may equal TCC. To copy all of an array to all of another array, pass the number of rows in NR and the number of columns in NC, TCA, and TCC.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_mmul

Performs an out-of-place multiplication of two matrices; single precision.

void vDSP_mmul (
   float *__vDSP_a,
   vDSP_Stride __vDSP_aStride,
   float *__vDSP_b,
   vDSP_Stride __vDSP_bStride,
   float *__vDSP_c,
   vDSP_Stride __vDSP_cStride,
   vDSP_Length __vDSP_M,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_P
);

Parameters

__vDSP_a: Input matrix A.
__vDSP_aStride: The stride within __vDSP_a. For example if stride is 2, every second element is used.
__vDSP_b: Input matrix B.
__vDSP_bStride: The stride within __vDSP_b. For example if stride is 2, every second element is used.
__vDSP_c: The result matrix.
__vDSP_M: The number of rows in matrix A.
__vDSP_N: The number of columns in matrix B.
__vDSP_P: The number of columns in matrix A and the number of rows in matrix B.

Discussion

This function multiplies an M-by-P matrix (A) by a P-by-N matrix (B) and stores the results in an M-by-N matrix (C).

This performs the following operation:

Parameters a and b contain the matrices to be multiplied, and are represented by A and B in the equation above.

The aStride parameter is an address stride through a, represented by I in the equation above.

The bStride parameter is an address stride through b, represented by J in the equation above.

Parameter C is the result matrix. cStride is an address stride through c, represented by K in the equation above.

Parameter M is the row count for both A and C. Parameter N is the column count for both B and C. Parameter P is the column count for A and the row count for B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_mmul

Translation macro from vDSP_mmul to mmul.

#define vDSP_mmul mmul

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_mmulD

Performs an out-of-place multiplication of two matrices; double precision.

void vDSP_mmulD (
   double *__vDSP_a,
   vDSP_Stride __vDSP_aStride,
   double *__vDSP_b,
   vDSP_Stride __vDSP_bStride,
   double *__vDSP_c,
   vDSP_Stride __vDSP_cStride,
   vDSP_Length __vDSP_M,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_P
);

Parameters

__vDSP_a: Input matrix A.
__vDSP_aStride: The stride within __vDSP_a. For example if stride is 2, every second element is used.
__vDSP_b: Input matrix B.
__vDSP_bStride: The stride within __vDSP_b. For example if stride is 2, every second element is used.
__vDSP_c: The result matrix.
__vDSP_M: The number of rows in matrix A.
__vDSP_N: The number of columns in matrix B.
__vDSP_P: The number of columns in matrix A and the number of rows in matrix B.

Discussion

This function multiplies an M-by-P matrix (A) by a P-by-N matrix (B) and stores the results in an M-by-N matrix (C).

This performs the following operation:

Parameters a and b contain the matrices to be multiplied, and are represented by A and B in the equation above.

The aStride parameter is an address stride through a, represented by I in the equation above.

The bStride parameter is an address stride through b, represented by J in the equation above.

Parameter C is the result matrix. cStride is an address stride through c, represented by K in the equation above.

Parameter M is the row count for both A and C. Parameter N is the column count for both B and C. Parameter P is the column count for A and the row count for B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_mmulD

Translation macro from vDSP_mmulD to mmulD.

#define vDSP_mmulD mmulD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_mtrans

Creates a transposed matrix C from a source matrix A; single precision.

void vDSP_mtrans (
   float *__vDSP_a,
   vDSP_Stride __vDSP_aStride,
   float *__vDSP_c,
   vDSP_Stride __vDSP_cStride,
   vDSP_Length __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_a: Input matrix A.
__vDSP_aStride: The stride within __vDSP_a. For example if stride is 2, every second element is used.
__vDSP_c: The resulting transposed matrix (output).
__vDSP_cStride: The stride within __vDSP_c. For example if stride is 2, every second element is used.
__vDSP_M: Parameter M is the number of rows in C (and the number of columns in A).
__vDSP_N: Parameter N is the number of columns in C (and the number of rows in A).

Discussion

This performs the following operation:

where I is __vDSP_aStride and K is __vDSP_cStride.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_mtrans

Translation macro from vDSP_mtrans to mtrans.

#define vDSP_mtrans mtrans

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_mtransD

Creates a transposed matrix C from a source matrix A; double precision.

void vDSP_mtransD (
   double *__vDSP_a,
   vDSP_Stride __vDSP_aStride,
   double *__vDSP_c,
   vDSP_Stride __vDSP_cStride,
   vDSP_Length __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_a: Input matrix A.
__vDSP_aStride: The stride within __vDSP_a. For example if stride is 2, every second element is used.
__vDSP_c: The resulting transposed matrix (output).
__vDSP_cStride: The stride within __vDSP_c. For example if stride is 2, every second element is used.
__vDSP_M: Parameter M is the number of rows in C (and the number of columns in A).
__vDSP_N: Parameter N is the number of columns in C (and the number of rows in A).

Discussion

This performs the following operation:

where I is __vDSP_aStride and K is __vDSP_cStride.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_mtransD

Translation macro from vDSP_mtransD to mtransD.

#define vDSP_mtransD mtransD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_mvessq

Vector mean of signed squares; single precision.

void vDSP_mvessq (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the mean value of the signed squares of the elements of vector A and stores this value in *C. If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_mvessqD

Vector mean of signed squares; double precision.

void vDSP_mvessqD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the mean value of the signed squares of the elements of vector A and stores this value in *C. If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_nzcros

Find zero crossings; single precision.

void vDSP_nzcros (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   vDSP_Length __vDSP_B,
   vDSP_Length *__vDSP_C,
   vDSP_Length *__vDSP_D,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Maximum number of crossings to find
__vDSP_C: Index of last crossing found
__vDSP_D: Total number of zero crossings found
__vDSP_N: Number of elements in A

Discussion

This performs the following operation:

*D = *C = 0;
for(n = 1; n < N; n++)
{
    if( sign(A[n * I]) != sign(A[(n - 1) * I]) )
    {
        *D = *D + 1;
        if( *D == B)
        {
            *C = n * I;
            break;
        }
    }
}

The "function" sign(x) above has the value -1 if the sign bit of x is 1 (x is negative or -0), and +1 if the sign bit is 0 (x is positive or +0).

Scans vector A to locate transitions from positive to negative values and from negative to positive values. The scan terminates when the number of crossings specified by B is found, or the end of the vector is reached. The zero-based index of the last crossing is returned in C. C is the actual array index, not the pre-stride index. If the zero crossing that B specifies is not found, zero is returned in C. The total number of zero crossings found is returned in D.

Note that a transition from -0 to +0 or from +0 to -0 is counted as a zero crossing.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_nzcrosD

Find zero crossings; double precision.

void vDSP_nzcrosD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   vDSP_Length __vDSP_B,
   vDSP_Length *__vDSP_C,
   vDSP_Length *__vDSP_D,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Maximum number of crossings to find
__vDSP_C: Index of last crossing found
__vDSP_D: Total number of zero crossings found
__vDSP_N: Number of elements in A

Discussion

This performs the following operation:

*D = *C = 0;
for(n = 1; n < N; n++)
{
    if( sign(A[n * I]) != sign(A[(n - 1) * I]) )
    {
        *D = *D + 1;
        if( *D == B)
        {
            *C = n * I;
            break;
        }
    }
}

The "function" sign(x) above has the value -1 if the sign bit of x is 1 (x is negative or -0), and +1 if the sign bit is 0 (x is positive or +0).

Note that a transition from -0 to +0 or from +0 to -0 is counted as a zero crossing.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_polar

Rectangular to polar conversion; single precision.

void vDSP_polar (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A, must be even
__vDSP_C: Single-precision output vector
__vDSP_K: Stride for C, must be even
__vDSP_N: Number of ordered pairs processed

Discussion

This performs the following operation:

Converts rectangular coordinates to polar coordinates. Cartesian (x,y) pairs are read from vector A. Polar (rho, theta) pairs, where rho is the radius and theta is the angle in the range [-pi, pi] are written to vector C. N specifies the number of coordinate pairs in A and C.

Coordinate pairs are adjacent elements in the array, regardless of stride; stride is the distance from one coordinate pair to the next.

This function performs the inverse operation of vDSP_rect, which converts polar to rectangular coordinates.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_polarD

Rectangular to polar conversion; double precision.

void vDSP_polarD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A, must be even
__vDSP_C: Double-precision output vector
__vDSP_K: Stride for C, must be even
__vDSP_N: Number of ordered pairs processed

Discussion

This performs the following operation:

Coordinate pairs are adjacent elements in the array, regardless of stride; stride is the distance from one coordinate pair to the next.

This function performs the inverse operation of vDSP_rectD, which converts polar to rectangular coordinates.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_rect

Polar to rectangular conversion; single precision.

void vDSP_rect (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A, must be even
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C, must be even
__vDSP_N: Number of ordered pairs processed

Discussion

This performs the following operation:

Converts polar coordinates to rectangular coordinates. Polar (rho, theta) pairs, where rho is the radius and theta is the angle in the range [-pi, pi] are read from vector A. Cartesian (x,y) pairs are written to vector C. N specifies the number of coordinate pairs in A and C.

Coordinate pairs are adjacent elements in the array, regardless of stride; stride is the distance from one coordinate pair to the next.

This function performs the inverse operation of vDSP_polar, which converts rectangular to polar coordinates.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_rectD

Polar to rectangular conversion; double precision.

void vDSP_rectD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A, must be even
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C, must be even
__vDSP_N: Number of ordered pairs processed

Discussion

This performs the following operation:

Coordinate pairs are adjacent elements in the array, regardless of stride; stride is the distance from one coordinate pair to the next.

This function performs the inverse operation of vDSP_polarD, which converts rectangular to polar coordinates.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_rmsqv

Vector root-mean-square; single precision.

void vDSP_rmsqv (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Single-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Calculates the root mean square of the elements of A and stores the result in *C.

If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_rmsqvD

Vector root-mean-square; double precision.

void vDSP_rmsqvD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Double-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Calculates the root mean square of the elements of A and stores the result in *C.

If N is zero (0), this function returns NaN in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_svdiv

Divide scalar by vector; single precision.

void vDSP_svdiv (
   float *__vDSP_A,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input scalar
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Divides scalar A by each element of vector B, storing the results in vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_svdivD

Divide scalar by vector; double precision.

void vDSP_svdivD (
   double *__vDSP_A,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input scalar
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Divides scalar A by each element of vector B, storing the results in vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_sve

Vector sum; single precision.

void vDSP_sve (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Single-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the sum of the elements of A into *C. If N is zero (0), this function returns 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_sveD

Vector sum; double precision.

void vDSP_sveD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Double-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the sum of the elements of A into *C. If N is zero (0), this function returns 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_svemg

Vector sum of magnitudes; single precision.

void vDSP_svemg (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Single-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the sum of the magnitudes of the elements of A into *C.

If N is zero (0), this function returns 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_svemgD

Vector sum of magnitudes; double precision.

void vDSP_svemgD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Double-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the sum of the magnitudes of the elements of A into *C.

If N is zero (0), this function returns 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_svesq

Vector sum of squares; single precision.

void vDSP_svesq (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Single-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the sum of the squares of the elements of A into *C.

If N is zero (0), this function returns 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_svesqD

Vector sum of squares; double precision.

void vDSP_svesqD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Double-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the sum of the squares of the elements of A into C.

If N is zero (0), this function returns 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_svs

Vector sum of signed squares; single precision.

void vDSP_svs (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Single-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the sum of the signed squares of the elements of A into *C.

If N is zero (0), this function returns 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_svsD

Vector sum of signed squares; double precision.

void vDSP_svsD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector.
__vDSP_I: Stride for A
__vDSP_C: Double-precision real output scalar
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the sum of the signed squares of the elements of A into *C.

If N is zero (0), this function returns 0 in *C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vaam

Vector add, add, and multiply; single precision.

void vDSP_vaam (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   float *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Single-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Single-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process; each vector must have at least N elements

Discussion

This performs the following operation:

Multiplies the sum of vectors A and B by the sum of vectors C and D. Results are stored in vector E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vaamD

Vector add, add, and multiply; double precision.

void vDSP_vaamD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   double *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Double-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Double-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process; each vector must have at least N elements

Discussion

This performs the following operation:

Multiplies the sum of vectors A and B by the sum of vectors C and D. Results are stored in vector E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vabs

Vector absolute values; single precision.

void vDSP_vabs (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for __vDSP_A
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for __vDSP_C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the absolute values of the elements of A into corresponding elements of C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vabsD

Vector absolute values; double precision.

void vDSP_vabsD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for __vDSP_A
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for __vDSP_C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the absolute values of the elements of __vDSP_A into corresponding elements of __vDSP_C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vabsi

Integer vector absolute values.

void vDSP_vabsi (
   int *__vDSP_A,
   vDSP_Stride __vDSP_I,
   int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Integer input vector
__vDSP_I: Stride for __vDSP_A
__vDSP_C: Integer output vector
__vDSP_K: Stride for __vDSP_C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Writes the absolute values of the elements of __vDSP_A into corresponding elements of __vDSP_C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vadd

Adds two vectors; single precision.

void vDSP_vadd (
   const float __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const float __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   float __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_input1: Single-precision real input vector
__vDSP_stride1: Stride for __vDSP_input1
__vDSP_input2: Single-precision real input vector
__vDSP_stride2: Stride for __vDSP_input2
__vDSP_result: Single-precision real output vector
__vDSP_strideResult: Stride for __vDSP_result
__vDSP_N: Number of elements to add

Discussion

This function adds vector __vDSP_input1 to vector __vDSP_input2 and leaves the result in vector __vDSP_strideResult.

It performs the following operation:

where A is __vDSP_input1, B is __vDSP_input2, C is __vDSP_result, I is __vDSP_stride1, J is __vDSP_stride2, K is __vDSP_strideResult, and N is __vDSP_size.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Core Audio Utility Classes

Declared In

vDSP.h

vDSP_vadd

Translation macro from vDSP_vadd to vadd.

#define vDSP_vadd vadd

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_vaddD

Adds two vectors; double precision.

void vDSP_vaddD (
   const double __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const double __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   double __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_input1: Double-precision real input vector
__vDSP_stride1: Stride for __vDSP_input1
__vDSP_input2: Double-precision real input vector
__vDSP_stride2: Stride for __vDSP_input2
__vDSP_result: Double-precision real output vector
__vDSP_strideResult: Stride for __vDSP_result
__vDSP_N: Number of elements to add

Discussion

This function adds vector __vDSP_input1 to vector __vDSP_input2 and leaves the result in vector __vDSP_strideResult.

It performs the following operation:

where A is __vDSP_input1, B is __vDSP_input2, C is __vDSP_result, I is __vDSP_stride1, J is __vDSP_stride2, K is __vDSP_strideResult, and N is __vDSP_size.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vaddD

Translation macro from vDSP_vaddD to vaddD.

#define vDSP_vaddD vaddD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_vam

Vector add and multiply; single precision.

void vDSP_vam (
   const float __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const float __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   const float __vDSP_input3[],
   vDSP_Stride __vDSP_stride3,
   float __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_input1: Single-precision real input vector
__vDSP_stride1: Stride for __vDSP_input1
__vDSP_input2: Single-precision real input vector
__vDSP_stride2: Stride for __vDSP_input2
__vDSP_input3: Single-precision real input vector
__vDSP_stride3: Stride for __vDSP_input3
__vDSP_result: Single-precision real output vector
__vDSP_strideResult: Stride for __vDSP_result
__vDSP_N: Number of elements to add

Discussion

This function adds the vectors __vDSP_input1 and __vDSP_input2, multiplies each sum by the corresponding value in vector __vDSP_input3, and leaves the result in vector __vDSP_strideResult.

It performs the following operation:

where A is __vDSP_input1, B is __vDSP_input2, C is __vDSP_input3, D is __vDSP_result, I is __vDSP_stride1, J is __vDSP_stride2, K is __vDSP_stride3, L is __vDSP_strideResult, and N is __vDSP_size.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vam

Translation macro from vDSP_vam to vam.

#define vDSP_vam vam

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_vamD

Vector add and multiply; double precision.

void vDSP_vamD (
   const double __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const double __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   const double __vDSP_input3[],
   vDSP_Stride __vDSP_stride3,
   double __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_input1: Double-precision real input vector
__vDSP_stride1: Stride for __vDSP_input1
__vDSP_input2: Double-precision real input vector
__vDSP_stride2: Stride for __vDSP_input2
__vDSP_input3: Double-precision real input vector
__vDSP_stride3: Stride for __vDSP_input3
__vDSP_result: Double-precision real output vector
__vDSP_strideResult: Stride for __vDSP_result
__vDSP_N: Number of elements to add

Discussion

This function adds the vectors __vDSP_input1 and __vDSP_input2, multiplies each sum by the corresponding value in vector __vDSP_input3, and leaves the result in vector __vDSP_strideResult.

It performs the following operation:

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vamD

Translation macro from vDSP_vamD to vamD.

#define vDSP_vamD vamD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_vasbm

Vector add, subtract, and multiply; single precision.

void vDSP_vasbm (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   float *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Single-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Single-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process; each vector must have at least N elements

Discussion

This performs the following operation:

Multiplies the sum of vectors A and B by the result of subtracting vector D from vector C. Results are stored in vector E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vasbmD

Vector add, subtract, and multiply; double precision.

void vDSP_vasbmD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   double *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Double-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Double-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process; each vector must have at least N elements

Discussion

This performs the following operation:

Multiplies the sum of vectors A and B by the result of subtracting vector D from vector C. Results are stored in vector E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vasm

Vector add and scalar multiply; single precision.

void vDSP_vasm (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input scalar
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process; each vector must have at least N elements

Discussion

This performs the following operation:

Multiplies the sum of vectors A and B by scalar C. Results are stored in vector D.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vasmD

Vector add and scalar multiply; double precision.

void vDSP_vasmD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input scalar
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process; each vector must have at least N elements

Discussion

This performs the following operation:

Multiplies the sum of vectors A and B by scalar C. Results are stored in vector D.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vavlin

Vector linear average; single precision.

void vDSP_vavlin (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input scalar
__vDSP_C: Single-precision real input-output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process; each vector must have at least N elements

Discussion

This performs the following operation:

Recalculates the linear average of input-output vector C to include input vector A. Input scalar B specifies the number of vectors included in the current average.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vavlinD

Vector linear average; double precision.

void vDSP_vavlinD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input scalar
__vDSP_C: Double-precision real input-output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process; each vector must have at least N elements

Discussion

This performs the following operation:

Recalculates the linear average of input-output vector C to include input vector A. Input scalar B specifies the number of vectors included in the current average.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vclip

Vector clip; single precision.

void vDSP_vclip (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   float *__vDSP_C,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input scalar: low clipping threshold
__vDSP_C: Single-precision real input scalar: high clipping threshold
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Elements of A are copied to D while clipping elements that are outside the interval [B, C] to the endpoints.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vclipc

Vector clip and count; single precision.

void vDSP_vclipc (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   float *__vDSP_C,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N,
   vDSP_Length *__vDSP_NLOW,
   vDSP_Length *__vDSP_NHI
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input scalar: low clipping threshold
__vDSP_C: Single-precision real input scalar: high clipping threshold
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: Number of elements in A and D
__vDSP_NLOW: Number of elements that were clipped to B
__vDSP_NHI: Number of elements that were clipped to C

Discussion

This performs the following operation:

Elements of A are copied to D while clipping elements that are outside the interval [B, C] to the endpoints.

The count of elements clipped to B is returned in *NLOW, and the count of elements clipped to C is returned in *NHI

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vclipcD

Vector clip and count; double precision.

void vDSP_vclipcD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   double *__vDSP_C,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N,
   vDSP_Length *__vDSP_NLOW,
   vDSP_Length *__vDSP_NHI
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input scalar: low clipping threshold
__vDSP_C: Double-precision real input scalar: high clipping threshold
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: Number of elements in A and D
__vDSP_NLOW: Number of elements that were clipped to B
__vDSP_NHI: Number of elements that were clipped to C

Discussion

This performs the following operation:

Elements of A are copied to D while clipping elements that are outside the interval [B, C] to the endpoints.

The count of elements clipped to B is returned in *NLOW, and the count of elements clipped to C is returned in *NHI

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vclipD

Vector clip; double precision.

void vDSP_vclipD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   double *__vDSP_C,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input scalar: low clipping threshold
__vDSP_C: Double-precision real input scalar: high clipping threshold
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Elements of A are copied to D while clipping elements that are outside the interval [B, C] to the endpoints.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vclr

Vector clear; single precision.

void vDSP_vclr (
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

All elements of vector C are set to zeros.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vclrD

Vector clear; double precision.

void vDSP_vclrD (
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

All elements of vector C are set to zeros.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vcmprs

Vector compress; single precision.

void vDSP_vcmprs (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Compresses vector A based on the nonzero values of gating vector B. For nonzero elements of B, corresponding elements of A are sequentially copied to output vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vcmprsD

Vector compress; double precision.

void vDSP_vcmprsD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Compresses vector A based on the nonzero values of gating vector B. For nonzero elements of B, corresponding elements of A are sequentially copied to output vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vdbcon

Vector convert power or amplitude to decibels; single precision.

void vDSP_vdbcon (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   unsigned int __vDSP_F
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input scalar: zero reference
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process
__vDSP_F: Power (0) or amplitude (1) flag

Discussion

Performs the following operation. α is 20 if F is 1, or 10 if F is 0.

Converts inputs from vector A to their decibel equivalents, calculated in terms of power or amplitude according to flag F. As a relative reference point, the value of input scalar B is considered to be zero decibels.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vdbconD

Vector convert power or amplitude to decibels; double precision.

void vDSP_vdbconD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   unsigned int __vDSP_F
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input scalar: zero reference
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process
__vDSP_F: Power (0) or amplitude (1) flag

Discussion

Performs the following operation:

The Greek letter alpha equals 20 if F = 1, and 10 if F = 0.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vdist

Vector distance; single precision.

void vDSP_vdist (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Computes the square root of the sum of the squares of corresponding elements of vectors A and B, and stores the result in the corresponding element of vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vdistD

Vector distance; double precision.

void vDSP_vdistD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Computes the square root of the sum of the squares of corresponding elements of vectors A and B, and stores the result in the corresponding element of vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vdiv

Vector divide; single precision.

void vDSP_vdiv (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Divides elements of vector B by corresponding elements of vector A, and stores the results in corresponding elements of vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vdivD

Vector divide; double precision.

void vDSP_vdivD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Divides elements of vector B by corresponding elements of vector A, and stores the results in corresponding elements of vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vdivi

Vector divide; integer.

void vDSP_vdivi (
   int *__vDSP_A,
   vDSP_Stride __vDSP_I,
   int *__vDSP_B,
   vDSP_Stride __vDSP_J,
   int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Integer input vector
__vDSP_I: Stride for A
__vDSP_B: Integer input vector
__vDSP_J: Stride for B
__vDSP_C: Integer output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Divides elements of vector B by corresponding elements of vector A, and stores the results in corresponding elements of vector C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vdpsp

Vector convert double-precision to single-precision.

void vDSP_vdpsp (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Creates single-precision vector C by converting double-precision inputs from vector A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_venvlp

Vector envelope; single precision.

void vDSP_venvlp (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector: high envelope
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector: low envelope
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Finds the extrema of vector C. For each element of C, the corresponding element of A provides an upper-threshold value, and the corresponding element of B provides a lower-threshold value. If the value of an element of C falls outside the range defined by these thresholds, it is copied to the corresponding element of vector D. If its value is within the range, the corresponding element of vector D is set to zero.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_venvlpD

Vector envelope; double precision.

void vDSP_venvlpD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector: high envelope
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector: low envelope
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_veqvi

Vector equivalence, 32-bit logical.

void vDSP_veqvi (
   int *__vDSP_A,
   vDSP_Stride __vDSP_I,
   int *__vDSP_B,
   vDSP_Stride __vDSP_J,
   int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Integer input vector
__vDSP_I: Stride for A
__vDSP_B: Integer input vector
__vDSP_J: Stride for B
__vDSP_C: Integer output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Outputs the bitwise logical equivalence, exclusive NOR, of the integers of vectors A and B. For each pair of input values, bits in each position are compared. A bit in the output value is set if both input bits are set, or both are clear; otherwise it is cleared.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfill

Vector fill; single precision.

void vDSP_vfill (
   float *__vDSP_A,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input scalar
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Sets each element of vector C to the value of A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfillD

Vector fill; double precision.

void vDSP_vfillD (
   double *__vDSP_A,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input scalar
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Sets each element of vector C to the value of A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfilli

Integer vector fill.

void vDSP_vfilli (
   int *__vDSP_A,
   int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Integer input scalar
__vDSP_C: Integer output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Sets each element of vector C to the value of A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfix16

Converts an array of single-precision floating-point values to signed 16-bit integer values, rounding towards zero.

void vDSP_vfix16 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   short *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

If the resulting value is outside the bounds of the output type, the behavior is undefined. If you need to handle out-of-bounds data, you should use one of the functions in “Single-Vector Clipping, Limit, and Threshold Operations” on the data first.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfix16D

Converts an array of double-precision floating-point values to signed 16-bit integer values, rounding towards zero.

void vDSP_vfix16D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   short *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfix32

Converts an array of single-precision floating-point values to signed 32-bit integer values, rounding towards zero.

void vDSP_vfix32 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfix32D

Converts an array of double-precision floating-point values to signed 16-bit integer values, rounding towards zero.

void vDSP_vfix32D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfix8

Converts an array of single-precision floating-point values to signed 8-bit integer values, rounding towards zero.

void vDSP_vfix8 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   char *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfix8D

Converts an array of double-precision floating-point values to signed 8-bit integer values, rounding towards zero.

void vDSP_vfix8D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   char *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixr16

Converts an array of single-precision floating-point values to signed 16-bit integer values, rounding towards nearest integer.

void vDSP_vfixr16 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   short *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixr16D

Converts an array of double-precision floating-point values to signed 16-bit integer values, rounding towards nearest integer.

void vDSP_vfixr16D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   short *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixr32

Converts an array of single-precision floating-point values to signed 32-bit integer values, rounding towards nearest integer.

void vDSP_vfixr32 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixr32D

Converts an array of double-precision floating-point values to signed 32-bit integer values, rounding towards nearest integer.

void vDSP_vfixr32D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixr8

Converts an array of single-precision floating-point values to signed 8-bit integer values, rounding towards nearest integer.

void vDSP_vfixr8 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   char *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixr8D

Converts an array of double-precision floating-point values to signed 8-bit integer values, rounding towards nearest integer.

void vDSP_vfixr8D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   char *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixru16

Converts an array of single-precision floating-point values to unsigned 16-bit integer values, rounding towards nearest integer.

void vDSP_vfixru16 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned short *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixru16D

Converts an array of double-precision floating-point values to unsigned 16-bit integer values, rounding towards nearest integer.

void vDSP_vfixru16D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned short *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixru32

Converts an array of single-precision floating-point values to unsigned 32-bit integer values, rounding towards nearest integer.

void vDSP_vfixru32 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixru32D

Converts an array of double-precision floating-point values to unsigned 32-bit integer values, rounding towards nearest integer.

void vDSP_vfixru32D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixru8

Converts an array of single-precision floating-point values to unsigned 8-bit integer values, rounding towards nearest integer.

void vDSP_vfixru8 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned char *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixru8D

Converts an array of double-precision floating-point values to unsigned 8-bit integer values, rounding towards nearest integer.

void vDSP_vfixru8D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned char *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixu16

Converts an array of single-precision floating-point values to unsigned 16-bit integer values, rounding towards zero.

void vDSP_vfixu16 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned short *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixu16D

Converts an array of double-precision floating-point values to unsigned 16-bit integer values, rounding towards zero.

void vDSP_vfixu16D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned short *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixu32

Converts an array of single-precision floating-point values to unsigned 32-bit integer values, rounding towards zero.

void vDSP_vfixu32 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixu32D

Converts an array of double-precision floating-point values to unsigned 32-bit integer values, rounding towards zero.

void vDSP_vfixu32D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned int *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixu8

Converts an array of single-precision floating-point values to unsigned 8-bit integer values, rounding towards zero.

void vDSP_vfixu8 (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned char *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfixu8D

Converts an array of double-precision floating-point values to unsigned 8-bit integer values, rounding towards zero.

void vDSP_vfixu8D (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   unsigned char *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Discussion

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vflt16

Converts an array of signed 16-bit integers to single-precision floating-point values.

void vDSP_vflt16 (
   short *A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vflt16D

Converts an array of signed 16-bit integers to double-precision floating-point values.

void vDSP_vflt16D (
   short *A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vflt32

Converts an array of signed 32-bit integers to single-precision floating-point values.

void vDSP_vflt32 (
   int *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vflt32D

Converts an array of signed 32-bit integers to double-precision floating-point values.

void vDSP_vflt32D (
   int *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vflt8

Converts an array of signed 8-bit integers to single-precision floating-point values.

void vDSP_vflt8 (
   char *A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vflt8D

Converts an array of signed 8-bit integers to double-precision floating-point values.

void vDSP_vflt8D (
   char *A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfltu16

Converts an array of unsigned 16-bit integers to single-precision floating-point values.

void vDSP_vfltu16 (
   unsigned short *A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfltu16D

Converts an array of unsigned 16-bit integers to double-precision floating-point values.

void vDSP_vfltu16D (
   unsigned short *A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfltu32

Converts an array of unsigned 32-bit integers to single-precision floating-point values.

void vDSP_vfltu32 (
   unsigned int *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfltu32D

Converts an array of unsigned 32-bit integers to double-precision floating-point values.

void vDSP_vfltu32D (
   unsigned int *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfltu8

Converts an array of unsigned 8-bit integers to single-precision floating-point values.

void vDSP_vfltu8 (
   unsigned char *A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfltu8D

Converts an array of unsigned 8-bit integers to double-precision floating-point values.

void vDSP_vfltu8D (
   unsigned char *A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

A: Source vector.
__vDSP_I: Source vector stride length.
__vDSP_C: Destination vector.
__vDSP_K: Destination vector stride length.
__vDSP_N: Number of elements in vector.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfrac

Vector truncate to fraction; single precision.

void vDSP_vfrac (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

The "function" truncate(x) is the integer farthest from 0 but not farther than x. Thus, for example, vDSP_vFrac(-3.25) produces the result -0.25.

Sets each element of vector C to the signed fractional part of the corresponding element of A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vfracD

Vector truncate to fraction; double precision.

void vDSP_vfracD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

The "function" truncate(x) is the integer farthest from 0 but not farther than x. Thus, for example, vDSP_vFrac(-3.25) produces the result -0.25.

Sets each element of vector C to the signed fractional part of the corresponding element of A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vgathr

Vector gather; single precision.

void vDSP_vgathr (
   float *__vDSP_A,
   vDSP_Length *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_B: Integer vector containing indices
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Uses elements of vector B as indices to copy selected elements of vector A to sequential locations in vector C. Note that 1, not zero, is treated as the first location in the input vector when evaluating indices. This function can only be done out of place.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vgathra

Vector gather, absolute pointers; single precision.

void vDSP_vgathra (
   float **A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Pointer input vector
__vDSP_I: Stride for A
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Uses elements of vector A as pointers to copy selected single-precision values from memory to sequential locations in vector C. This function can only be done out of place.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vgathraD

Vector gather, absolute pointers; double precision.

void vDSP_vgathraD (
   double **A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Pointer input vector
__vDSP_I: Stride for A
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Uses elements of vector A as pointers to copy selected double-precision values from memory to sequential locations in vector C. This function can only be done out of place.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vgathrD

Vector gather; double precision.

void vDSP_vgathrD (
   double *__vDSP_A,
   vDSP_Length *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_B: Integer vector containing indices
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vgen

Vector tapered ramp; single precision.

void vDSP_vgen (
   float *__vDSP_A,
   float *__vDSP_B,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input scalar: base value
__vDSP_B: Single-precision real input scalar: end value
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Creates ramped vector C with element zero equal to scalar A and element N-1 equal to scalar B. Output values between element zero and element N-1 are evenly spaced and increase or decrease monotonically.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vgenD

Vector tapered ramp; double precision.

void vDSP_vgenD (
   double *__vDSP_A,
   double *__vDSP_B,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input scalar: base value
__vDSP_B: Double-precision real input scalar: end value
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vgenp

Vector generate by extrapolation and interpolation; single precision.

void vDSP_vgenp (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_M
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: Element count for C
__vDSP_M: Element count for A and B

Discussion

Performs the following operation:

Generates vector C by extrapolation and linear interpolation from the ordered pairs (A,B) provided by corresponding elements in vectors A and B. Vector B provides index values and should increase monotonically. Vector A provides intensities, magnitudes, or some other measurable quantities, one value associated with each value of B. This function can only be done out of place.

Vectors A and B define a piecewise linear function, f(x):

In the interval [-infinity, trunc(B[0*J]], the function is the constant A[0*I].
In each interval (trunc(B[m*J]), trunc(B[(m+1)*J])], the function is the line passing through the two points (B[m*J], A[m*I]) and (B[(m+1)*J], A[(m+1)*I]). (This is for each integer m, 0 <= m < M-1.)
In the interval (B[(M-1)*J], infinity], the function is the constant A[(M-1)*I].
For 0 <= n < N, C[n*K] = f(n).

This function can only be done out of place.

Output values are generated for integral indices in the range zero through N - 1, deriving output values by interpolating and extrapolating from vectors A and B. For example, if vectors A and B define velocity and time pairs (v, t), vDSP_vgenp writes one velocity to vector C for every integral unit of time from zero to N - 1.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vgenpD

Vector generate by extrapolation and interpolation; double precision.

void vDSP_vgenpD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_M
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: Element count for C
__vDSP_M: Element count for A and B

Discussion

Performs the following operation:

Vectors A and B define a piecewise linear function, f(x):

In the interval [-infinity, trunc(B[0*J]], the function is the constant A[0*I].
In each interval (trunc(B[m*J]), trunc(B[(m+1)*J])], the function is the line passing through the two points (B[m*J], A[m*I]) and (B[(m+1)*J], A[(m+1)*I]). (This is for each integer m, 0 <= m < M-1.)
In the interval (B[(M-1)*J], infinity], the function is the constant A[(M-1)*I].
For 0 <= n < N, C[n*K] = f(n).

This function can only be done out of place.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_viclip

Vector inverted clip; single precision.

void vDSP_viclip (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   float *__vDSP_C,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input scalar: lower threshold
__vDSP_C: Single-precision real input scalar: upper threshold
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Performs an inverted clip of vector A using lower-threshold and upper-threshold input scalars B and C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_viclipD

Vector inverted clip; double precision.

void vDSP_viclipD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   double *__vDSP_C,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input scalar: lower threshold
__vDSP_C: Double-precision real input scalar: upper threshold
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Performs an inverted clip of vector A using lower-threshold and upper-threshold input scalars B and C.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vindex

Vector index; single precision.

void vDSP_vindex (
   float *__vDSP_A,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_B: Single-precision real input vector: indices
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Uses vector B as zero-based subscripts to copy selected elements of vector A to vector C. Fractional parts of vector B are ignored.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vindexD

Vector index; double precision.

void vDSP_vindexD (
   double *__vDSP_A,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_B: Double-precision real input vector: indices
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Uses vector B as zero-based subscripts to copy selected elements of vector A to vector C. Fractional parts of vector B are ignored.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vintb

Vector linear interpolation between vectors; single precision.

void vDSP_vintb (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input scalar: interpolation constant
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Creates vector D by interpolating between vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vintbD

Vector linear interpolation between vectors; double precision.

void vDSP_vintbD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input scalar: interpolation constant
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Creates vector D by interpolating between vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vlim

Vector test limit; single precision.

void vDSP_vlim (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   float *__vDSP_C,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input scalar: limit
__vDSP_C: Single-precision real input scalar
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

Compares values from vector A to limit scalar B. For inputs greater than or equal to B, scalar C is written to D . For inputs less than B, the negated value of scalar C is written to vector D.

This calculates the following:

    for (n = 0; n < N; ++n)

        if (*B <= A[n*I])

            D[n*L] = *C;

        else

            D[n*L] = -(*C);

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vlimD

Vector test limit; double precision.

void vDSP_vlimD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   double *__vDSP_C,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input scalar: limit
__vDSP_C: Double-precision real input scalar
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This calculates the following:

    for (n = 0; n < N; ++n)

        if (*B <= A[n*I])

            D[n*L] = *C;

        else

            D[n*L] = -(*C);

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vlint

Vector linear interpolation between neighboring elements; single precision.

void vDSP_vlint (
   float *__vDSP_A,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_M
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_B: Single-precision real input vector: integer parts are indices into A and fractional parts are interpolation constants
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: Element count for C
__vDSP_M: Length of A

Discussion

Performs the following operation:

Generates vector C by interpolating between neighboring values of vector A as controlled by vector B. The integer portion of each element in B is the zero-based index of the first element of a pair of adjacent values in vector A.

The value of the corresponding element of C is derived from these two values by linear interpolation, using the fractional part of the value in B.

Argument M is not used in the calculation. However, the integer parts of the values in B must be greater than or equal to zero and less than or equal to M - 2.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vlintD

Vector linear interpolation between neighboring elements; double precision.

void vDSP_vlintD (
   double *__vDSP_A,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_M
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_B: Double-precision real input vector: integer parts are indices into A and fractional parts are interpolation constants
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: Element count for C
__vDSP_M: Length of A

Discussion

Performs the following operation:

The value of the corresponding element of C is derived from these two values by linear interpolation, using the fractional part of the value in B.

Argument M is not used in the calculation. However, the integer parts of the values in B must be greater than or equal to zero and less than or equal to M - 2.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vma

Vector multiply and add; single precision.

void vDSP_vma (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Multiplies corresponding elements of vectors A and B, add the corresponding elements of vector C, and stores the results in vector D.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmaD

Vector multiply and add; double precision.

void vDSP_vmaD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Multiplies corresponding elements of vectors A and B, add the corresponding elements of vector C, and stores the results in vector D.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmax

Vector maxima; single precision.

void vDSP_vmax (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each element of output vector C is the greater of the corresponding values from input vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmaxD

Vector maxima; double precision.

void vDSP_vmaxD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each element of output vector C is the greater of the corresponding values from input vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmaxmg

Vector maximum magnitudes; single precision.

void vDSP_vmaxmg (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each element of output vector C is the larger of the magnitudes of corresponding values from input vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmaxmgD

Vector maximum magnitudes; double precision.

void vDSP_vmaxmgD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each element of output vector C is the larger of the magnitudes of corresponding values from input vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmin

Vector minima; single precision.

void vDSP_vmin (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each element of output vector C is the lesser of the corresponding values from input vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vminD

Vector minima; double precision.

void vDSP_vminD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each element of output vector C is the lesser of the corresponding values from input vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vminmg

Vector minimum magnitudes; single precision.

void vDSP_vminmg (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each element of output vector C is the smaller of the magnitudes of corresponding values from input vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vminmgD

Vector minimum magnitudes; double precision.

void vDSP_vminmgD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each element of output vector C is the smaller of the magnitudes of corresponding values from input vectors A and B.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmma

Vector multiply, multiply, and add; single precision.

void vDSP_vmma (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   float *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Single-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Single-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Corresponding elements of A and B are multiplied, corresponding values of C and D are multiplied, and these products are added together and stored in E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmmaD

Vector multiply, multiply, and add; double precision.

void vDSP_vmmaD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   double *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Double-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Double-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Corresponding elements of A and B are multiplied, corresponding values of C and D are multiplied, and these products are added together and stored in E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmmsb

Vector multiply, multiply, and subtract; single precision.

void vDSP_vmmsb (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   float *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Single-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Single-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Corresponding elements of A and B are multiplied, corresponding values of C and D are multiplied, and the second product is subtracted from the first. The result is stored in E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmmsbD

Vector multiply, multiply, and subtract; double precision.

void vDSP_vmmsbD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   double *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Double-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Double-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Corresponding elements of A and B are multiplied, corresponding values of C and D are multiplied, and the second product is subtracted from the first. The result is stored in E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmsa

Vector multiply and scalar add; single precision.

void vDSP_vmsa (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input scalar
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Corresponding elements of A and B are multiplied and the scalar C is added. The result is stored in D.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmsaD

Vector multiply and scalar add; double precision.

void vDSP_vmsaD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input scalar
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Corresponding elements of A and B are multiplied and the scalar C is added. The result is stored in D.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmsb

Vector multiply and subtract, single precision.

void vDSP_vmsb (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Single-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Corresponding elements of A and B are multiplied and the corresponding value of C is subtracted. The result is stored in D.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmsbD

Vector multiply and subtract; double precision.

void vDSP_vmsbD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Double-precision real output vector
__vDSP_L: Stride for D
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Corresponding elements of A and B are multiplied and the corresponding value of C is subtracted. The result is stored in D.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmul

Multiplies vector A by vector B and leaves the result in vector C; single precision.

void vDSP_vmul (
   const float __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const float __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   float __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_input1: Input vector
__vDSP_stride1: Address stride for __vDSP_input1
__vDSP_input2: Input vector
__vDSP_stride2: Address stride for __vDSP_stride2
__vDSP_result: Output vector
__vDSP_strideResult: Address stride for __vDSP_result
__vDSP_size: Complex output count

Discussion

This performs the following operation:

where A is __vDSP_input1, B is __vDSP_input2, C is __vDSP_result, I is __vDSP_stride1, J is __vDSP_stride2, K is __vDSP_strideResult, and N is __vDSP_size.

Availability

Available in OS X v10.4 and later.

Related Sample Code

Core Audio Utility Classes

Declared In

vDSP.h

vDSP_vmul

Translation macro from vDSP_vmul to vmul.

#define vDSP_vmul vmul

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_vmulD

Multiplies vector A by vector B and leaves the result in vector C; double precision.

void vDSP_vmulD (
   const double __vDSP_input1[],
   vDSP_Stride __vDSP_stride1,
   const double __vDSP_input2[],
   vDSP_Stride __vDSP_stride2,
   double __vDSP_result[],
   vDSP_Stride __vDSP_strideResult,
   vDSP_Length __vDSP_size
);

Parameters

__vDSP_input1: Input vector
__vDSP_stride1: Address stride for __vDSP_input1
__vDSP_input2: Input vector
__vDSP_stride2: Address stride for __vDSP_stride2
__vDSP_result: Output vector
__vDSP_strideResult: Address stride for __vDSP_result
__vDSP_size: Complex output count

Discussion

This performs the following operation:

where A is __vDSP_input1, B is __vDSP_input2, C is __vDSP_result, I is __vDSP_stride1, J is __vDSP_stride2, K is __vDSP_strideResult, and N is __vDSP_size.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vmulD

Translation macro from vDSP_vmulD to vmulD.

#define vDSP_vmulD vmulD

Discussion

See “Legacy Macros” for more information.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP_translate.h

vDSP_vnabs

Vector negative absolute values; single precision.

void vDSP_vnabs (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for __vDSP_A
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for __vDSP_C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each value in __vDSP_C is the negated absolute value of the corresponding element in __vDSP_A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vnabsD

Vector negative absolute values; double precision.

void vDSP_vnabsD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for __vDSP_A
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for __vDSP_C
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Each value in __vDSP_C is the negated absolute value of the corresponding element in __vDSP_A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vneg

Vector negative values; single precision.

void vDSP_vneg (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for __vDSP_A
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for __vDSP_C
__vDSP_N: The number of elements to process

Discussion

This calculates the following:

    for (n = 0; n < N; ++n)

        C[n*K] = -A[n*I];

Each value in __vDSP_C is replaced by the negated value of the corresponding element in __vDSP_A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vnegD

Vector negative values; double precision.

void vDSP_vnegD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

This calculates the following:

    for (n = 0; n < N; ++n)

        C[n*K] = -A[n*I];

Each value in C is replaced by the negated value of the corresponding element in A.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vpoly

Vector polynomial evaluation; single precision.

void vDSP_vpoly (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_P
);

Parameters

__vDSP_A: Single-precision real input vector: coefficients
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector: variable values
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process
__vDSP_P: Degree of polynomial

Discussion

This performs the following operation:

Evaluates polynomials using vector B as independent variables and vector A as coefficients. A polynomial of degree p requires p+1 coefficients, so vector A should contain P+1 values.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vpolyD

Vector polynomial evaluation; double precision.

void vDSP_vpolyD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_P
);

Parameters

__vDSP_A: Double-precision real input vector: coefficients
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector: variable values
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process
__vDSP_P: Degree of polynomial

Discussion

This performs the following operation:

Evaluates polynomials using vector B as independent variables and vector A as coefficients. A polynomial of degree p requires p+1 coefficients, so vector A should contain P+1 values.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vpythg

Vector Pythagoras; single precision.

void vDSP_vpythg (
   float *__vDSP_A,
   vDSP_Stride __vDSP_I,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   float *__vDSP_D,
   vDSP_Stride __vDSP_L,
   float *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Single-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Single-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Single-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Single-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Subtracts vector C from A and squares the differences, subtracts vector D from B and squares the differences, adds the two sets of squared differences, and then writes the square roots of the sums to vector E.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vpythgD

Vector Pythagoras; double precision.

void vDSP_vpythgD (
   double *__vDSP_A,
   vDSP_Stride __vDSP_I,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   double *__vDSP_D,
   vDSP_Stride __vDSP_L,
   double *__vDSP_E,
   vDSP_Stride __vDSP_M,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_I: Stride for A
__vDSP_B: Double-precision real input vector
__vDSP_J: Stride for B
__vDSP_C: Double-precision real input vector
__vDSP_K: Stride for C
__vDSP_D: Double-precision real input vector
__vDSP_L: Stride for D
__vDSP_E: Double-precision real output vector
__vDSP_M: Stride for E
__vDSP_N: The number of elements to process

Discussion

This performs the following operation:

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vqint

Vector quadratic interpolation; single precision.

void vDSP_vqint (
   float *__vDSP_A,
   float *__vDSP_B,
   vDSP_Stride __vDSP_J,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_M
);

Parameters

__vDSP_A: Single-precision real input vector
__vDSP_B: Single-precision real input vector: integer parts are indices into A and fractional parts are interpolation constants
__vDSP_J: Stride for B
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: Count for C
__vDSP_M: Length of A: must be greater than or equal to 3

Discussion

This performs the following operation:

The value of the corresponding element of C is derived from these three values by quadratic interpolation, using the fractional part of the value in B.

Argument M is not used in the calculation. However, the integer parts of the values in B must be less than or equal to M - 2.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vqintD

Vector quadratic interpolation; double precision.

void vDSP_vqintD (
   double *__vDSP_A,
   double *__vDSP_B,
   vDSP_Stride __vDSP_J,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N,
   vDSP_Length __vDSP_M
);

Parameters

__vDSP_A: Double-precision real input vector
__vDSP_B: Double-precision real input vector: integer parts are indices into A and fractional parts are interpolation constants
__vDSP_J: Stride for B
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: Count for C
__vDSP_M: Length of A: must be greater than or equal to 3

Discussion

This performs the following operation:

The value of the corresponding element of C is derived from these three values by quadratic interpolation, using the fractional part of the value in B.

Argument M is not used in the calculation. However, the integer parts of the values in B must be less than or equal to M - 2.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vramp

Build ramped vector; single precision.

void vDSP_vramp (
   float *__vDSP_A,
   float *__vDSP_B,
   float *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Single-precision real input scalar: initial value
__vDSP_B: Single-precision real input scalar: increment or decrement
__vDSP_C: Single-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Creates a monotonically incrementing or decrementing vector. Scalar A is the initial value written to vector C. Scalar B is the increment or decrement for each succeeding element.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vrampD

Build ramped vector; double precision.

void vDSP_vrampD (
   double *__vDSP_A,
   double *__vDSP_B,
   double *__vDSP_C,
   vDSP_Stride __vDSP_K,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_A: Double-precision real input scalar: initial value
__vDSP_B: Double-precision real input scalar: increment or decrement
__vDSP_C: Double-precision real output vector
__vDSP_K: Stride for C
__vDSP_N: The number of elements to process

Discussion

Performs the following operation:

Creates a monotonically incrementing or decrementing vector. Scalar A is the initial value written to vector C. Scalar B is the increment or decrement for each succeeding element.

Availability

Available in OS X v10.4 and later.

Declared In

vDSP.h

vDSP_vrampmul

Builds a ramped vector and multiplies by a source vector.

void vDSP_vrampmul (
   const float *__vDSP_I,
   vDSP_Stride __vDSP_IS,
   float *__vDSP_Start,
   const float *__vDSP_Step,
   float *__vDSP_O,
   vDSP_Stride __vDSP_OS,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_I: Input vector, multiplied by the ramp function.
__vDSP_IS: Stride length in input vector. For example, if __vDSP_IS is 2, every second element is used.
__vDSP_Start: The initial value for the ramp function. Modified on return to hold the next value (including accumulated errors) so that the ramp function can be continued smoothly.
__vDSP_Step: The value to increment each subsequent value of the ramp function by.
__vDSP_O: The output vector.
__vDSP_OS: Stride length in output vector. For example, if __vDSP_IS is 2, every second element is modified.
__vDSP_N: The number of elements to modify.

Discussion

This routine calculates the following:

for (i = 0; i < N; ++i) {

    O[i*OS] = *Start * I[i*IS];

    *Start += *Step;

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_vrampmul2

Stereo version of vDSP_vrampmul.

void vDSP_vrampmul2 (
   const float *__vDSP_I0,
   const float *__vDSP_I1,
   vDSP_Stride __vDSP_IS,
   float *__vDSP_Start,
   const float *__vDSP_Step,
   float *__vDSP_O0,
   float *__vDSP_O1,
   vDSP_Stride __vDSP_OS,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_I0: First input vector, multiplied by the ramp function.
__vDSP_I1: Second input vector, multiplied by the ramp function.
__vDSP_IS: Stride length in input vectors. For example, if __vDSP_IS is 2, every second element is used.
__vDSP_Start: The initial value for the ramp function. Modified on return to hold the next value (including accumulated errors) so that the ramp function can be continued smoothly.
__vDSP_Step: The value to increment each subsequent value of the ramp function by.
__vDSP_O0: First output vector.
__vDSP_O1: Second output vector.
__vDSP_OS: Stride length in output vector. For example, if __vDSP_IS is 2, every second element is modified.
__vDSP_N: The number of elements to modify.

Discussion

This function calculates the following:

 for (i = 0; i < N; ++i) {

    O0[i*OS] = *Start * I0[i*IS];

    O1[i*OS] = *Start * I1[i*IS];

    *Start += *Step;

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_vrampmul2_s1_15

Vector fixed-point 1.15 format version of vDSP_vrampmul2.

void vDSP_vrampmul2_s1_15 (
   const short int *__vDSP_I0,
   const short int *__vDSP_I1,
   vDSP_Stride __vDSP_IS,
   short int *__vDSP_Start,
   const short int *__vDSP_Step,
   short int *__vDSP_O0,
   short int *__vDSP_O1,
   vDSP_Stride __vDSP_OS,
   vDSP_Length __vDSP_N
);

Parameters

__vDSP_I0: First input vector, multiplied by the ramp function.
__vDSP_I1: Second input vector, multiplied by the ramp function.
__vDSP_IS: Stride length in input vectors. For example, if __vDSP_IS is 2, every second element is used.
__vDSP_Start: The initial value for the ramp function. Modified on return to hold the next value (including accumulated errors) so that the ramp function can be continued smoothly.
__vDSP_Step: The value to increment each subsequent value of the ramp function by.
__vDSP_O0: First output vector.
__vDSP_O1: Second output vector.
__vDSP_OS: Stride length in output vector. For example, if __vDSP_IS is 2, every second element is modified.
__vDSP_N: The number of elements to modify.

Discussion

This function calculates the following:

 for (i = 0; i < N; ++i) {

    O0[i*OS] = *Start * I0[i*IS];

    O1[i*OS] = *Start * I1[i*IS];

    *Start += *Step;

The elements are fixed-point numbers, each with one sign bit and 15 fraction bits. A value in this representation can be converted to floating-point by dividing it by 32768.0.

Availability

Available in OS X v10.7 and later.

Declared In

vDSP.h

vDSP_vrampmul2_s8_24

Vector fixed-point 8.24 format version of vDSP_vrampmul2.

void vDSP_vrampmul2_s8_24 (
   const int *__vDSP_I0,
   const int *__vDSP_I1,
   vDSP_Stride __vDSP_IS,
   int *__vDSP_Start,
   const int *__vDSP_Step,
   int *__vDSP_O0,
   int *__vDSP_O1,
   vDSP_Stride __vDSP_OS,
   vDSP_Length __vDSP_N
);