Functions¶

A¶

• function advance(T *, ptrdiff_t)
• function advance(void *, ptrdiff_t)
• function align_down(T *, size_t)
• function align_down(T, std::type_identity_t<T>)
• function align_up(T *, size_t)
• function align_up(T, std::type_identity_t<T>)
• function aligned_allocate(size_t) Allocates aligned memory
• function aligned_allocate(size_t, size_t) Allocates aligned memory
• function aligned_deallocate(T *) Deallocates aligned memory
• function array_to_string(const std::array<size_t, Dims> &, Getter &&, int, int, std::string_view, std::string_view, std::string_view) Render a multi-dimensional array as a nested, brace-delimited string.
• function array_to_string(size_t, Getter &&, int, int, std::string_view, std::string_view, std::string_view) Convenience overload of array_to_string for a one-dimensional array accessed through a getter callable.
• function array_to_string(size_t, T *, int, int, std::string_view, std::string_view, std::string_view) Convenience overload of array_to_string for a raw pointer buffer.
• function as_string(const Args &...) Convert arbitrary values to a std::string using KFR's built-in formatting.
• function autocast(const Tfrom &)

B¶

• function bind_func(Fn &&, Args &&...)
• function bitcast_anything(const Tin &)
• function build_fmt_str(cchars_t<'@', chars...>, ctypes_t<Arg, Args...>) Build a compile-time format string: replace the leading '@' with the specifier for Arg and recurse on the remaining arguments.
• function build_fmt_str(cchars_t<ch, chars...>, ctypes_t<Args...>) Build a compile-time format string: copy a literal character and recurse.
• function build_fmt_str(cchars_t<>, ctypes_t<>) Build a compile-time printf format string from a literal template and argument types.

C¶

• function call_with_temp(size_t, Fn &&) Calls a function with a temporary buffer, allocated on the stack if small enough, otherwise on the heap.
• function cconcat(T1, Ts...) Returns a value of the concatenated list type
• function cfilter(cvals_t<T, vals...>, cvals_t<bool, flags...>)
• function cfind(cvals_t<T, values...>, std::type_identity_t<T>)
• function cfor(cval_t<T, start>, cval_t<T, stop>, BodyFn &&)
• function cforeach(A0 &&, A1 &&, A2 &&, A3 &&, Fn &&) Invokes
• function cforeach(A0 &&, A1 &&, A2 &&, Fn &&) Invokes
• function cforeach(A0 &&, A1 &&, Fn &&)
• function cforeach(const std::tuple<Ts...> &, Fn &&)
• function cforeach(ctypes_t<Ts...>, Fn &&)
• function cforeach(cvals_t<T, values...>, Fn &&)
• function cforeach(T &&, Fn &&)
• function choose_const() Selects the constant of the specific type from a list of candidates. Returns the candidate whose type matches T ; triggers a static_assert if T is not present.
• function choose_const_fallback(C1) Single-argument fallback: converts
• function choose_const_fallback(C1, Cs...)
• function choose_const(C1, Cs...) Recursively skips candidates whose type does not match
• function cif(cbool_t<false>, TrueFn &&, FalseFn &&) Compile-time conditional: invokes
• function cif(cbool_t<true>, TrueFn &&, FalseFn &&)
• function cmatch(T &&, Fn &&, Args...)
• function cmaxof(cvals_t<T>) Returns the maximum value in the list (min of
• function cmaxof(cvals_t<T, val, vals...>) Returns the maximum value in the list
• function cminof(cvals_t<T>) Returns the minimum value in the list (max of
• function cminof(cvals_t<T, val, vals...>) Returns the minimum value in the list
• function concat_cstring()
• function concat_cstring(const cstring<N1> &)
• function concat_cstring(const cstring<N1> &, const cstring<N2> &, const Args &...)
• function cprod(cvals_t<T>) Returns the product of all values in the list (1 for an empty list)
• function cprod(cvals_t<T, first, rest...>) Returns the product of all values in the list
• function csum(cvals_t<T>) Returns the sum of all values in the list (0 for an empty list)
• function csum(cvals_t<T, first, rest...>) Returns the sum of all values in the list
• function cswitch(cvals_t<T>, std::type_identity_t<T>, Fn &&, DefFn &&, CmpFn &&) Switch over an empty list: always invokes the default handler
• function cswitch(cvals_t<T, v0, values...>, std::type_identity_t<T>, Fn &&, DefFn &&, CmpFn &&)
• function cswitch(cvals_t<T, vs...>, const U &, Function &&, Fallback &&)
• function ctype_name()
• function ctypeid() Gets unique value associated with the type
• function ctypeid(T) Gets unique value associated with the type

D¶

• function derived_cast(const U *) Down-casts a const pointer from
• function derived_cast(U *)
• function distance(const void *, const void *)
• function dont_deduce(T)

E¶

• function error(const Args &...) Print values to stderr, each formatted with its default conversion specifier.
• function errorln(const Args &...) Print values to stderr followed by a newline, then flush stderr.

F¶

• function floor_div(long long, long long)
• function fmt(const T &) Wrap value with a custom conversion specifier.
• function fmtwidth(const T &) Wrap value with only width/precision, keeping the default conversion specifier.
• function format(const std::string &, const Args &...) Format values into a std::string using a {}"-based format string.
• function fprintfmt(FILE *, const std::string &, const Args &...) Print to a file f using a {}"-based format string.

G¶

• function get_first(T1 &&, Ts &&...) Function that returns its first argument and ignores all other arguments
• function get_second(T1, T2 &&, Ts &&...) Function that returns its second argument and ignores all other arguments
• function get_third(T1 &&, T2 &&, T3 &&, Ts &&...) Function that returns its third argument and ignores all other arguments

I¶

• function ilog2(T) Returns the base-2 logarithm of
• function implicit_cast(U &&)
• function is_between(T, std::type_identity_t<T>, std::type_identity_t<T>)
• function is_constant_val(cval_t<T, value>) Returns
• function is_constant_val(T) Returns
• function is_divisible(T, T)
• function is_equal(const T1 &, const T2 &) Returns
• function is_even(T) Returns
• function is_greater(const T1 &, const T2 &) Returns
• function is_greaterorequal(const T1 &, const T2 &) Returns
• function is_less(const T1 &, const T2 &) Returns
• function is_lessorequal(const T1 &, const T2 &) Returns
• function is_notequal(const T1 &, const T2 &) Returns
• function is_odd(T) Returns
• function is_poweroftwo(T) Returns
• function is_sequence(csizes_t<number, numbers...>)

J¶

• function join(T) Convert a single value to a string (terminator of join ).
• function join(T, U, Ts...) Join values into a comma-separated string of the form {x}, {y}, {rest...}".
• function just_value(T)

M¶

• function make_array_ref(Container &&)
• function make_array_ref(T *, std::size_t)
• function make_cstring(cchars_t<chars...>)
• function make_cstring(const char (&)[N])
• function make_nonmember(const Fn &)
• function make_range(T, T) Make iterable range object
• function make_range(T, T, D) Make iterable range object with step
• function map_indices() Returns a value of map_indices_t<size, Fn...> for use in non-type contexts.

N¶

• function next_poweroftwo(T) Returns a nearest power of two that is greater or equal than n
• function noinline(Fn &&, Args &&...)
• function noop(Ts &&...) Function that returns void and ignores all its arguments

O¶

• function operator
• function operator User-defined literal returning a format_t for the given string literal.
• function operator User-defined literal returning a print_t for the given string literal.
• function operator==(const data_allocator<T1> &, const data_allocator<T2> &)
• function operator!=(const data_allocator<T1> &, const data_allocator<T2> &)
• function operator-(cval_t<T1, val1>)
• function operator+(cval_t<T1, val1>)
• function operator~(cval_t<T1, val1>)
• function operator!(cval_t<T1, val1>)
• function operator&&(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator||(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator==(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator!=(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator<(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator>(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator<=(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator>=(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator+(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator-(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator*(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator/(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator%(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator<<(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator>>(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator&(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator|(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator^(cval_t<T1, val1>, cvals_t<T2, vals2...>)
• function operator-(cvals_t<T1, vals1...>)
• function operator+(cvals_t<T1, vals1...>)
• function operator~(cvals_t<T1, vals1...>)
• function operator!(cvals_t<T1, vals1...>)
• function operator&&(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator||(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator==(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator!=(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator<(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator>(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator<=(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator>=(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator+(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator-(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator*(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator/(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator%(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator<<(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator>>(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator&(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator|(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator^(cvals_t<T1, vals1...>, cval_t<T2, val2>)
• function operator&&(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator||(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator==(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator!=(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator<(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator>(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator<=(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator>=(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator+(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator-(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator*(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator/(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator%(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator<<(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator>>(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator&(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator|(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator^(cvals_t<T1, vals1...>, cvals_t<T2, vals2...>)
• function operator|(datatype, datatype)
• function operator&(datatype, datatype)

P¶

• function pack_elements() Returns the identity value (0) for an empty pack
• function pack_elements(Arg, Args...)
• function padcenter(size_t, const std::string &, char) Center text within a field of size characters using character.
• function padleft(size_t, const std::string &, char) Left-align text within a field of size characters by appending character.
• function padright(size_t, const std::string &, char) Right-align text within a field of size characters by prepending character.
• function pass_through(T &&) Function that returns its first argument
• function prev_poweroftwo(T) Returns a nearest power of two that is less or equal than n
• function print(const Args &...) Print values to stdout, each formatted with its default conversion specifier.
• function printfmt(const std::string &, const Args &...) Print to stdout using a {}"-based format string.
• function println(const Args &...) Print values to stdout followed by a newline.
• function ptr_cast(const U *) Reinterprets a const pointer of type
• function ptr_cast(U *)
• function ptr_cast(U *, ptrdiff_t)

Q¶

• function q(T) Wrap the string representation of x in double quotes.

R¶

• function ref_cast(const U &) Reinterprets a const reference of type
• function ref_cast(U &)
• function return_constant(Args &&...) Function that returns constant of type T and ignores all its arguments
• function returns(Ts &&...) Function that returns value-initialization of type T and ignores all its arguments

S¶

• function scale()
• function scale(csizes_t<indices...>)
• function select(cvals_t<bool, flags...>, cvals_t<T, values1...>, cvals_t<T, values2...>) Element-wise selection between two value lists based on a flag list. For each position, returns values1[i] if flags[i] is true , otherwise values2[i] .
• function snprintfmt(char *, size_t, const std::string &, const Args &...) Write to a buffer using a {}"-based format string.
• function stop_constexpr() Non-constexpr function used to halt constant evaluation in
• function str_find(const cstring<N1> &, const cstring<Nneedle> &)
• function str_replace(const cstring<N1> &, const cstring<Nfrom> &, const cstring<Nto> &)

T¶

• function type_name() Gets the fully qualified name of the type, including namespace and template parameters (if any)
• function type_name(T) Gets the fully qualified name of the type, including namespace and template parameters (if any)
• function typeindex() Returns the zero-based index of type

V¶

• function val_of(cval_t<T, value>) Extracts the value from a cval_t constant
• function val_of(T) Returns the value itself (overload for runtime values)

W¶

• function widthof() Returns the width (number of scalar components) of
• function widthof(T) Returns the width (number of scalar components) of
• function wrap_fmt(const U &, ctype_t<Fmt>) Wrap val with the format type Fmt when Fmt is not void.
• function wrap_fmt(const U &, ctype_t<void>) Identity pass-through used when no format type is specified.

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