Public Types | Public Member Functions | Protected Attributes | List of all members
gtsam::SoftPlusFunction Class Reference

#include <InequalityPenaltyFunction.h>

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

Public Types

typedef InequalityPenaltyFunction Base
 
typedef std::shared_ptr< Thisshared_ptr
 
typedef SoftPlusFunction This
 
- Public Types inherited from gtsam::InequalityPenaltyFunction
typedef std::shared_ptr< InequalityPenaltyFunctionshared_ptr
 
typedef std::function< double(const double &x, OptionalJacobian< 1, 1 > H)> UnaryScalarFunc
 

Public Member Functions

virtual double operator() (const double &x, OptionalJacobian< 1, 1 > H={}) const override
 
 SoftPlusFunction (const double k=1)
 
- Public Member Functions inherited from gtsam::InequalityPenaltyFunction
virtual UnaryScalarFunc function () const
 
 InequalityPenaltyFunction ()
 
virtual ~InequalityPenaltyFunction ()
 

Protected Attributes

double k_
 

Detailed Description

Softplus function that implements f(x) = log(1 + exp(k*x)) / k.

Definition at line 130 of file InequalityPenaltyFunction.h.

Member Typedef Documentation

◆ Base

Definition at line 132 of file InequalityPenaltyFunction.h.

◆ shared_ptr

typedef std::shared_ptr<This> gtsam::SoftPlusFunction::shared_ptr

Definition at line 134 of file InequalityPenaltyFunction.h.

◆ This

Definition at line 133 of file InequalityPenaltyFunction.h.

Constructor & Destructor Documentation

◆ SoftPlusFunction()

gtsam::SoftPlusFunction::SoftPlusFunction ( const double  k = 1)
inline

Constructor.

Parameters
kparameter for adjusting the smoothness of the function.

Definition at line 143 of file InequalityPenaltyFunction.h.

Member Function Documentation

◆ operator()()

double gtsam::SoftPlusFunction::operator() ( const double &  x,
OptionalJacobian< 1, 1 >  H = {} 
) const
overridevirtual

Implements gtsam::InequalityPenaltyFunction.

Definition at line 89 of file InequalityPenaltyFunction.cpp.

Member Data Documentation

◆ k_

double gtsam::SoftPlusFunction::k_
protected

Definition at line 137 of file InequalityPenaltyFunction.h.


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


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