shz_complex.hpp File Reference

#include <compare>
#include "shz_complex.h"

Include dependency graph for shz_complex.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	shz::complex

Namespaces
namespace	shz

Typedefs
using	shz::complex_t

Functions
Global Operators
Globally-defined overloaded operators.
complex	shz::operator+ (const complex &lhs, const complex &rhs) noexcept
complex	shz::operator- (const complex &lhs, const complex &rhs) noexcept
complex	shz::operator* (const complex &lhs, const complex &rhs) noexcept
complex	shz::operator* (const complex &lhs, float rhs) noexcept
complex	shz::operator/ (const complex &lhs, const complex &rhs) noexcept
complex	shz::operator/ (const complex &lhs, float rhs) noexcept
bool	shz::operator== (const complex &lhs, const complex &rhs) noexcept
bool	shz::operator!= (const complex &lhs, const complex &rhs) noexcept
Basic
Basic operations on complex numbers.
complex	shz::cinitf (float real, float imag) noexcept
complex	shz::cpolarf (float r, float theta) noexcept
bool	shz::cequalf (const complex &lhs, const complex &rhs) noexcept
float	shz::crealf (const complex &c) noexcept
float	shz::cimagf (const complex &c) noexcept
Arithmetic
Arithmetic operations on complex numbers.
complex	shz::caddf (const complex &lhs, const complex &rhs) noexcept
complex	shz::csubf (const complex &lhs, const complex &rhs) noexcept
complex	shz::cmulf (const complex &lhs, const complex &rhs) noexcept
complex	shz::cdivf (const complex &lhs, const complex &rhs) noexcept
complex	shz::cscalef (const complex &lhs, float v) noexcept
complex	shz::crecipf (const complex &c) noexcept
Manipulation
Extract or modify complex components.
float	shz::cabsf (const complex &c) noexcept
float	shz::inv_cabsf (const complex &c) noexcept
float	shz::cnormf (const complex &c) noexcept
float	shz::cargf (const complex &c) noexcept
complex	shz::conjf (const complex &c) noexcept
complex	shz::cprojf (const complex &c) noexcept
Transcendental
Complex transcendental functions.
complex	shz::csqrtf (const complex &c) noexcept
complex	shz::cpowf (const complex &base, const complex &exp) noexcept
complex	shz::cexpf (const complex &c) noexcept
complex	shz::clogf (const complex &c) noexcept
complex	shz::clog10f (const complex &c) noexcept
Spherical Trigonometry
Complex spherical trigonometric functions.
complex	shz::csinf (const complex &c) noexcept
complex	shz::ccosf (const complex &c) noexcept
complex	shz::ctanf (const complex &c) noexcept
complex	shz::ccscf (const complex &c) noexcept
complex	shz::csecf (const complex &c) noexcept
complex	shz::ccotf (const complex &c) noexcept
complex	shz::casinf (const complex &c) noexcept
complex	shz::cacosf (const complex &c) noexcept
complex	shz::catanf (const complex &c) noexcept
complex	shz::cacscf (const complex &c) noexcept
complex	shz::casecf (const complex &c) noexcept
complex	shz::cacotf (const complex &c) noexcept
Hyperbolic Trigonometry
Complex hyperbolic trigonometric functions.
complex	shz::csinhf (const complex &c) noexcept
complex	shz::ccoshf (const complex &c) noexcept
complex	shz::ctanhf (const complex &c) noexcept
complex	shz::ccschf (const complex &c) noexcept
complex	shz::csechf (const complex &c) noexcept
complex	shz::ccothf (const complex &c) noexcept
complex	shz::casinhf (const complex &c) noexcept
complex	shz::cacoshf (const complex &c) noexcept
complex	shz::catanhf (const complex &c) noexcept
complex	shz::cacschf (const complex &c) noexcept
complex	shz::casechf (const complex &c) noexcept
complex	shz::cacothf (const complex &c) noexcept
Signal Processing
Functions for processing complex signals.
void	shz::fft (shz_complex_t *s, size_t size) noexcept

Detailed Description

Complex number C++ API.

This file contains the C++ layer for wrapping the Complex Number C API. The major thing that it adds in C++ is convenient overloaded operators for performing arithmetic on complex numbers using the regular arithmetic operators, rather than having to make function calls which implement them, as in C.

Author

2026 Falco Girgis

Copyright

MIT License

Todo

• custom literals
• array index accessors?
• iterator support?

Definition in file shz_complex.hpp.