HQP  1.9.6
Omu_SVarVec Class Reference

Depreciated: Internally used vector of state optimization variables holding additional structural information. More...

#include <Omu_Vars.h>

Inheritance diagram for Omu_SVarVec:
[legend]

Public Member Functions

void alloc (int n, int n_expand=-1)
 Allocate vectors of size n_expand for min, max, initial, and this (default n_expand = n). More...
 
- Public Member Functions inherited from Omu_VariableVec
 Omu_VariableVec ()
 allocate empty vectors
 
virtual ~Omu_VariableVec ()
 destroy vectors
 
int n () const
 Number of variables treated by the optimizer, n <= n_expand = dim. More...
 
- Public Member Functions inherited from Omu_Vec
 Omu_Vec ()
 allocate empty vector
 
virtual ~Omu_Vec ()
 destroy vector
 
void resize (int dim)
 resize vector
 
- Public Member Functions inherited from Mesch::VECP
 VECP ()
 
 VECP (VEC *cv)
 
VEC * operator= (VEC *nv)
 
Real & operator[] (int j)
 
VEC * operator-> ()
 
 operator VEC * ()
 
 operator const VEC * ()
 
const Real & operator[] (int j) const
 
const VEC * operator-> () const
 
 operator const VEC * () const
 

Public Attributes

int nd
 number of discrete-time state variables
 
int na
 number of algebraic state variables
 
int nv
 number of expansion variables
 
VECP D
 diagonal of dF/ddx
 
bool D_is_const
 F can be treated as explicit ODE.
 
int sbw_u
 upper semi-bandwidth of dF/dx + dF/ddx
 
int sbw_l
 lower semi-bandwidth of dF/dx + dF/ddx
 
IVECP flags
 Define flagbits to characterize individual states. More...
 
- Public Attributes inherited from Omu_VarVec
bool c_setup
 indicate allowance for allocation of variables
 
bool c_expand
 indicate allowance to allocate exansion variables
 
- Public Attributes inherited from Omu_VariableVec
VECP min
 minimal permitted values (default: -Inf)
 
VECP max
 maximal permitted values (default: +Inf)
 
VECP initial
 initial values (default: 0.0)
 
IVECP integer
 integer variables (default: 0)
 

Static Public Attributes

static const int Discrete
 Indicate a discrete-time state, which is not defined with F.
 
static const int Algebraic
 Indicate an algebraic state, which is defined with F, but whose time derivative does not appear.
 

Additional Inherited Members

- Protected Member Functions inherited from Omu_Vec
 Omu_Vec (const Omu_Vec &v)
 protect copy constructor and operator= as they should not be used
 
Omu_Vecoperator= (const Omu_Vec &v)
 
- Protected Attributes inherited from Mesch::VECP
VEC * _v
 wrapped VEC*
 

Detailed Description

Depreciated: Internally used vector of state optimization variables holding additional structural information.

Member Function Documentation

void Omu_SVarVec::alloc ( int  n,
int  n_expand = -1 
)
virtual

Allocate vectors of size n_expand for min, max, initial, and this (default n_expand = n).

A derived classes may overload alloc() to restrict the capability of allocations for specific vectors.

Reimplemented from Omu_VarVec.

Member Data Documentation

IVECP Omu_SVarVec::flags

Define flagbits to characterize individual states.

This makes nd and nv obsolete. They should not be accessed anymore as they will be removed in a later version.


The documentation for this class was generated from the following file: