kfr

Fast, modern C++ DSP framework, FFT, Sample Rate Conversion, FIR/IIR/Biquad Filters (SSE, AVX, AVX-512, ARM NEON)
Log | Files | Refs | README

cxxdox.yml (2381B)


      1 title: KFR
      2 
      3 input:
      4   - include:
      5       - include/kfr/**/*.h
      6     hide_tokens:
      7       - CMT_INLINE
      8       - KFR_INTRINSIC
      9       - KFR_MEM_INTRINSIC
     10       - KFR_FUNCTION
     11       - CMT_INTRINSIC
     12       - CMT_MEM_INTRINSIC
     13       - CMT_UNUSED
     14       - CMT_INLINE
     15       - KFR_API_SPEC
     16     compile_options:
     17       - "-DKFR_ENABLE_FLAC=1"
     18       - "-DCMT_FORCE_GENERIC_CPU=1"
     19       - "-std=gnu99"
     20       - "-DDOCUMENTATION"
     21   - include:
     22       - include/kfr/**/*.hpp
     23     hide_tokens:
     24       - CMT_INLINE
     25       - KFR_INTRINSIC
     26       - KFR_MEM_INTRINSIC
     27       - KFR_FUNCTION
     28       - CMT_INTRINSIC
     29       - CMT_MEM_INTRINSIC
     30       - CMT_UNUSED
     31       - CMT_INLINE
     32       - KFR_API_SPEC
     33     compile_options:
     34       - "-DKFR_ENABLE_FLAC=1"
     35       - "-DCMT_FORCE_GENERIC_CPU=1"
     36       - "-std=gnu++17"
     37       - "-DDOCUMENTATION"
     38 
     39 repository: https://github.com/kfrlib/kfr/blob/{TAG}/include/kfr/{FILE}#L{LINE}
     40 
     41 groups:
     42   filter: "Filter API"
     43   array: "Array functions"
     44   base: "Base expressions"
     45   cpuid: "Runtime CPU detection"
     46   cometa: "CoMeta"
     47   testo: "Testo - Unit testing"
     48   univector: "Vector"
     49   tensor: "Tensor"
     50   dft: "DFT"
     51   binary_io: "Generic IO"
     52   audio_io: "Audio IO"
     53   plotting: "Plotting (uses matplotlib)"
     54   string_io: "String conversion/printing values"
     55   biquad: "Biquad filter and design functions"
     56   fir: "FIR filter and design functions"
     57   iir: "IIR filter and design functions"
     58   window: "Window functions"
     59   sample_rate_conversion: "Sample rate conversion"
     60   oscillators: "Oscillator functions"
     61   dsp_extra: "Extra DSP functions"
     62   ebu: "EBU R128 functions"
     63   types: "Types"
     64   memory: "Memory allocation"
     65   conversion: "Conversion functions"
     66   complex: "Complex functions"
     67   constants: "Constants"
     68   logical: "Logical functions"
     69   basic_math: "Basic math functions"
     70   exponential: "Exponential/Logarithm and other functions"
     71   round: "Rounding functions"
     72   math: "Math functions"
     73   read_write: "Loading/storing SIMD"
     74   saturation: "Saturated arithmetics functions"
     75   trigonometric: "Trigonometric functions"
     76   hyperbolic: "Hyperbolic functions"
     77   shuffle: "SIMD Shuffle functions"
     78   horizontal: "SIMD shuffle Functions"
     79   other_math: "Other math functions"
     80   interpolation: "Interpolation functions"
     81   expressions: "Expressions"
     82   generators: "Generator expressions"
     83   random: "PRNG functions and expressions"
     84   reducing: "Reducing functions"
     85   utility: "Utility functions"
     86   capi: "C API"