qlibs Namespace Reference

The qLibs++ library namespace. More...

Namespaces
namespace	algorithm
	The generic namespace.
namespace	build
namespace	ffmath
	Namespace for the Fast floating-point math library.
namespace	fis
	The Fuzzy Inference System namespace.
namespace	product
namespace	version

Classes
class	bitfield
	A BitField object. More...
class	continuousSystem
	A LTI continuous system object. More...
struct	continuousTF
	Continuous transfer function for easy LTI system definition. More...
class	crc
class	derivative
	A numerical derivative class. More...
class	discreteSystem
	A LTI discrete system object. More...
struct	discreteTF
	Discrete transfer function for easy LTI system definition. More...
class	fp16
	Fixed-point Q16.16 type with width of exactly 32 bits. More...
class	integrator
	A numerical integration class. More...
class	interp1
	A 1D interpolation object. More...
class	ltisys
	A LTI system base class. More...
class	mat
	Matrix object. More...
class	nState
	A numerical state object. More...
class	pidAutoTuning
	A PID Auto-tuning object. More...
class	pidController
	A PID controller object. More...
struct	pidGains
	PID Gains structure. More...
class	rms
	RMS calculator object. More...
class	smithPredictor
	A Smith Predictor implementation for compensating time delays in control systems. More...
class	smoother
	The smoother base abstract class. More...
class	smootherALNF
	Adaptive Filter LMS. More...
class	smootherDESF
	Double exponential smoothing (Holt’s Method) More...
class	smootherEXPW
	An Exponential weighting filter. More...
class	smootherGMWF
	A Gaussian filter. More...
class	smootherKLMN
	A scalar Kalman filter. More...
class	smootherLPF1
	A 1st order Low-Pass Filter. More...
class	smootherLPF2
	A 2nd order Low-Pass Filter. More...
class	smootherMOR1
	A Moving Outlier Removal filter. More...
class	smootherMOR2
	A Moving Outlier Removal filter. More...
class	smootherMWM1
	A Moving Window Median filter. More...
class	smootherMWM2
	A Moving Window Median filter. More...
class	tdl
	A Tapped Delay Line (TDL) object. More...
struct	timeDelay
	Represents a time delay value for use in transportDelay constructor. More...
class	transportDelay
	Delays the input by a specified amount of time. You can use this class to simulate a time delay. More...

Typedefs
template<size_t N>
using	bitArea
	Variable that allocates block of bytes to hold N bits for a BitField .
template<size_t order>
using	continuousStates
	Type to specify continuous states.
template<size_t order>
using	discreteStates
	Type to specify discrete states.
template<size_t delay>
using	discreteDelay
	Delays the input by a specified amount of samples. You can use this class to simulate a discrete time delay.
using	customProcessModel
using	real_t
	A type to instantiate a real variable double-precision of 64-bits IEEE 754.

Enumerations
enum	matSpecial { MAT_ZERO , MAT_IDENTITY , MAT_ALL , MAT_MAGIC }
enum	crcMode { CRC8 , CRC16 , CRC32 }
	Enumeration with all the supported cyclic redundancy checks. More...
enum	interp1Method {   INTERP1_NEXT , INTERP1_PREVIOUS , INTERP1_NEAREST , INTERP1_LINEAR ,   INTERP1_SINE , INTERP1_CUBIC , INTERP1_HERMITE , INTERP1_SPLINE ,   INTERP1_CONSTRAINED_SPLINE }
	An enum with all the available interpolation methods. More...
enum	ltisysType { LTISYS_TYPE_UNKNOWN , LTISYS_TYPE_CONTINUOUS , LTISYS_TYPE_DISCRETE }
	All the possible natures of a LTI system. More...
enum	integrationMethod { INTEGRATION_RECTANGULAR , INTEGRATION_TRAPEZOIDAL , INTEGRATION_SIMPSON , INTEGRATION_QUADRATIC }
	An enum with all the available integration methods. More...
enum	derivationMethod { DERIVATION_2POINTS , DERIVATION_BACKWARD , DERIVATION_FORWARD }
	An enum with all the available derivation methods. More...
enum class	pidMode { pidMode::PID_AUTOMATIC , pidMode::PID_MANUAL }
	Enumeration class with the operational modes for the PID controller. More...
enum class	pidType { pidType::PID_TYPE_P , pidType::PID_TYPE_PI , pidType::PID_TYPE_PD , pidType::PID_TYPE_PID }
	Enumeration class with the operational modes for the PID controller. More...
enum class	pidDirection { pidDirection::PID_FORWARD , pidDirection::PID_BACKWARD }
	Direction modes of the PID controller. More...

Functions
constexpr timeDelay	operator""_td (long double v)
	Literal for creating a timeDelay from a floating-point value.
constexpr size_t	operator, (const timeDelay td, const real_t dt)
	Computes the delay in discrete steps using the comma operator.
constexpr size_t	delayFromTime (const real_t Time, const real_t dt)
	Computes the number of discrete delays required for a specified amount of time using a defined time-step.
constexpr size_t	delayFromTime (const timeDelay Time, const real_t dt)
	Computes the number of discrete delays required for a specified amount of time using a defined time-step.

Variables
const fp16	FP_E
	e The base of natural logarithms as a Fixed-point Q16.16 value.
const fp16	FP_LOG2E
	log2(e) The base 2 logarithm of e as a Fixed-point Q16.16 value.
const fp16	FP_LOG10E
	log10(e) The base 10 logarithm of e as a Fixed-point Q16.16 value.
const fp16	FP_LN2
	ln(2) The natural logarithm of 2 as a Fixed-point Q16.16 value.
const fp16	FP_LN10
	ln(10) The natural logarithm of 10 as a Fixed-point Q16.16 value.
const fp16	FP_PI
	pi The circumference of a circle with diameter 1 as a Fixed-point Q16.16 value.
const fp16	FP_PI_2
	pi/2 Half of pi as a Fixed-point Q16.16 value.
const fp16	FP_PI_4
	pi/4 A quarter of pi as a Fixed-point Q16.16 value.
const fp16	FP_1_PI
	1/pi The inverse of pi as a Fixed-point Q16.16 value.
const fp16	FP_2_PI
	2/pi Twice the inverse of pi as a Fixed-point Q16.16 value.
const fp16	FP_2_SQRTPI
	2/sqrt(pi) The inverse of the square root of pi as a Fixed-point Q16.16 value.
const fp16	FP_SQRT2
	sqrt(2) The square root of 2 as a Fixed-point Q16.16 value.
const fp16	FP_SQRT1_2
	1/sqrt(2) The inverse of the square root of 2 as a Fixed-point Q16.16 value.

Detailed Description

The qLibs++ library namespace.

Typedef Documentation

real_t

using qlibs::real_t

A type to instantiate a real variable double-precision of 64-bits IEEE 754.

Enumeration Type Documentation

matSpecial

enum qlibs::matSpecial

Enumerator
MAT_ZERO
MAT_IDENTITY
MAT_ALL
MAT_MAGIC