Public Types | Public Member Functions | List of all members
gtsam::InequalityPenaltyFunction Class Referenceabstract

#include <InequalityPenaltyFunction.h>

Inheritance diagram for gtsam::InequalityPenaltyFunction:
Inheritance graph
[legend]

Public Types

typedef std::shared_ptr< InequalityPenaltyFunctionshared_ptr
 
typedef std::function< double(const double &x, OptionalJacobian< 1, 1 > H)> UnaryScalarFunc
 

Public Member Functions

virtual UnaryScalarFunc function () const
 
 InequalityPenaltyFunction ()
 
virtual double operator() (const double &x, OptionalJacobian< 1, 1 > H={}) const =0
 
virtual ~InequalityPenaltyFunction ()
 

Detailed Description

Base class for smooth approximation of the ramp function.

Definition at line 27 of file InequalityPenaltyFunction.h.

Member Typedef Documentation

◆ shared_ptr

Definition at line 29 of file InequalityPenaltyFunction.h.

◆ UnaryScalarFunc

typedef std::function<double(const double& x, OptionalJacobian<1, 1> H)> gtsam::InequalityPenaltyFunction::UnaryScalarFunc

Definition at line 31 of file InequalityPenaltyFunction.h.

Constructor & Destructor Documentation

◆ InequalityPenaltyFunction()

gtsam::InequalityPenaltyFunction::InequalityPenaltyFunction ( )
inline

Constructor.

Definition at line 34 of file InequalityPenaltyFunction.h.

◆ ~InequalityPenaltyFunction()

virtual gtsam::InequalityPenaltyFunction::~InequalityPenaltyFunction ( )
inlinevirtual

Destructor.

Definition at line 37 of file InequalityPenaltyFunction.h.

Member Function Documentation

◆ function()

InequalityPenaltyFunction::UnaryScalarFunc gtsam::InequalityPenaltyFunction::function ( ) const
virtual

Reimplemented in gtsam::RampFunction.

Definition at line 24 of file InequalityPenaltyFunction.cpp.

◆ operator()()

virtual double gtsam::InequalityPenaltyFunction::operator() ( const double &  x,
OptionalJacobian< 1, 1 >  H = {} 
) const
pure virtual

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


gtsam
Author(s):
autogenerated on Fri Mar 28 2025 03:15:16