corbo::EdgeSetInterface Class Reference

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

#include <edge_set.h>

Inheritance diagram for corbo::EdgeSetInterface:

Public Types
using	Ptr = std::shared_ptr< EdgeSetInterface >

Public Member Functions
virtual void	clear ()=0
virtual void	computeEdgeIndices ()=0
	Precompute edge indices in the hyper-graph (e.g. for the Jacobian structure) More...
bool	isModified () const
virtual void	reserveEdgeCacheMemory (int est_value_cache_size, int est_jacobians_cache_size)=0
void	setModified (bool modified)
virtual	~EdgeSetInterface ()
	Virtual destructor. More...

Protected Member Functions
void	setEdgeIdx (BaseEdge &edge, int idx)
void	setEdgeIdx (BaseMixedEdge &edge, int obj_idx, int eq_idx, int ineq_idx)

Protected Attributes
bool	_modified = true

Detailed Description

Abstract class representing a set of edges.

See also

HyperGraph EdgeInterface VertexSet

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 46 of file edge_set.h.

Member Typedef Documentation

Ptr

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

Definition at line 49 of file edge_set.h.

Constructor & Destructor Documentation

~EdgeSetInterface()

virtual corbo::EdgeSetInterface::~EdgeSetInterface ( )

inlinevirtual

Virtual destructor.

Definition at line 52 of file edge_set.h.

Member Function Documentation

clear()

virtual void corbo::EdgeSetInterface::clear ( )

pure virtual

Implemented in corbo::OptimizationEdgeSet.

computeEdgeIndices()

virtual void corbo::EdgeSetInterface::computeEdgeIndices ( )

pure virtual

Precompute edge indices in the hyper-graph (e.g. for the Jacobian structure)

Implemented in corbo::OptimizationEdgeSet.

isModified()

bool corbo::EdgeSetInterface::isModified ( ) const

inline

Definition at line 61 of file edge_set.h.

reserveEdgeCacheMemory()

virtual void corbo::EdgeSetInterface::reserveEdgeCacheMemory ( int  est_value_cache_size, int  est_jacobians_cache_size  )

pure virtual

Implemented in corbo::OptimizationEdgeSet.

setEdgeIdx() [1/2]

void corbo::EdgeSetInterface::setEdgeIdx ( BaseEdge &  edge, int  idx  )

inlineprotected

Definition at line 64 of file edge_set.h.

setEdgeIdx() [2/2]

void corbo::EdgeSetInterface::setEdgeIdx ( BaseMixedEdge &  edge, int  obj_idx, int  eq_idx, int  ineq_idx  )

inlineprotected

Definition at line 65 of file edge_set.h.

setModified()

void corbo::EdgeSetInterface::setModified ( bool  modified )

inline

Definition at line 60 of file edge_set.h.

Member Data Documentation

_modified

bool corbo::EdgeSetInterface::_modified = true

protected

Definition at line 71 of file edge_set.h.

---

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

• edge_set.h