mlx_fft (mlx v0.2.0)

View Source

Summary

Types

array/0

-type array() :: reference().

dtype/0

-type dtype() :: atom().

shape/0

-type shape() :: [integer()].

Functions

bartlett(N)

-spec bartlett(integer()) -> {ok, array()} | {error, term()}.

blackman(N)

-spec blackman(integer()) -> {ok, array()} | {error, term()}.

convolve(Input, Kernel)

-spec convolve(array(), array()) -> {ok, array()} | {error, term()}.

convolve(Input, Kernel, Mode)

-spec convolve(array(), array(), atom()) -> {ok, array()} | {error, term()}.

correlate(Input, Kernel)

-spec correlate(array(), array()) -> {ok, array()} | {error, term()}.

correlate(Input, Kernel, Mode)

-spec correlate(array(), array(), atom()) -> {ok, array()} | {error, term()}.

fft2(Input)

-spec fft2(array()) -> {ok, array()} | {error, term()}.

fft2(Input, S)

-spec fft2(array(), shape() | undefined) -> {ok, array()} | {error, term()}.

fft(Input)

-spec fft(array()) -> {ok, array()} | {error, term()}.

fft(Input, N)

-spec fft(array(), integer() | undefined) -> {ok, array()} | {error, term()}.

fftfreq(N, D)

-spec fftfreq(integer(), number()) -> {ok, array()} | {error, term()}.

fftfreq(N, D, Dtype)

-spec fftfreq(integer(), number(), dtype()) -> {ok, array()} | {error, term()}.

fftn(Input)

-spec fftn(array()) -> {ok, array()} | {error, term()}.

fftn(Input, S)

-spec fftn(array(), shape() | undefined) -> {ok, array()} | {error, term()}.

fftn(Input, S, Axes)

-spec fftn(array(), shape() | undefined, [integer()] | undefined) -> {ok, array()} | {error, term()}.

fftshift(Input)

-spec fftshift(array()) -> {ok, array()} | {error, term()}.

fftshift(Input, Axes)

-spec fftshift(array(), [integer()] | undefined) -> {ok, array()} | {error, term()}.

hamming(N)

-spec hamming(integer()) -> {ok, array()} | {error, term()}.

hann(N)

-spec hann(integer()) -> {ok, array()} | {error, term()}.

ifft2(Input)

-spec ifft2(array()) -> {ok, array()} | {error, term()}.

ifft2(Input, S)

-spec ifft2(array(), shape() | undefined) -> {ok, array()} | {error, term()}.

ifft(Input)

-spec ifft(array()) -> {ok, array()} | {error, term()}.

ifft(Input, N)

-spec ifft(array(), integer() | undefined) -> {ok, array()} | {error, term()}.

ifftn(Input)

-spec ifftn(array()) -> {ok, array()} | {error, term()}.

ifftn(Input, S)

-spec ifftn(array(), shape() | undefined) -> {ok, array()} | {error, term()}.

ifftn(Input, S, Axes)

-spec ifftn(array(), shape() | undefined, [integer()] | undefined) -> {ok, array()} | {error, term()}.

ifftshift(Input)

-spec ifftshift(array()) -> {ok, array()} | {error, term()}.

ifftshift(Input, Axes)

-spec ifftshift(array(), [integer()] | undefined) -> {ok, array()} | {error, term()}.

irfft2(Input)

-spec irfft2(array()) -> {ok, array()} | {error, term()}.

irfft2(Input, S)

-spec irfft2(array(), shape() | undefined) -> {ok, array()} | {error, term()}.

irfft(Input)

-spec irfft(array()) -> {ok, array()} | {error, term()}.

irfft(Input, N)

-spec irfft(array(), integer() | undefined) -> {ok, array()} | {error, term()}.

irfftn(Input)

-spec irfftn(array()) -> {ok, array()} | {error, term()}.

irfftn(Input, S)

-spec irfftn(array(), shape() | undefined) -> {ok, array()} | {error, term()}.

irfftn(Input, S, Axes)

-spec irfftn(array(), shape() | undefined, [integer()] | undefined) -> {ok, array()} | {error, term()}.

istft(Stft, Window)

-spec istft(array(), array()) -> {ok, array()} | {error, term()}.

istft(Stft, Window, HopLength)

-spec istft(array(), array(), integer()) -> {ok, array()} | {error, term()}.

rfft2(Input)

-spec rfft2(array()) -> {ok, array()} | {error, term()}.

rfft2(Input, S)

-spec rfft2(array(), shape() | undefined) -> {ok, array()} | {error, term()}.

rfft(Input)

-spec rfft(array()) -> {ok, array()} | {error, term()}.

rfft(Input, N)

-spec rfft(array(), integer() | undefined) -> {ok, array()} | {error, term()}.

rfftfreq(N, D)

-spec rfftfreq(integer(), number()) -> {ok, array()} | {error, term()}.

rfftfreq(N, D, Dtype)

-spec rfftfreq(integer(), number(), dtype()) -> {ok, array()} | {error, term()}.

rfftn(Input)

-spec rfftn(array()) -> {ok, array()} | {error, term()}.

rfftn(Input, S)

-spec rfftn(array(), shape() | undefined) -> {ok, array()} | {error, term()}.

rfftn(Input, S, Axes)

-spec rfftn(array(), shape() | undefined, [integer()] | undefined) -> {ok, array()} | {error, term()}.

stft(Input, Window)

-spec stft(array(), array()) -> {ok, array()} | {error, term()}.

stft(Input, Window, NpFft)

-spec stft(array(), array(), integer()) -> {ok, array()} | {error, term()}.

stft(Input, Window, NpFft, HopLength)

-spec stft(array(), array(), integer(), integer()) -> {ok, array()} | {error, term()}.