humoto
Public Member Functions | Private Attributes | List of all members
humoto::ActiveSetConstraints Class Reference

Detailed Description

Active set corresponding to Constraints class.

Definition at line 43 of file active_set.h.

#include <active_set.h>

Public Member Functions

void copyFrom (const ActiveSetConstraints &other_active_set, const Location &location)
 Set type of a set of constraints. More...
 
void copyTo (const Location &location, const ActiveSetConstraints &other_active_set)
 Set type of a set of constraints. More...
 
std::size_t countActiveInequalities () const
 Returns number of active inequality constraints. More...
 
void initialize (const std::size_t number_of_constraints)
 Initialize active set. More...
 
void initialize (const ActiveSetConstraints &other_active_set, const Location &location)
 Initialize active set. More...
 
void initialize (const std::size_t number_of_constraints, const ConstraintActivationType::Type type)
 Initialize active set. More...
 
void log (humoto::Logger &logger, const LogEntryName &parent=LogEntryName(), const std::string &name="") const
 Log an active set. More...
 
const humoto::ConstraintActivationType::Typeoperator[] (const std::size_t constraint_index) const
 Access activation flag of a constraint (const) More...
 
humoto::ConstraintActivationType::Typeoperator[] (const std::size_t constraint_index)
 Access activation flag of a constraint. More...
 
void reset ()
 Reset active set. More...
 
void set (const ConstraintActivationType::Type type)
 Set type of all constraints. More...
 
void set (const Location &location, const ConstraintActivationType::Type type)
 Set type of a set of constraints. More...
 
void shift (const std::size_t shift_size, const ConstraintActivationType::Type type)
 Shift active set forward while preserving the length, the trailing elements are initialized with the given type. More...
 
std::size_t size () const
 Size of the active set. More...
 

Private Attributes

std::vector< humoto::ConstraintActivationType::Typedata_
 

Member Function Documentation

◆ copyFrom()

void humoto::ActiveSetConstraints::copyFrom ( const ActiveSetConstraints other_active_set,
const Location location 
)
inline

Set type of a set of constraints.

Parameters
[in]other_active_setother active set
[in]locationlocation in other active set

Definition at line 150 of file active_set.h.

◆ copyTo()

void humoto::ActiveSetConstraints::copyTo ( const Location location,
const ActiveSetConstraints other_active_set 
)
inline

Set type of a set of constraints.

Parameters
[in]locationlocation in this active set
[in]other_active_setother active set

Definition at line 133 of file active_set.h.

◆ countActiveInequalities()

std::size_t humoto::ActiveSetConstraints::countActiveInequalities ( ) const
inline

Returns number of active inequality constraints.

Returns
number of active inequality constraints.

Definition at line 238 of file active_set.h.

◆ initialize() [1/3]

void humoto::ActiveSetConstraints::initialize ( const std::size_t  number_of_constraints)
inline

Initialize active set.

Parameters
[in]number_of_constraintsnumber of constraints for each level

Definition at line 167 of file active_set.h.

◆ initialize() [2/3]

void humoto::ActiveSetConstraints::initialize ( const ActiveSetConstraints other_active_set,
const Location location 
)
inline

Initialize active set.

Parameters
[in]other_active_setother active set
[in]locationlocation in other active set

Definition at line 180 of file active_set.h.

◆ initialize() [3/3]

void humoto::ActiveSetConstraints::initialize ( const std::size_t  number_of_constraints,
const ConstraintActivationType::Type  type 
)
inline

Initialize active set.

Parameters
[in]number_of_constraintsnumber of constraints for each level
[in]typetype of the constraints

Definition at line 201 of file active_set.h.

◆ log()

void humoto::ActiveSetConstraints::log ( humoto::Logger logger,
const LogEntryName parent = LogEntryName(),
const std::string &  name = "" 
) const
inline

Log an active set.

Parameters
[in,out]loggerlogger
[in]parentparent
[in]namename

Definition at line 266 of file active_set.h.

◆ operator[]() [1/2]

const humoto::ConstraintActivationType::Type& humoto::ActiveSetConstraints::operator[] ( const std::size_t  constraint_index) const
inline

Access activation flag of a constraint (const)

Parameters
[in]constraint_index
Returns
reference to the activation flag

Definition at line 56 of file active_set.h.

◆ operator[]() [2/2]

humoto::ConstraintActivationType::Type& humoto::ActiveSetConstraints::operator[] ( const std::size_t  constraint_index)
inline

Access activation flag of a constraint.

Parameters
[in]constraint_index
Returns
reference to the activation flag

Definition at line 71 of file active_set.h.

◆ reset()

void humoto::ActiveSetConstraints::reset ( )
inline

Reset active set.

Definition at line 93 of file active_set.h.

◆ set() [1/2]

void humoto::ActiveSetConstraints::set ( const ConstraintActivationType::Type  type)
inline

Set type of all constraints.

Parameters
[in]typetype of the constraints

Definition at line 104 of file active_set.h.

◆ set() [2/2]

void humoto::ActiveSetConstraints::set ( const Location location,
const ConstraintActivationType::Type  type 
)
inline

Set type of a set of constraints.

Parameters
[in]location
[in]type

Definition at line 117 of file active_set.h.

◆ shift()

void humoto::ActiveSetConstraints::shift ( const std::size_t  shift_size,
const ConstraintActivationType::Type  type 
)
inline

Shift active set forward while preserving the length, the trailing elements are initialized with the given type.

Parameters
[in]shift_sizeshift size
[in]typetype of the trailing elements

Definition at line 217 of file active_set.h.

◆ size()

std::size_t humoto::ActiveSetConstraints::size ( ) const
inline

Size of the active set.

Returns
Size of the active set.

Definition at line 84 of file active_set.h.

Member Data Documentation

◆ data_

std::vector<humoto::ConstraintActivationType::Type> humoto::ActiveSetConstraints::data_
private

Definition at line 46 of file active_set.h.


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