YANE-Framework 1.1.0

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
yane::EqSys::BanachFPClass for solving nonlinear equation problems using the Banach fixed point iteration
yane::EqSys::CholeskyClass of the Cholesky method for solving symmetric and positive definit linear equation problems
yane::EqSys::DirectMethodsParenting class for all direct solvers for linear equation problems
yane::EqSys::GaussClass of the Gauss Method for linear equation systems
yane::EqSys::GaussSeidelClass of the Jacobi Iteration Method for linear equation systems
yane::EqSys::IterativeMethodsParenting class for all iterative solvers for linear equation problems
yane::EqSys::JacobiClass of the Jacobi Iteration Method for linear equation systems
yane::EqSys::LinearEquationsClass for solving linear equation problems
yane::EqSys::NewtonClass for solving nonlinear equation problems using Newton's method
yane::EqSys::NonlinearEquationsClass for solving nonlinear equation problems
yane::EqSys::QRgivensClass of the QR solver for linear equation systems based on Givens rotations
yane::EqSys::QRhouseholderClass of the QR solver for linear equation systems based on Householder transformations
yane::MinProg::GaussNewtonClass to solve an optimization problem using the Gauss-Newton method
yane::MinProg::InitializingExceptionException if initialization of SQP algorithms fails
yane::MinProg::MinProgExceptionException in minimization algorithms
yane::MinProg::NLPClass to solve minimization problems subject to restrictions
yane::MinProg::SolverErrorMinimization routine has produced an critical error
yane::MinProg::SolverWarningMinimization routine has finisched with an noncritical warning
yane::MinProg::T_FUNCTIONSTRUCTStructure to commit parameters to the optimal control problem
yane::MinProg::T_RESTRICTIONSTRUCTStructure to commit parameters to the restrictionfunction
yane::Model::ModelAbstract class to define the model of the process and the optimal control problem to be solved
yane::Model::SimulatorThis class provides methods to simulate a given model of a process defined by a class yane::Model::Model object
yane::Model::StateEstimatorThis class estimates initial values of a given model
yane::Model::UndefinedExceptionUndefined exception
yane::ModelQt2::ConstraintsWidgetWidget to modify constraints of the class Model object which is simulated
yane::ModelQt2::InvalidLibraryExceptionException which is thrown if an invalid model library should be loaded
yane::ModelQt2::InvalidModelExceptionException which is thrown if an invalid model is handed over
yane::ModelQt2::ModelLoaderClass to load an application library which has been built separately
yane::ModelQt2::ParameterEditDelegateClass to update data within the widget as well as the model
yane::ModelQt2::ParameterWidgetWidget to modify parameters of the class Model object which is simulated
yane::ModelQt2::SimulatorThreadClass to simulate the trajectory for a given model and given controls
yane::ModelQt2::SimulatorWidgetCentral visualization widget
yane::MPC::AdaptiveMPCImplementation of an NMPC Algorithm with adaptation of the horizon length
yane::MPC::ASyncCacheCalculator
yane::MPC::CacheClass to save, identify and access intermediate results of trajectories computed by the class OdeManager object
yane::MPC::CacheOdeManagerImplementation of a manager class for solving the control system and its derivative optimized with respect to function evaluations
yane::MPC::DiscretizationClass for discretizing optimal control problem
yane::MPC::DualDecompositionMPCNot yet documented
yane::MPC::EstimationExceptionError in suboptimality estimate detected
yane::MPC::m21MPCNot yet documented
yane::MPC::ModelShootingDataClass for utilizing shooting nodes within a class yane::MPC::MPC object
yane::MPC::MPCClass for solving the model predictive control problem
yane::MPC::MPCExceptionException within the MPC algorithm
yane::MPC::MultiThreadCacheOdeManagerImplementation of a parallelized version of the class yane::MPC::CacheOdeManager
yane::MPC::NetworkedMPCConfigNot yet documented
yane::MPC::NetworkedMPCConfigExceptionError in neighbourhood configuration of MPC object detected
yane::MPC::NetworkedMPCConfigWarningNoncritical Error in neighbourhood configuration of MPC object detected
yane::MPC::OdeManagerImplementation of a parenting manager class for solving control systems and computing their derivatives
yane::MPC::PracticalExceptionPractical region of the suboptimality estimate reached
yane::MPC::SimpleOdeManagerImplementation of a simple manager class for solving the control system and its derivative
yane::MPC::StrategyExchangeMPCNot yet documented
yane::MPC::StrategyExchangeMPCParallelNot yet documented
yane::MPC::SuboptimalityExceptionViolation of the relaxed Lyapunov inequality
yane::MPC::SuboptimalityMPCImplementation of various suboptimality estimates for model predictive control laws
yane::MPC::SyncOdeManagerImplementation of a manager class for solving the control system and its derivative in a synchronized way
yane::MPC::T_MPCDATADefine a structure which is required to solve the dynamic of the optimal control problem
yane::MPC::T_SHOOTINGDATADefines a structure for the shooting nodes required for the MPC problem
yane::NetworkedControl::ActuatorImplementation of the actuator sided control sequence manager
yane::NetworkedControl::CommBaseTCPParenting class for TCP server and client objects
yane::NetworkedControl::ControlClipboard
yane::NetworkedControl::ControllerClass for simulating a distributed plant - sensor - controller - actuator setting
yane::NetworkedControl::ControllerThreadActuatorClass for implementing the actuator within a distributed plant - sensor - controller - actuator setting
yane::NetworkedControl::ControllerThreadInputClass for simulating the plant and sensor in a distributed plant - sensor - controller - actuator setting
yane::NetworkedControl::ControllerThreadMPCClass for simulating the controller in a distributed plant - sensor - controller - actuator setting
yane::NetworkedControl::ControllerThreadOutput
yane::NetworkedControl::CtrlClientTCP
yane::NetworkedControl::CtrlServerTCP
yane::NetworkedControl::CycleClass for handling discrete and continuous time sampling instances and times
yane::NetworkedControl::IOInterfaceClass for connecting components in a distributed plant - sensor - controller - actuator setting
yane::NetworkedControl::IOInterfaceLocalClass for connecting components in a distributed plant - sensor - controller - actuator setting with a simulated network connection
yane::NetworkedControl::IOInterfaceTCPClass for connecting components in a distributed plant - sensor - controller - actuator setting with a TCP network connection
yane::NetworkedControl::ModelHandlerTCP
yane::NetworkedControl::MPCControllerClass for simulating the controller in a distributed plant - sensor - controller - actuator setting with simulated network connection
yane::NetworkedControl::RealtimeActuatorImplementation of the actuator sided control sequence manager
yane::NetworkedControl::RealtimeMPCControllerClass for simulating a distributed plant - sensor - controller - actuator setting
yane::NetworkedControl::T_ACTORPACKETStructure accompanying an actuator package
yane::NetworkedControl::T_ENTRYStructure for available scheme data
yane::NetworkedControl::T_INPUTPACKETStructure accompanying an input package
yane::NetworkedControl::T_OUTPUTPACKETStructure accompanying an output package
yane::NetworkedControl::T_SCHEMEENTRYStructure for availalbe scheme entry data
yane::OdeSolve::DoPriClass of Dormand-Prince solvers for differential equation systems
yane::OdeSolve::DoPri5Class of the Dormand-Prince5(4) solver for differential equation systems
yane::OdeSolve::DoPri853Class of the Dormand-Prince8(5)3 solver for differential equation systems
yane::OdeSolve::DoPriConfigClass to configure all DoPri solvers
yane::OdeSolve::EulerClass of Radau solver for differential equation systems
yane::OdeSolve::HeunClass of Heun solver for differential equation systems
yane::OdeSolve::IncompatibleConfigExceptionException due to incompatible configuration object
yane::OdeSolve::IncompatibleDGLExceptionException due to incompatible differential or difference equation
yane::OdeSolve::NoInitialValueExceptionException due to uninitialized calls
yane::OdeSolve::OdeConfigClass of configuration possibilities for the differential equation solvers
yane::OdeSolve::OdeFunctionClass for transferring data from the user to the yane::OdeSolve::OdeSolve object
yane::OdeSolve::OdeSolExExceptions of the differential and difference equation solver
yane::OdeSolve::OdeSolveClass of solvers for ordinary differential equations
yane::OdeSolve::OdeSolveFirstClass of differential or difference equation systems
yane::OdeSolve::RadauClass of Radau solvers for differential equation systems
yane::OdeSolve::Radau5Class of Radau5 solver for differential equation systems
yane::OdeSolve::Radau5913Class of Radau5913 solver for differential equation systems
yane::OdeSolve::Radau5913ConfigClass to configure the Radau5913 solver
yane::OdeSolve::RadauConfigClass to configure all Radau solvers
yane::OdeSolve::RecurseSequenceClass to solve difference equation systems
yane::OdeSolve::RK4Class of Runge Kutta 4 solver for differential equation systems
yane::OdeSolve::ROCKClass of ROCK solvers for merely stiff differential equations (e.g. parabolic PDEs which are discretized using finite differences)
yane::OdeSolve::ROCK2Class of ROCK solver of order 2 for merely stiff differential equations
yane::OdeSolve::ROCK4Class of ROCK solver of order 4 for merely stiff differential equations
yane::OdeSolve::RodasClass of Rodas solvers for differential equation systems
yane::OdeSolve::RodasConfigClass to configure all Radau solvers
yane::OdeSolve::SingularyMatrixExceptionException due to a singularity in the matrix
yane::OdeSolve::StiffExceptionException due to stiffness of the problem
yane::OdeSolve::T_ODEPARAMSTypedef defining the function for the continuous time output of the solution of the differential equation system
yane::OdeSolve::TooManyStepsExceptionException due to too many steps of the solver
yane::OdeSolve::TooSmallStepSizeExceptionException due to too small step size
yane::OdeSolve::UnsuccessfulExceptionException due to unsuccessful termination of the solver
yane::OdeSolve::WrongSolverInputExceptionException due to wrong input to the solver
yane::SqpFortran::SqpFortranWrapper class for the SQP routine NLPQLP
yane::SqpNagC3::SqpNagCWrapper class for the SQP routine e04wdc from NAGC
yane::Utils::CodeClass with static methods for code conversions
yane::Utils::CRC32Class with a static method for crc32 computation
yane::Utils::DebugClientDebugClient class
yane::Utils::DebugMasterDebugMaster base class
yane::Utils::DebugMasterConsoleDebugMaster that writes to a class
yane::Utils::DebugMasterFileDebugMaster that writes to a file
yane::Utils::DebugMasterTextStreamDebugMaster that writes to a textstream
yane::Utils::ExceptionBase class for handling exceptions in the YANE framework
yane::Utils::FIFOBufferClass generating a First-In-First-Out buffer to manage data
yane::Utils::GridIONot yet documented
yane::Utils::GridReaderNot yet documented
yane::Utils::GridWriterNot yet documented
yane::Utils::IndexExceptionException due to accessing invalid array index
yane::Utils::IOExceptionException due to failure in accessing a file
yane::Utils::MatrixComputationClass for executing matrix multiplication
yane::Utils::MemoryExceptionException due to failure during memory allocation
yane::Utils::MutexMutex class
yane::Utils::NotInitializedExceptionException that is thrown, if an uninizialized Object shall be used
yane::Utils::OptimalDiffClass to compute the optimal differentiation step size
yane::Utils::ParallelComputingClass to do parallel computations
yane::Utils::ParallelComputing::T_TASKINFOStruct to specify computations
yane::Utils::RTClockTimer class
yane::Utils::SaveDataClass to save state and control values
yane::Utils::SemaphoreSemaphore class
yane::Utils::StatisticsClientStatisticsClient class
yane::Utils::StatisticsClientAverageStatisticsClientAverage class
yane::Utils::StatisticsClientIntCounterStatisticsClientIntCounter class
yane::Utils::StatisticsClientPerSecondStatisticsClientPerSecond class
yane::Utils::StatisticsMasterStatisticsMaster base class
yane::Utils::ThreadClass to create a thread
yane::Utils::ThreadExceptionException due to failure in thread context
yane::Utils::UuidClass for generating and managing universally unique identifiers (UUID)
yane::Utils::ValueExceptionException due to invalid value
yane::YaneIpopt::NLPProblemClass to implement the problem which should be solved with Ipopt
yane::YaneIpopt::YaneIpoptClass for the Interior-Point routine Ipopt