Classes, Structs & Unions¶

A¶

class abstract_vector<T, Tag> Generic 2D/3D container of univector rows, parameterized by the row storage tag.
class abstract_vector<T, tag_array_ref> Specialization of abstract_vector that only holds a non-owning reference to external data.
class abstract_vector<T, tag_dynamic_vector> Specialization of abstract_vector backed by a dynamically sized std::vector using KFR's data_allocator .
struct audio_sample_get_type<audio_sample_type::f32>
struct audio_sample_get_type<audio_sample_type::f64>
struct audio_sample_get_type<audio_sample_type::i16>
struct audio_sample_get_type<audio_sample_type::i24>
struct audio_sample_get_type<audio_sample_type::i32>
class audio_sample_get_type<type> Maps an audio_sample_type enumerator to its native C++ type.
struct audio_sample_traits<f32>
struct audio_sample_traits<f64>
struct audio_sample_traits<i16>
struct audio_sample_traits<i24>
struct audio_sample_traits<i32>
class audio_sample_traits<T> Compile-time properties of an audio sample C++ type.
class axis_params<Axis, N> Compile-time axis descriptor used by SIMD tensor accessors.

C¶

class cursor<Dims> Multi-dimensional iteration cursor.

E¶

class expand_cvals<T, Tpl, cvals_t<T, vals...>> Specialization of expand_cvals that instantiates Tpl with the pack values.
class expand_cvals<T, Tpl, Pack> Expands a cvals_t pack into a template expecting non-type parameters.
class expression_adjacent<Fn, E> Expression that applies a binary function to each value and its previous value.
class expression_cast<T, Arg> Expression that converts the values of the wrapped expression to type T.
class expression_concatenate<Arg1, Arg2, ConcatAxis> Expression that joins two expressions along a single axis.
class expression_counter<T, Dims> Expression that produces a sequence of values start, start + step, start + 2*step, ... for one or more dimensions.
class expression_dimensions<Dims, E> Expression that adjusts the dimensionality of another expression.
class expression_discard<Tin, Dims> Output expression that discards all written values.
class expression_filter<T> Filter adapter that wraps an expression containing a placeholder.
class expression_fixshape<Arg, Shape> Expression that overrides the shape of another expression with a compile-time shape.
class expression_function<Fn, Args> Expression that applies a callable to its arguments.
class expression_handle<T, Dims> Opaque type-erased handle to an expression (forward declaration).
class expression_histogram<Bins, E, TCount> Expression that computes a histogram as data flows through it.
class expression_lambda<T, Dims, Fn, Rnd> Expression backed by a user-provided callable.
class expression_linspace<T, truncated> Expression that produces evenly spaced values from start to stop.
class expression_padded<Arg> Expression that extends another expression with a constant fill value.
class expression_placeholder<T, Dims, Key> A placeholder expression that can be bound to a concrete expression at runtime.
class expression_random_normal<T, Dims, Reference> Expression that produces normally distributed (Gaussian) random values.
class expression_random_range<T, Dims, Reference> Expression that produces uniformly distributed random values in [min, max).
class expression_random_uniform<T, Dims, Reference> Expression that produces uniformly distributed random values in [0, 1).
class expression_reduce<Tout, Dims, Twork, Tin, ReduceFn, TransformFn, FinalFn> Expression that reduces an input expression to a single value.
class expression_reshape<Arg, OutDims> Expression that exposes the same data as another expression with a different shape.
struct expression_resource Base class for owning the storage of a type-erased expression.
class expression_resource_impl<E> expression_resource that owns an expression of type E by value.
class expression_reverse<Arg> Expression that exposes another expression with its trailing dimension reversed.
class expression_scalar<T> Expression that wraps a single scalar value of type T.
class expression_slice<Arg> Expression that exposes a sub-region of another expression.
class expression_trace<E> Expression that prints the requested values to the console for debugging purposes.
struct expression_traits_defaults Base struct providing default values for expression traits.
class expression_traits<const T> Pass-through specialization that forwards traits for const-qualified expression types.
class expression_traits<const T &> Pass-through specialization that forwards traits for const lvalue reference expression types.
class expression_traits<const T &&> Pass-through specialization that forwards traits for const rvalue reference expression types.
class expression_traits<expression_cast<T, Arg>>
class expression_traits<expression_concatenate<Arg1, Arg2, ConcatAxis>>
class expression_traits<expression_counter<T, Dims>>
class expression_traits<expression_fixshape<Arg, fixed_shape_t<ShapeValues...>>>
class expression_traits<expression_handle<T, Dims>> expression_traits specialization for expression_handle .
class expression_traits<expression_lambda<T, Dims, Fn, Rnd>>
class expression_traits<expression_linspace<T, truncated>>
class expression_traits<expression_padded<Arg>>
class expression_traits<expression_placeholder<T, Dims, Key>> expression_traits specialization for expression_placeholder .
class expression_traits<expression_reshape<Arg, OutDims>>
class expression_traits<expression_reverse<Arg>>
class expression_traits<expression_scalar<T>>
class expression_traits<expression_slice<Arg>>
class expression_traits<T> Primary traits template for expressions.
class expression_traits<T &> Pass-through specialization that forwards traits for lvalue reference expression types.
class expression_traits<T &&> Pass-through specialization that forwards traits for rvalue reference expression types.
class expression_traits<T> Specialization of expression_traits for scalar vector element types.
class expression_traits<tensor<T, Dims>> Expression traits for tensor, enabling its use as an expression argument.
class expression_traits<univector<T, Tag>> Expression traits for univector , allowing it to participate in KFR expression evaluation.
class expression_unpack<E> Expression that writes a single vector-valued input into several output expressions.
class expression_vtable<T, Dims> Virtual table providing type-erased access to an expression of value type T and dimensionality Dims.
class expression_with_arguments<Arg> Single-argument specialization of expression_with_arguments .
class expression_with_arguments<Args> Holds the arguments of an expression along with their dimension masks.
class expression_with_traits<Arg> Wraps a single-argument expression and forwards its traits.

F¶

class filter<T> Abstract base class for single-argument filters, mainly intended for DSP processing.
class fixed_shape_t<Values> Type-level storage for a fixed shape built from a list of constants.
struct fraction Exact rational number represented as a numerator/denominator pair.

G¶

class generator_cossin<T, VecWidth> Generator that produces interleaved cosine and sine values
\\[ x_i = \begin{cases} \cos(start + i \cdot step), & \text{if } i \text{ is even}\\ \sin(start + i \cdot step), & \text{otherwise} \end{cases} \\]
class generator_exp2<T, VecWidth> Generator that produces a base-2 exponential sequence \(x_i = 2^{ start + i \cdot step }\) .
class generator_expj<T, VecWidth> Generator that produces a complex exponential \(x_i = e^{ j ( start + i \cdot step ) }\) .
class generator_exp<T, VecWidth> Generator that produces an exponential sequence \(x_i = e^{ start + i \cdot step }\) .
class generator_linear<T, VecWidth> Generator that produces an arithmetic progression \(x_i = start + i \cdot step\) .
class generator_sin<T, VecWidth> Generator that produces sine values \(x_i = \sin( start + i \cdot step )\) .
class generator<T, VecWidth, Class, Twork> CRTP base for stateful streaming generators that produce fixed-width vectors of values on demand.

H¶

class histogram_data<Bins, TCount> Holds the bin counts for a histogram.

I¶

class inline_vector<T, N> A sequence container with fixed-capacity inline storage.

R¶

struct random_state Internal state of the pseudo-random number generator.
class representation<fmt_t<kfr::tensor<T, dims>, t, width, prec>> Specialization of representation for a formatted tensor, providing formatted string conversion.
class representation<fmt_t<kfr::univector<T, Tag>, t, width, prec>> representation specialization that formats a fmt_t-wrapped univector as a string, applying the wrapped format options to each element.
struct representation<kfr::fraction> String representation specialization for fraction .
struct representation<kfr::npy_decode_result>
class representation<kfr::shape<dims>> String representation of a shape , used by as_string and the formatting framework.
class representation<kfr::tensor<T, dims>> Specialization of representation for tensor, providing string conversion.
class representation<kfr::univector<T, Tag>> representation specialization that formats a univector as a string using KFR's built-in array formatting.

S¶

struct seed_from_rdtsc_t Tag type for seeding the random number generator from the CPU cycle counter.
struct shape<0> Scalar shape specialization.
class shape<dims> Fixed-rank multidimensional shape used by tensor .
struct shape<dynamic_shape> Run-time-rank shape specialization.
class small_buffer<T, Capacity> A dynamically-sized buffer with a small-size optimization.
class spsc_ring_buffer<T> Single-producer/single-consumer queue backed by an external univector .
class state_holder<T, false> Owning specialization of state_holder .
class state_holder<T, Stateless> Holds a state value, either by ownership or by reference, depending on the Stateless template parameter.
class state_holder<T, true> Stateless (non-owning) specialization of state_holder .
struct symmetric_linspace_t Tag type used to select the symmetric-linspace constructor of expression_linspace .

T¶

struct tensor_range Half-open or one-ended range descriptor for tensor slicing.
class tensor_subscript<T, Derived, Dims> Base for the subscript operator helper of tensor.
class tensor_subscript<T, Derived, std::integer_sequence<index_t, Dims...>> Specialization of tensor_subscript for an explicit integer sequence of dimensions.
class tensor<T, dynamic_shape> Specialization of tensor for a dynamic shape. Not implemented yet.
class tensor<T, NDims> Holds or references multidimensional data and provides access to individual elements and complex operations on the data.

U¶

class univector_base<T, Class, false> Specialization for univectors that cannot be assigned from expressions. Provides only reference access to the underlying data.
class univector_base<T, Class, is_expression> Base class for all univector specializations, providing common operations such as slicing, references and ring-buffer helpers. Ring-buffer helpers operate on caller-owned cursors and are intended for single-threaded use only; concurrent access requires external synchronization.
class univector_base<T, Class, true> Specialization for univectors that can be assigned from expressions.
class 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 univector<T, tag_array_ref> Non-owning univector specialization that holds a reference to external data.
class univector<T, tag_dynamic_vector> Dynamically sized, owning univector backed by std::vector using KFR's data_allocator . Memory is aligned to the maximum vector alignment.

This file was generated by cxxdox, a C++ documentation generator based on MkDocs Material and libclang.