Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

ACADO | Forward declarations |

CasADi | Casadi_limits class The following class, which acts as a complements to the standard numeric_limits class, allows to specify certain properties of scalar objects. The template can be specialized for e.g. symbolic scalars |

Interfaces | |

OOQPInternal | |

OOQPSolver | |

QPOasesInternal | |

QPOasesSolver | |

IpoptQPInternal | |

IpoptQPSolver | |

LiftoptInternal | |

LiftoptSolver | |

LapackQRDenseInternal | |

LapackQRDense | |

LapackLUDenseInternal | |

LapackLUDense | |

CSparseInternal | |

CSparse | |

OptimalControl | |

MultipleShootingInternal | |

MultipleShooting | |

CollocationInternal | |

Collocation | |

Sundials | |

SundialsInternal | |

SundialsIntegrator | |

CVodesInternal | |

CVodesIntegrator | |

IdasInternal | |

IdasIntegrator | |

KinsolInternal | |

KinsolSolver | |

CachedObject | A cached reference counted object |

CachedObjectNode | Internal class |

WeakRef | A weak reference to a cached object |

UnaryOperation | |

BinaryOperation | |

BinaryOperationE | |

AddBinaryOperation | |

SubBinaryOperation | |

MulBinaryOperation | |

DivBinaryOperation | |

DerBinaryOpertion | Calculate function and derivative |

SmoothChecker | Smoothness (by default true) |

SmoothChecker< OP_LT > | |

SmoothChecker< OP_LE > | |

SmoothChecker< OP_FLOOR > | |

SmoothChecker< OP_CEIL > | |

SmoothChecker< OP_EQ > | |

SmoothChecker< OP_NE > | |

SmoothChecker< OP_SIGN > | |

SmoothChecker< OP_NOT > | |

SmoothChecker< OP_AND > | |

SmoothChecker< OP_OR > | |

F0XChecker | If evaluated with the first argument zero, is the result zero? |

F0XChecker< OP_ASSIGN > | |

F0XChecker< OP_MUL > | |

F0XChecker< OP_DIV > | |

F0XChecker< OP_NEG > | |

F0XChecker< OP_SQRT > | |

F0XChecker< OP_SIN > | |

F0XChecker< OP_TAN > | |

F0XChecker< OP_ASIN > | |

F0XChecker< OP_FLOOR > | |

F0XChecker< OP_CEIL > | |

F0XChecker< OP_FABS > | |

F0XChecker< OP_SIGN > | |

F0XChecker< OP_ERF > | |

F0XChecker< OP_SINH > | |

F0XChecker< OP_TANH > | |

F0XChecker< OP_ASINH > | |

F0XChecker< OP_ATANH > | |

F0XChecker< OP_ERFINV > | |

F0XChecker< OP_AND > | |

FX0Checker | If evaluated with the second argument zero, is the result zero? |

FX0Checker< OP_MUL > | |

FX0Checker< OP_AND > | |

F00Checker | If evaluated with both arguments zero, is the result zero? |

F00Checker< OP_ADD > | |

F00Checker< OP_SUB > | |

F00Checker< OP_FMIN > | |

F00Checker< OP_FMAX > | |

F00Checker< OP_AND > | |

F00Checker< OP_OR > | |

CommChecker | Is commutative |

CommChecker< OP_SUB > | |

CommChecker< OP_DIV > | |

CommChecker< OP_POW > | |

CommChecker< OP_CONSTPOW > | |

CommChecker< OP_PRINTME > | |

CommChecker< OP_ATAN2 > | |

BinaryChecker | Is the operation binary as opposed to unary |

BinaryChecker< OP_ADD > | |

BinaryChecker< OP_SUB > | |

BinaryChecker< OP_MUL > | |

BinaryChecker< OP_DIV > | |

BinaryChecker< OP_POW > | |

BinaryChecker< OP_CONSTPOW > | |

BinaryChecker< OP_EQ > | |

BinaryChecker< OP_NE > | |

BinaryChecker< OP_AND > | |

BinaryChecker< OP_OR > | |

BinaryChecker< OP_FMIN > | |

BinaryChecker< OP_FMAX > | |

BinaryChecker< OP_PRINTME > | |

BinaryChecker< OP_ATAN2 > | |

UnaryOperation< OP_ASSIGN > | Simple assignment |

BinaryOperation< OP_ADD > | Addition |

BinaryOperation< OP_SUB > | Subtraction |

BinaryOperation< OP_MUL > | Multiplication |

BinaryOperation< OP_DIV > | Division |

UnaryOperation< OP_NEG > | Negation |

UnaryOperation< OP_EXP > | Natural exponent |

UnaryOperation< OP_LOG > | Natural logarithm |

BinaryOperation< OP_POW > | Power, defined only for x>=0 |

BinaryOperation< OP_CONSTPOW > | Power, defined only for y constant |

UnaryOperation< OP_SQRT > | Square root |

UnaryOperation< OP_SIN > | Sine |

UnaryOperation< OP_COS > | Cosine |

UnaryOperation< OP_TAN > | Tangent |

UnaryOperation< OP_ASIN > | Arcus sine |

UnaryOperation< OP_ACOS > | Arcus cosine |

UnaryOperation< OP_ATAN > | Arcus tangent |

BinaryOperation< OP_LT > | Less than |

BinaryOperation< OP_LE > | Less or equal to |

UnaryOperation< OP_FLOOR > | Floor function |

UnaryOperation< OP_CEIL > | Ceil function |

BinaryOperation< OP_EQ > | Equal to |

BinaryOperation< OP_NE > | Not equal to |

UnaryOperation< OP_NOT > | Logical not |

BinaryOperation< OP_AND > | Logical and |

BinaryOperation< OP_OR > | Logical or |

UnaryOperation< OP_ERF > | Error function |

UnaryOperation< OP_FABS > | Absolute value |

UnaryOperation< OP_SIGN > | Sign |

BinaryOperation< OP_FMIN > | Minimum |

BinaryOperation< OP_FMAX > | Maximum |

UnaryOperation< OP_INV > | Elementwise inverse |

UnaryOperation< OP_SINH > | Hyperbolic sine |

UnaryOperation< OP_COSH > | Hyperbolic cosine |

UnaryOperation< OP_TANH > | Hyperbolic tangent |

UnaryOperation< OP_ASINH > | Inverse hyperbolic sine |

UnaryOperation< OP_ACOSH > | Inverse hyperbolic cosine |

UnaryOperation< OP_ATANH > | Inverse hyperbolic tangent |

UnaryOperation< OP_ERFINV > | Inverse of error function |

BinaryOperation< OP_PRINTME > | Identity operator with the side effect of printing |

BinaryOperation< OP_ATAN2 > | Arctan2 |

CasadiException | Casadi exception class |

casadi_limits | |

casadi_math | Easy access to all the functions for a particular type |

casadi_math< int > | Specialize the class so that it can be used with integer type |

CasadiOptions | Collects global CasADi options |

CFunction | Interface to function implemented as plain code |

CFunctionInternal | Internal class for CFunction |

ControlSimulator | Piecewise Simulation class A ControlSimulator can be seen as a chain of Simulators whereby some parameters change from one Simulator to the next |

ControlSimulatorInternal | ControlSimulator data storage classs |

ExternalFunction | Interface for a function that is not implemented by CasADi symbolics |

ExternalFunctionInternal | |

FunctionIO | Structure that contains the numerical values for the inputs or outputs of a function |

FX | General function |

FXInternal | Internal class for FX |

ImplicitFunction | |

ImplicitFunctionInternal | Internal class |

Integrator | |

IntegratorInternal | Internal storage for integrator related data |

Jacobian | Jacobian class |

JacobianInternal | Internal node class for Jacobian |

LinearSolver | |

LinearSolverInternal | |

MXAlgEl | An elemenent of the algorithm, namely an MX node |

MXFunction | General function mapping from/to MX |

MXFunctionInternal | Internal node class for MXFunction |

NLPSolver | NLPSolver |

NLPSolverInternal | NLP solver storage class |

OCPSolver | Base class for OCP solvers |

OCPSolverInternal | Internal node class for OCPSolver |

Parallelizer | Parallelizer execution of functions |

ParallelizerInternal | Internal node class for Parallelizer |

QPSolver | QPSolver |

QPSolverInternal | Internal class |

Simulator | Integrator class An "simulator" integrates an IVP, stopping at a (fixed) number of grid points and evaluates a set of output functions at these points. The internal stepsizes of the integrator need not coincide with the gridpoints |

SimulatorInternal | Simulator data storage classs |

SXAlgEl | An atomic operation for the SX virtual machine |

SXFunction | Dynamically created function that can be expanded into a series of scalar operations |

SXFunctionInternal | Internal node class for SXFunction A regular user should never work with any Node class. Use SXFunction directly |

int_compiletime | Helper class to be plugged into evaluateGen when working with a value known already at compiletime |

int_runtime | Helper class to be plugged into evaluateGen when working with a value known only at runtime |

TapeEl | An elemenent of the tape |

XFunctionInternal | Internal node class for the base class of SXFunctionInternal and MXFunctionInternal (lacks a public counterpart) The design of the class uses the curiously recurring template pattern (CRTP) idiom |

GenericType | Generic data type |

GenericTypeInternal | |

CRSSparsity | General sparsity class |

CRSSparsityInternal | |

GenericExpression | Expression interface This is a common base class for SX, MX and Matrix<>, introducing a uniform syntax and implementing common functionality using the curiously recurring template pattern (CRTP) idiom. |

GenericMatrix | Matrix base class This is a common base class for MX and Matrix<>, introducing a uniform syntax and implementing common functionality using the curiously recurring template pattern (CRTP) idiom. |

NonZero | |

NonZeroIterator | |

Matrix | General sparse matrix class General sparse matrix class that is designed with the idea that "everything is a matrix", that is, also scalars and vectors. This philosophy makes it easy to use and to interface in particularily with Python and Matlab/Octave. |

NonZeros | Access to a set of nonzeros |

Slice | |

IndexSet | |

IndexList | |

SubMatrix | Submatrix |

BinaryMX | Represents any binary operation that involves two matrices |

SparseSparseOp | A sparse matrix-matrix binary operation |

NonzerosScalarOp | A matrix-scalar binary operation where one loops only over nonzeros of the matrix |

ScalarNonzerosOp | A scalar-matrix binary operation where one loops only over nonzeros of the matrix |

NonzerosNonzerosOp | A matrix-matrix binary operation with matching nonzeros |

ConstantMX | Represents an MX that is only composed of a constant |

Densification | Make an expression dense |

EvaluationMX | |

IfNode | Represents a branch in an MX tree TODO: Change name of file |

JacobianReference | Maps non-zero elements |

Mapping | Maps non-zero elements |

OutputNZ | Input nonzero and dependency index |

MultipleOutput | |

OutputNode | |

Multiplication | An MX atomic for matrix-matrix product, note that the factor must be provided transposed |

MX | MX - Matrix expression The MX class is used to build up trees made up from MXNodes. It is a more general graph representation than the scalar expression, SX, and much less efficient for small objects. On the other hand, the class allows much more general operations than does SX, in particular matrix valued operations and calls to arbitrary differentiable functions |

MXNode | Node class for MX objects |

Norm | Matrix and vector norms This base class and the derived classes represent matrix and vector norms that are intended to be used when formulating convex optimization problems. Note that they are not intended to be evaluated numerically or differentiated, instead the idea is that they should be eliminated from the computational graph during a reformulation (cf. CVX software) |

Norm2 | Represents a 2-norm |

NormF | Represents a Frobenius norm |

Norm1 | 1-norm |

NormInf | Represents an infinity-norm operation on a MX |

SymbolicMX | Represents a symbolic MX |

UnaryMX | Represents a general unary operation on an MX |

mysortclass | A helper class to use stl::sort in OptionsFunctionalityNode::getBestMatches |

OptionsFunctionality | Provides options setting/getting functionality Gives a derived class the ability to set and retrieve options in a convenient way. It also contains error checking, making sure that the option exists and that the value type is correct |

OptionsFunctionalityNode | Internal class |

PrintableObject | Base class for objects that have a natural string representation |

SharedObject | SharedObject implements a reference counting framework simular for effient and easily-maintained memory management |

SharedObjectNode | Internal class for the reference counting framework, see comments on the public class |

AuxOutputSX | Represents an auxillary output of a function |

BinarySX | Represents a basic binary operation on two SX nodes |

ConstantSX | Represents a constant SX |

RealtypeSX | DERIVED CLASSES |

IntegerSX | Represents a constant integer SX |

ZeroSX | Represents a zero SX |

OneSX | Represents a one SX |

MinusOneSX | Represents a minus one SX |

InfSX | Represents an infinity SX |

MinusInfSX | Represents a minus infinity SX |

NanSX | Represents a not-a-number SX |

EvaluationSX | Represents a function call |

SX | The basic scalar symbolic class of CasADi |

casadi_limits< SX > | |

SXNode | Interal node class for SX |

SymbolicSX | Represents a scalar symbolic expression |

UnarySX | Represents a basic unary operation on an SX node |

AcadoFunction | CasADi to ACADO function interface |

AcadoIntegrator | |

AcadoIntegratorBackend | |

AcadoIntegratorInternal | |

AcadoOCP | |

AcadoOCPInternal | |

CplexMatrix | CplexMatrix is a class used to convert CasADi matrices to CPLEX format (similar to CSC). The class definition can be found in cplex_internal.cpp |

CplexInternal | |

CplexSolver | Interface to CPLEX solver |

CSparse | LinearSolver with CSparse Interface |

CSparseInternal | |

IpoptInternal | |

IpoptUserClass | |

IpoptQPInternal | Internal class for IpoptQPSolver |

IpoptQPSolver | IPOPT QP Solver for quadratic programming |

IpoptSolver | Interface to IPOPT NLP solver |

KnitroInternal | |

KnitroSolver | |

LapackLUDense | LU LinearSolver with Lapack Interface |

LapackLUDenseInternal | Internal class |

LapackQRDense | QR LinearSolver with Lapack Interface |

LapackQRDenseInternal | Internal class |

CasadiLifter | |

LiftoptInternal | |

LiftoptSolver | |

ResEntry | |

MuscodFunction | CasADi to MUSCOD function interface |

MuscodInterface | |

MuscodInternal | |

OOQPInternal | Internal class for OOQPSolver |

OOQPSolver | |

QPOasesInternal | Internal class for QPOasesSolver |

QPOasesSolver | Interface to QPOases Solver for quadratic programming |

CVodesIntegrator | |

CVodesInternal | |

IdasIntegrator | |

IdasInternal | |

KinsolInternal | |

KinsolSolver | Kinsol solver class |

SundialsIntegrator | |

SundialsInternal | |

LinSolDataDense | Linear solver data (dense) |

WorhpInternal | |

WorhpSolver | Interface to WORHP NLP solver |

Collocation | Direct collocation |

CollocationInternal | |

MultipleShooting | Multiple Shooting |

MultipleShootingInternal | |

SymbolicOCP | A flat OCP representation coupled to an XML file |

Variable | Smart pointer class to a Variable |

VariableInternal | Internal node class |

XMLNode | |

CollocationIntegrator | Collocation integrator ODE/DAE integrator based on collocation |

CollocationIntegratorInternal | |

RKIntegrator | Fixed step Runge-Kutta integrator ODE integrator based on explicit Runge-Kutta methods |

RKIntegratorInternal | |

IPInternal | |

IPMethod | Interior point method This method is experimental only. Do not attempt to use if you do not intend to dive into the source code. The current purpose of the class is to show how an IP method can be implemeted in CasADi. If someone wants to take responsibility for this class and make it work, then please contact the CasADi developers |

LiftedSQP | Sequential Quadratic Programming method implementing the Lifted Newton approach symbolically |

LiftedSQPInternal | |

SQPInternal | |

SQPMethod | Sequential Quadratic Programming method The algorithm is a classical SQP method with either exact (has to be provided) or damped BFGS Lagrange Hessian approximation. Two different line-search algorithms are available. First, Armijo (Wolfe) condition with backtracking (suffers from Maratos effect). Second, a line-search method that checks if the merit function is lower than the last k values (no Maratos effect). Both methods employ the L1 merit function |

SymbolicNLP | A symbolic NLP representation |

KINEMATICS | |

Frame | Define the concept of a mechanical frame |

FrameNode | Internal class to make Frame trees reference-safe |

KinVec | Represent kinematical vectors |

ModelSimulator | |

std | Convenience tools for STL vectors |

numeric_limits< CasADi::SX > |

Generated for CasADi by 1.8.1.2