numkit-doxy/analyze_8hpp_source.html

// toolboxes/control/include/nk/control/analyze/analyze.hpp

//

// Steady-state and time-domain quality metrics on top of the

// existing tf/zpk/ss + step/bode primitives.


#pragma once


#include <memory_resource>

#include <nk/value/value.hpp>


namespace nk::control {


Value dcgain(const Value &sys, std::pmr::memory_resource *mr = nullptr);


struct MarginResult {

    Value Gm;

    Value Pm;

    Value Wcg;

    Value Wcp;

};


MarginResult margin(const Value &sys,

                    std::pmr::memory_resource *mr = nullptr);


Value stepinfo(const Value &sys, std::pmr::memory_resource *mr = nullptr);


Value allmargin(const Value &sys, std::pmr::memory_resource *mr = nullptr);


Value hinfnorm(const Value &sys, std::pmr::memory_resource *mr = nullptr);


} // namespace nk::control

nk::Value
Core MATLAB-compatible multidimensional array and scalar value type.
Definition value.hpp:61

nk::control::hinfnorm
Value hinfnorm(const Value &sys, std::pmr::memory_resource *mr=nullptr)
H-infinity norm of a continuous-time LTI system (g = hinfnorm(sys)).

nk::control::dcgain
Value dcgain(const Value &sys, std::pmr::memory_resource *mr=nullptr)
DC (steady-state) gain of an LTI system.

nk::control::stepinfo
Value stepinfo(const Value &sys, std::pmr::memory_resource *mr=nullptr)
Step-response quality metrics (S = stepinfo(sys)).

nk::control::allmargin
Value allmargin(const Value &sys, std::pmr::memory_resource *mr=nullptr)
All stability margins as a struct (S = allmargin(sys)).

nk::control::margin
MarginResult margin(const Value &sys, std::pmr::memory_resource *mr=nullptr)
Gain and phase margins ([Gm, Pm, Wcg, Wcp] = margin(sys)).

nk::control::MarginResult
Result of margin(sys) — gain / phase margin pair plus the frequencies at which they occur.
Definition analyze.hpp:42

nk::control::MarginResult::Wcp
Value Wcp
Gain-crossover frequency (where |H| = 1), rad/s.
Definition analyze.hpp:46

nk::control::MarginResult::Gm
Value Gm
Gain margin (linear, not dB).
Definition analyze.hpp:43

nk::control::MarginResult::Pm
Value Pm
Phase margin in degrees.
Definition analyze.hpp:44

nk::control::MarginResult::Wcg
Value Wcg
Phase-crossover frequency (where phase = −180°), rad/s.
Definition analyze.hpp:45