Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
corbo::VertexSetInterface Class Referenceabstract

Abstract class representing a set of vertices. More...

#include <vertex_set.h>

Inheritance diagram for corbo::VertexSetInterface:
Inheritance graph
[legend]

Public Types

using Ptr = std::shared_ptr< VertexSetInterface >
 

Public Member Functions

void applyIncrementNonFixed (const Eigen::Ref< const Eigen::VectorXd > &increment)
 Active vertices related methods. More...
 
void applyIncrementNonFixed (int idx, double increment)
 
void backupParametersActiveVertices ()
 
virtual void clear ()=0
 
void clearConnectedEdges ()
 
virtual void computeActiveVertices ()=0
 
void computeVertexIndices ()
 Precompute vertex indices in the hyper-graph (e.g. for the Jacobian or Hessian structure) More...
 
void discardBackupParametersActiveVertices (bool all=false)
 
virtual std::vector< VertexInterface * > & getActiveVertices ()=0
 
void getBounds (Eigen::Ref< Eigen::VectorXd > lb, Eigen::Ref< Eigen::VectorXd > ub)
 
double getLowerBound (int idx)
 
int getParameterDimension ()
 
double getParameterValue (int idx)
 
void getParameterVector (Eigen::Ref< Eigen::VectorXd > x)
 
double getUpperBound (int idx)
 
virtual void getVertices (std::vector< VertexInterface * > &vertices)=0
 
bool isModified () const
 
void restoreBackupParametersActiveVertices (bool keep_backup)
 
void setBounds (const Eigen::Ref< const Eigen::VectorXd > &lb, const Eigen::Ref< const Eigen::VectorXd > &ub)
 
void setLowerBound (int idx, double lb)
 
void setModified (bool modified)
 
void setParameterValue (int idx, double x)
 
void setParameterVector (const Eigen::Ref< const Eigen::VectorXd > &x)
 
void setUpperBound (int idx, double ub)
 
 VertexSetInterface ()
 
virtual ~VertexSetInterface ()
 Virtual destructor. More...
 

Protected Member Functions

void setVertexIdx (VertexInterface &vertex, int idx)
 

Protected Attributes

bool _modified = true
 

Detailed Description

Abstract class representing a set of vertices.

See also
HyperGraph VertexInterface
Author
Christoph Rösmann (chris.nosp@m.toph.nosp@m..roes.nosp@m.mann.nosp@m.@tu-d.nosp@m.ortm.nosp@m.und.d.nosp@m.e)

Definition at line 67 of file vertex_set.h.

Member Typedef Documentation

◆ Ptr

using corbo::VertexSetInterface::Ptr = std::shared_ptr<VertexSetInterface>

Definition at line 92 of file vertex_set.h.

Constructor & Destructor Documentation

◆ VertexSetInterface()

corbo::VertexSetInterface::VertexSetInterface ( )
inline

Definition at line 94 of file vertex_set.h.

◆ ~VertexSetInterface()

virtual corbo::VertexSetInterface::~VertexSetInterface ( )
inlinevirtual

Virtual destructor.

Definition at line 97 of file vertex_set.h.

Member Function Documentation

◆ applyIncrementNonFixed() [1/2]

void corbo::VertexSetInterface::applyIncrementNonFixed ( const Eigen::Ref< const Eigen::VectorXd > &  increment)

Active vertices related methods.

Definition at line 379 of file vertex_set.cpp.

◆ applyIncrementNonFixed() [2/2]

void corbo::VertexSetInterface::applyIncrementNonFixed ( int  idx,
double  increment 
)

Definition at line 391 of file vertex_set.cpp.

◆ backupParametersActiveVertices()

void corbo::VertexSetInterface::backupParametersActiveVertices ( )

Definition at line 453 of file vertex_set.cpp.

◆ clear()

virtual void corbo::VertexSetInterface::clear ( )
pure virtual

Implemented in corbo::DiscretizationGridInterface, corbo::VertexSet, corbo::NonUniformShootingGridBase, corbo::ShootingGridBase, corbo::FullDiscretizationGridBase, and corbo::NonUniformFullDiscretizationGridBase.

◆ clearConnectedEdges()

void corbo::VertexSetInterface::clearConnectedEdges ( )

Definition at line 442 of file vertex_set.cpp.

◆ computeActiveVertices()

virtual void corbo::VertexSetInterface::computeActiveVertices ( )
pure virtual

Implemented in corbo::DiscretizationGridInterface, corbo::NonUniformShootingGridBase, corbo::ShootingGridBase, corbo::FullDiscretizationGridBase, corbo::NonUniformFullDiscretizationGridBase, corbo::VertexSet, and corbo::FullDiscretizationGridMoveBlockingBase.

◆ computeVertexIndices()

void corbo::VertexSetInterface::computeVertexIndices ( )

Precompute vertex indices in the hyper-graph (e.g. for the Jacobian or Hessian structure)

Definition at line 427 of file vertex_set.cpp.

◆ discardBackupParametersActiveVertices()

void corbo::VertexSetInterface::discardBackupParametersActiveVertices ( bool  all = false)

Definition at line 470 of file vertex_set.cpp.

◆ getActiveVertices()

virtual std::vector<VertexInterface*>& corbo::VertexSetInterface::getActiveVertices ( )
pure virtual

Implemented in corbo::DiscretizationGridInterface, corbo::NonUniformShootingGridBase, corbo::ShootingGridBase, corbo::FullDiscretizationGridBase, corbo::NonUniformFullDiscretizationGridBase, and corbo::VertexSet.

◆ getBounds()

void corbo::VertexSetInterface::getBounds ( Eigen::Ref< Eigen::VectorXd >  lb,
Eigen::Ref< Eigen::VectorXd >  ub 
)

Definition at line 181 of file vertex_set.cpp.

◆ getLowerBound()

double corbo::VertexSetInterface::getLowerBound ( int  idx)

Definition at line 241 of file vertex_set.cpp.

◆ getParameterDimension()

int corbo::VertexSetInterface::getParameterDimension ( )

Definition at line 51 of file vertex_set.cpp.

◆ getParameterValue()

double corbo::VertexSetInterface::getParameterValue ( int  idx)

Definition at line 60 of file vertex_set.cpp.

◆ getParameterVector()

void corbo::VertexSetInterface::getParameterVector ( Eigen::Ref< Eigen::VectorXd >  x)

Definition at line 129 of file vertex_set.cpp.

◆ getUpperBound()

double corbo::VertexSetInterface::getUpperBound ( int  idx)

Definition at line 274 of file vertex_set.cpp.

◆ getVertices()

virtual void corbo::VertexSetInterface::getVertices ( std::vector< VertexInterface * > &  vertices)
pure virtual

Implemented in corbo::DiscretizationGridInterface, corbo::NonUniformShootingGridBase, corbo::ShootingGridBase, corbo::FullDiscretizationGridBase, corbo::NonUniformFullDiscretizationGridBase, and corbo::VertexSet.

◆ isModified()

bool corbo::VertexSetInterface::isModified ( ) const
inline

Definition at line 127 of file vertex_set.h.

◆ restoreBackupParametersActiveVertices()

void corbo::VertexSetInterface::restoreBackupParametersActiveVertices ( bool  keep_backup)

Definition at line 458 of file vertex_set.cpp.

◆ setBounds()

void corbo::VertexSetInterface::setBounds ( const Eigen::Ref< const Eigen::VectorXd > &  lb,
const Eigen::Ref< const Eigen::VectorXd > &  ub 
)

Definition at line 211 of file vertex_set.cpp.

◆ setLowerBound()

void corbo::VertexSetInterface::setLowerBound ( int  idx,
double  lb 
)

Definition at line 307 of file vertex_set.cpp.

◆ setModified()

void corbo::VertexSetInterface::setModified ( bool  modified)
inline

Definition at line 126 of file vertex_set.h.

◆ setParameterValue()

void corbo::VertexSetInterface::setParameterValue ( int  idx,
double  x 
)

Definition at line 93 of file vertex_set.cpp.

◆ setParameterVector()

void corbo::VertexSetInterface::setParameterVector ( const Eigen::Ref< const Eigen::VectorXd > &  x)

Definition at line 155 of file vertex_set.cpp.

◆ setUpperBound()

void corbo::VertexSetInterface::setUpperBound ( int  idx,
double  ub 
)

Definition at line 343 of file vertex_set.cpp.

◆ setVertexIdx()

void corbo::VertexSetInterface::setVertexIdx ( VertexInterface &  vertex,
int  idx 
)
inlineprotected

Definition at line 132 of file vertex_set.h.

Member Data Documentation

◆ _modified

bool corbo::VertexSetInterface::_modified = true
protected

Definition at line 134 of file vertex_set.h.

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

control_box_rst
Author(s): Christoph Rösmann
autogenerated on Wed Mar 2 2022 00:07:21