gtsam::RampFunction Class Reference

#include <InequalityPenaltyFunction.h>

Inheritance diagram for gtsam::RampFunction:

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

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

Static Public Member Functions
static double	Ramp (const double x, OptionalJacobian< 1, 1 > H={})

Detailed Description

Ramp function f : R -> R. f(x) = 0 for x <= 0 x for x > 0

Definition at line 49 of file InequalityPenaltyFunction.h.

Member Typedef Documentation

Base

typedef InequalityPenaltyFunction gtsam::RampFunction::Base

Definition at line 51 of file InequalityPenaltyFunction.h.

shared_ptr

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

Definition at line 53 of file InequalityPenaltyFunction.h.

This

typedef RampFunction gtsam::RampFunction::This

Definition at line 52 of file InequalityPenaltyFunction.h.

Constructor & Destructor Documentation

RampFunction()

gtsam::RampFunction::RampFunction ( )

inline

Definition at line 56 of file InequalityPenaltyFunction.h.

Member Function Documentation

function()

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

inlineoverridevirtual

Reimplemented from gtsam::InequalityPenaltyFunction.

Definition at line 63 of file InequalityPenaltyFunction.h.

operator()()

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

inlineoverridevirtual

Implements gtsam::InequalityPenaltyFunction.

Definition at line 58 of file InequalityPenaltyFunction.h.

Ramp()

double gtsam::RampFunction::Ramp ( const double  x, OptionalJacobian< 1, 1 >  H = {}  )

static

Definition at line 32 of file InequalityPenaltyFunction.cpp.

---

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

• InequalityPenaltyFunction.h
• InequalityPenaltyFunction.cpp