Classes, Structs & Unions¶

A¶

• class kfr::abstract_reader<T> Base class for all typed readers
• class kfr::abstract_stream<T> Base class for all typed readers and writer
• class kfr::abstract_vector<T, Size>
• class kfr::abstract_vector<T, tag_array_ref>
• class kfr::abstract_vector<T, tag_dynamic_vector>
• class kfr::abstract_writer<T> Base class for all typed writers
• struct kfr::aiff_decoding_options Options for decoding AIFF audio files.
• struct kfr::aiff_encoding_options Represents options for AIFF audio encoding.
• struct kfr::aligned_new
• class kfr::array_ref<T> Reference to array
• class kfr::audio_data<Interleaved> Contiguous audio buffer with optional interleaving.
• struct kfr::audio_decoder Abstract base class for audio decoders providing methods for opening and reading audio files.
• struct kfr::audio_decoding_options Options for generic audio decoding.
• struct kfr::audio_dithering_state Represents the state of audio dithering.
• struct kfr::audio_encoder Abstract base class for audio encoders, providing methods for opening, writing, and closing audio files.
• struct kfr::audio_encoding_options Represents options for audio encoding, including dithering settings.
• struct kfr::audio_format
• struct kfr::audio_format_and_length
• struct kfr::audio_quantization Represents audio quantization parameters.
• struct kfr::audio_reader_flac<f32>
• struct kfr::audio_reader_flac<f64>
• struct kfr::audio_reader_flac<i16>
• struct kfr::audio_reader_flac<i24>
• struct kfr::audio_reader_flac<i32>
• class kfr::audio_reader_flac<T> FLAC format reader
• struct kfr::audio_reader_mp3<f32>
• struct kfr::audio_reader_mp3<f64>
• struct kfr::audio_reader_mp3<i16>
• struct kfr::audio_reader_mp3<i24>
• struct kfr::audio_reader_mp3<i32>
• class kfr::audio_reader_mp3<T> MP3 format reader
• struct kfr::audio_reader_wav<f32>
• struct kfr::audio_reader_wav<f64>
• struct kfr::audio_reader_wav<i16>
• struct kfr::audio_reader_wav<i24>
• struct kfr::audio_reader_wav<i32>
• class kfr::audio_reader_wav<T> WAV format reader
• class kfr::audio_reader<T>
• struct kfr::audio_sample_get_type<audio_sample_type::f32>
• struct kfr::audio_sample_get_type<audio_sample_type::f64>
• struct kfr::audio_sample_get_type<audio_sample_type::i16>
• struct kfr::audio_sample_get_type<audio_sample_type::i24>
• struct kfr::audio_sample_get_type<audio_sample_type::i32>
• class kfr::audio_sample_get_type<type>
• struct kfr::audio_sample_traits<f32>
• struct kfr::audio_sample_traits<f64>
• struct kfr::audio_sample_traits<i16>
• struct kfr::audio_sample_traits<i24>
• struct kfr::audio_sample_traits<i32>
• class kfr::audio_sample_traits<T>
• struct kfr::audio_stat Represents audio statistics such as peak and RMS values.
• struct kfr::audio_writer_wav<f32>
• struct kfr::audio_writer_wav<f64>
• struct kfr::audio_writer_wav<i16>
• struct kfr::audio_writer_wav<i24>
• struct kfr::audio_writer_wav<i32>
• class kfr::audio_writer_wav<T> WAV format writer
• class kfr::audio_writer<T>
• struct kfr::audiofile_format Represents the format of an audio file.
• class kfr::autofree<T> Smart pointer for aligned memory with automatic deallocation.
• class kfr::axis_params<Axis, N>

B¶

• class kfr::biquad_section<T> Structure for holding biquad filter coefficients.
• class kfr::biquad_state<T, filters>

C¶

• struct kfr::caff_decoding_options Options for decoding CAFF audio files.
• struct kfr::caff_encoding_options Represents options for CAFF audio encoding.
• struct kfr::cmp_eq
• struct kfr::cmp_ge
• struct kfr::cmp_gt
• struct kfr::cmp_le
• struct kfr::cmp_lt
• struct kfr::cmp_ne
• class std::common_type<kfr::complex<T1>, kfr::complex<T2>>
• class std::common_type<kfr::complex<T1>, kfr::vec<T2, N>>
• class std::common_type<kfr::complex<T1>, T2>
• class std::common_type<kfr::vec<T1, N>, kfr::complex<T2>>
• class std::common_type<T1, kfr::complex<T2>>
• class kfr::comparison<Fn, L, R>
• class kfr::compound_type_traits<std::complex<T>>
• class kfr::convolve_filter<T> Convolution using Filter API
• class kfr::cursor<Dims>
• class kfr::cvals_t<T, T>

D¶

• class kfr::data_allocator<T> Aligned allocator
• class kfr::dct_plan<T> DCT type 2 (unscaled)
• class kfr::generic::delay_state<T, 1, 1>
• class kfr::generic::delay_state<T, samples, Tag>
• class kfr::generic::dft_cache_impl<int>
• class kfr::dft_plan_md_real<T, Dims> Multidimensional DFT
• class kfr::dft_plan_md<T, Dims> Multidimensional DFT
• class kfr::dft_plan_real<T> Real-to-complex and Complex-to-real 1D DFT
• class kfr::dft_plan<T> Class for performing 1D DFT/FFT.
• class kfr::dft_stage<T> Internal structure representing a single DFT stage

E¶

• class kfr::generic::ebu_channel<T>
• class kfr::generic::ebu_r128<T>
• class kfr::epsilon_scope<T>
• struct kfr::epsilon_scope<void>
• class kfr::equality_comparer<L, R>
• class kfr::exception
• class kfr::expand_cvals<T, Tpl, cvals_t<T, vals...>>
• class kfr::expand_cvals<T, Tpl, Pack>
• class kfr::generic::expression_adjacent<Fn, E>
• class kfr::generic::expression_bartlett_hann<T>
• class kfr::generic::expression_bartlett<T>
• class kfr::generic::expression_blackman_harris<T>
• class kfr::generic::expression_blackman<T>
• class kfr::generic::expression_bohman<T>
• class kfr::expression_cast<T, Arg>
• class kfr::expression_concatenate<Arg1, Arg2, ConcatAxis>
• class kfr::generic::expression_cosine_np<T>
• class kfr::generic::expression_cosine<T>
• class kfr::expression_counter<T, Dims>
• class kfr::generic::expression_delay<1, E, stateless, STag>
• class kfr::generic::expression_delay<delay, E, stateless, STag>
• class kfr::generic::expression_dimensions<Dims, E>
• class kfr::generic::expression_discard<Tin, Dims>
• class kfr::expression_filter<T>
• class kfr::generic::expression_fir<T, U, E1, stateless>
• class kfr::expression_fixshape<Arg, Shape>
• class kfr::generic::expression_flattop<T>
• class kfr::generic::expression_function<Fn, Args>
• class kfr::generic::expression_gaussian<T>
• class kfr::generic::expression_goertzel<T>
• class kfr::generic::expression_hamming<T>
• class kfr::expression_handle<T, Dims>
• class kfr::generic::expression_hann<T>
• class kfr::generic::expression_histogram<Bins, E, TCount>
• class kfr::generic::expression_iir_l<filters, T, E1, Stateless>
• class kfr::generic::expression_iir<filters, T, E1, Stateless>
• class kfr::generic::expression_kaiser<T>
• class kfr::expression_lambda<T, Dims, Fn, Rnd>
• class kfr::generic::expression_lanczos<T>
• class kfr::expression_linspace<T, truncated>
• class kfr::generic::expression_moving_sum<U, E1, STag, stateless>
• class kfr::expression_padded<Arg>
• class kfr::generic::expression_parallel_goertzel<T, width>
• class kfr::expression_placeholder<T, Dims, Key>
• class kfr::generic::expression_planck_taper<T>
• class kfr::generic::expression_random_normal<T, Dims, Reference>
• class kfr::generic::expression_random_range<T, Dims, Reference>
• class kfr::generic::expression_random_uniform<T, Dims, Reference>
• class kfr::generic::expression_rectangular<T>
• class kfr::generic::expression_reduce<Tout, Dims, Twork, Tin, ReduceFn, TransformFn, FinalFn>
• class kfr::expression_reshape<Arg, OutDims>
• struct kfr::expression_resource
• class kfr::expression_resource_impl<E>
• class kfr::expression_reverse<Arg>
• class kfr::expression_scalar<T>
• class kfr::generic::expression_short_fir<tapcount, T, U, E1, stateless>
• class kfr::expression_slice<Arg>
• class kfr::generic::expression_trace<E>
• struct kfr::expression_traits_defaults
• class kfr::expression_traits<const T>
• class kfr::expression_traits<const T &>
• class kfr::expression_traits<const T &&>
• class kfr::expression_traits<expression_cast<T, Arg>>
• class kfr::expression_traits<expression_concatenate<Arg1, Arg2, ConcatAxis>>
• class kfr::expression_traits<expression_counter<T, Dims>>
• class kfr::expression_traits<expression_fixshape<Arg, fixed_shape_t<ShapeValues...>>>
• class kfr::expression_traits<expression_handle<T, Dims>>
• class kfr::expression_traits<expression_lambda<T, Dims, Fn, Rnd>>
• class kfr::expression_traits<expression_linspace<T, truncated>>
• class kfr::expression_traits<expression_padded<Arg>>
• class kfr::expression_traits<expression_placeholder<T, Dims, Key>>
• class kfr::expression_traits<expression_reshape<Arg, OutDims>>
• class kfr::expression_traits<expression_reverse<Arg>>
• class kfr::expression_traits<expression_scalar<T>>
• class kfr::expression_traits<expression_slice<Arg>>
• class kfr::expression_traits<strided_channel<T>>
• class kfr::expression_traits<T>
• class kfr::expression_traits<T &>
• class kfr::expression_traits<T &&>
• class kfr::expression_traits<T>
• class kfr::expression_traits<tensor<T, Dims>>
• class kfr::expression_traits<univector<T, Tag>>
• class kfr::generic::expression_triangular<T>
• class kfr::generic::expression_tukey<T>
• class kfr::generic::expression_unpack<E>
• class kfr::expression_vtable<T, Dims>
• class kfr::generic::expression_window_with_metrics<T, metrics>
• class kfr::generic::expression_window<T>
• class kfr::generic::expression_with_arguments<Arg>
• class kfr::generic::expression_with_arguments<Args>
• class kfr::generic::expression_with_traits<Arg>

F¶

• struct kfr::file_handle
• class kfr::file_reader<T> Typed file reader
• class kfr::file_writer<T> Typed file writer
• class kfr::filter<T> Abstract base class for filters with one argument. Mainly for DSP
• class kfr::fir_filter<T, U>
• class kfr::fir_params<T>
• class kfr::fir_state<T, U>
• class kfr::fixed_shape_t<Values>
• struct kfr::fraction

G¶

• class kfr::generic::generator_cossin<T, VecWidth>
• class kfr::generic::generator_exp2<T, VecWidth>
• class kfr::generic::generator_expj<T, VecWidth>
• class kfr::generic::generator_exp<T, VecWidth>
• class kfr::generic::generator_linear<T, VecWidth>
• class kfr::generic::generator_sin<T, VecWidth>
• class kfr::generic::generator<T, VecWidth, Class, Twork>

H¶

• class kfr::half_comparison<L>
• class kfr::generic::histogram_data<Bins, TCount>

I¶

• class kfr::iir_filter<T>
• class kfr::iir_params<T, filters>
• class kfr::iir_params<T, tag_dynamic_vector>
• class kfr::iir_state<T, filters>
• class kfr::inline_vector<T, N>
• class kfr::generic::integrated_vec<T>

K¶

• struct KFR_DCT_PLAN_F32
• struct KFR_DCT_PLAN_F64
• struct KFR_DFT_PLAN_F32
• struct KFR_DFT_PLAN_F64
• struct KFR_DFT_REAL_PLAN_F32
• struct KFR_DFT_REAL_PLAN_F64
• struct KFR_FILTER_C32
• struct KFR_FILTER_C64
• struct KFR_FILTER_F32
• struct KFR_FILTER_F64

L¶

• class kfr::lockfree_ring_buffer<T> Single producer single consumer lock-free ring buffer
• class kfr::logic_error
• class kfr::generic::lra_vec<T>

M¶

• struct kfr::make_comparison
• struct kfr::mediafoundation_decoding_options Options for decoding audio using Media Foundation.
• class kfr::memory_reader<T>
• class kfr::memory_writer<T>
• class kfr::moving_sum_state<U, Tag>
• class kfr::moving_sum_state<U, tag_dynamic_vector>
• struct kfr::mp3_config
• struct kfr::mp3_decoding_options Options for decoding MP3 audio files.

R¶

• struct kfr::random_state
• class kfr::range<T> Iterable range
• struct kfr::raw_decoding_options Options for decoding raw audio streams.
• struct kfr::raw_encoding_options Represents options for raw audio encoding.
• class kfr::reader_adapter<From, To>
• class kfr::representation<fmt_t<kfr::tensor<T, dims>, t, width, prec>>
• class kfr::representation<fmt_t<kfr::univector<T, Tag>, t, width, prec>>
• struct kfr::representation<kfr::cpu_t>
• struct kfr::representation<kfr::fraction>
• struct kfr::representation<kfr::npy_decode_result>
• class kfr::representation<kfr::shape<dims>>
• struct kfr::representation<kfr::special_value>
• class kfr::representation<kfr::tensor<T, dims>>
• class kfr::representation<kfr::univector<T, Tag>>
• class kfr::runtime_error

S¶

• class kfr::samplerate_converter<T> A template class for performing sample rate conversion on audio signals.
• struct kfr::seed_from_rdtsc_t
• struct kfr::shape<0>
• class kfr::shape<Dims>
• struct kfr::shape<dynamic_shape>
• class kfr::short_fir_state<tapcount, T, U>
• class kfr::small_buffer<T, Capacity>
• class kfr::state_holder<T, false>
• class kfr::state_holder<T, Stateless>
• class kfr::state_holder<T, true>
• class kfr::static_assert_eq<T, left, right>
• class kfr::static_assert_type_eq<Left, Right>
• struct kfr::generic::stereo_matrix
• class kfr::generic::stride_pointer<const T, groupsize>
• class kfr::generic::stride_pointer<T, groupsize>
• class kfr::strided_channel<T> Represents a strided audio channel.
• struct kfr::swallow Utility class to use in list-initialization context
• struct kfr::symmetric_linspace_t

T¶

• struct kfr::tensor_range
• class kfr::tensor_subscript<T, Derived, Dims>
• class kfr::tensor_subscript<T, Derived, std::integer_sequence<index_t, Dims...>>
• class kfr::tensor<T, dynamic_shape>
• class kfr::tensor<T, NDims> tensor holds or references multidimensional data and provides a way to access individual elements and perform complex operations on the data.

U¶

• class kfr::univector_base<T, Class, false>
• class kfr::univector_base<T, Class, is_expression> Base class for all univector specializations.
• class kfr::univector_base<T, Class, true>
• class kfr::univector<T, Size> Class that represent data in KFR. Many KFR functions can take this class as an argument. Can inherit from std::vector, std::array or keep only reference to data and its size.
• class kfr::univector<T, tag_array_ref>
• class kfr::univector<T, tag_dynamic_vector>

V¶

• class kfr::generic::vec_of_complex<N>

W¶

• struct kfr::w64_decoding_options Options for decoding W64 audio files.
• struct kfr::w64_encoding_options Represents options for W64 audio encoding.
• struct kfr::wave_decoding_options Options for decoding WAVE audio files.
• struct kfr::wave_encoding_options Represents options for WAVE audio encoding, including RF64 support for large files.
• class kfr::generic::window_by_type<window_type>
• struct kfr::generic::window_by_type<window_type::bartlett>
• struct kfr::generic::window_by_type<window_type::bartlett_hann>
• struct kfr::generic::window_by_type<window_type::blackman>
• struct kfr::generic::window_by_type<window_type::blackman_harris>
• struct kfr::generic::window_by_type<window_type::bohman>
• struct kfr::generic::window_by_type<window_type::cosine>
• struct kfr::generic::window_by_type<window_type::cosine_np>
• struct kfr::generic::window_by_type<window_type::flattop>
• struct kfr::generic::window_by_type<window_type::gaussian>
• struct kfr::generic::window_by_type<window_type::hamming>
• struct kfr::generic::window_by_type<window_type::hann>
• struct kfr::generic::window_by_type<window_type::kaiser>
• struct kfr::generic::window_by_type<window_type::lanczos>
• struct kfr::generic::window_by_type<window_type::planck_taper>
• struct kfr::generic::window_by_type<window_type::rectangular>
• struct kfr::generic::window_by_type<window_type::triangular>
• struct kfr::generic::window_by_type<window_type::tukey>
• class kfr::generic::window_linspace<T>
• class kfr::writer_adapter<From, To>

Z¶

• struct kfr::zpk